CollectionsUriParameterBuilder
Summary
WithAuthor
sets the author
parameter
WithMatch
sets the match
parameter
WithCollectionBlacklist
is a function that takes an array of strings and returns an AssetsUriParameterBuilder
object
WithCollectionWhitelist
is a function that takes an array of strings and returns an CollectionsUriParameterBuilder
object
WithAuthorisedAccount
sets the authorisedAccount
parameter
This function takes an array of strings and joins them together with a comma.
WithNotifyAccount
sets the notifyAccount
parameter
WithLowerBound
sets the lower bound of the account_ids
parameter
WithUpperBound
sets the upper bound of the range of accounts to be returned
WithBefore
sets the _before
variable to the value of the before
parameter
WithAfter
sets the _after
variable to the value of the after
parameter
WithPage
sets the _page
variable to the value of the page
parameter
WithLimit
sets the _limit
variable to the value of the limit
parameter
This function sets the sort strategy for the query.
WithSort
is a function that takes a string as an argument and returns a CollectionsUriParameterBuilder
object.
It takes all the properties of the class and builds a query string based on the values of those properties.
Members
WithAuthor
sets the author
parameter
Parameters
author
The author parameter is used to filter the results. The owner parameter is a string that is matched against the account name.
Returns
The CollectionsUriParameterBuilder object.
WithMatch
sets the match
parameter
Parameters
match
The match parameter is used to filter the results. The match parameter is a string that is matched against the account name.
Returns
The CollectionsUriParameterBuilder object.
WithCollectionBlacklist
is a function that takes an array of strings and returns an AssetsUriParameterBuilder
object
Parameters
collectionBlacklist
A list of collections to exclude from the results.
Returns
The CollectionsUriParameterBuilder object.
WithCollectionWhitelist
is a function that takes an array of strings and returns an CollectionsUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The CollectionsUriParameterBuilder object.
WithAuthorisedAccount
sets the authorisedAccount
parameter
Parameters
authorisedAccount
The authorisedAccount parameter is used to filter the results. The authorisedAccount parameter is a string that is matched against the account name.
Returns
The CollectionsUriParameterBuilder object.
This function takes an array of strings and joins them together with a comma.
Parameters
ids
A comma-separated list of account IDs.
Returns
The CollectionsUriParameterBuilder object.
WithNotifyAccount
sets the notifyAccount
parameter
Parameters
notifyAccount
The notifyAccount parameter is used to filter the results. The notifyAccount parameter is a string that is matched against the account name.
Returns
The CollectionsUriParameterBuilder object.
WithLowerBound
sets the lower bound of the account_ids
parameter
Parameters
lowerBound
The lower bound of the accounts to retrieve.
Returns
The CollectionsUriParameterBuilder object.
WithUpperBound
sets the upper bound of the range of accounts to be returned
Parameters
upperBound
The upper bound of the range to query.
Returns
The CollectionsUriParameterBuilder object.
WithBefore
sets the _before
variable to the value of the before
parameter
Parameters
before
The previous values of the results to return.
Returns
The CollectionsUriParameterBuilder object.
WithAfter
sets the _after
variable to the value of the after
parameter
Parameters
after
The after values of the results to return.
Returns
The CollectionsUriParameterBuilder object.
WithPage
sets the _page
variable to the value of the page
parameter
Parameters
page
The page number of the results to return.
Returns
The CollectionsUriParameterBuilder object.
WithLimit
sets the _limit
variable to the value of the limit
parameter
Parameters
limit
The number of results to return.
Returns
The CollectionsUriParameterBuilder object.
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
WithSort
is a function that takes a string as an argument and returns a CollectionsUriParameterBuilder
object.
Parameters
sort
The sort parameter is used to sort the result set in ascending or descending order.
Returns
The builder object itself.
It takes all the properties of the class and builds a query string based on the values of those properties.
Returns
A string of parameters to be used in a query.
Last updated