AssetsUriParameterBuilder
Summary
WithOwner
sets the owner
parameter
WithCollectionName
is a function that takes a string as a parameter and returns an AssetsUriParameterBuilder
object
This function sets the schema name for the query.
WithTemplateId
sets the _templateId
variable to the value of the templateId
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 AssetsUriParameterBuilder
object
WithOnlyDuplicatedTemplate
sets the _onlyDuplicatedTemplate
field to the value of the 'onlyDuplicateTemplate' parameter
WithAuthorisedAccount
sets the authorisedAccount
parameter
WithHideOffers
sets the _hideOffers
field to the value of the hideOffers
parameter
This function takes an array of strings and joins them together with a comma.
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.
It sets the sort parameter to the value passed in.
It builds a query string based on the parameters that have been set.
Members
WithOwner
sets the owner
parameter
Parameters
owner
The owner parameter is used to filter the results. The owner parameter is a string that is matched against the account name.
Returns
The AssetsUriParameterBuilder object.
WithCollectionName
is a function that takes a string as a parameter and returns an AssetsUriParameterBuilder
object
Parameters
collectionName
The name of the collection you want to query.
Returns
The AssetsUriParameterBuilder object.
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The AssetsUriParameterBuilder object.
WithTemplateId
sets the _templateId
variable to the value of the templateId
parameter
Parameters
templateId
The templateId of the results to return.
Returns
The AssetsUriParameterBuilder 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 AssetsUriParameterBuilder 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 AssetsUriParameterBuilder object.
WithCollectionWhitelist
is a function that takes an array of strings and returns an AssetsUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The AssetsUriParameterBuilder object.
WithOnlyDuplicatedTemplate
sets the _onlyDuplicatedTemplate
field to the value of the 'onlyDuplicateTemplate' parameter
Parameters
onlyDuplicateTemplate
Show only duplicated assets grouped by template
Returns
The AssetsUriParameterBuilder object.
WithAuthorisedAccount
sets the authorisedAccount
parameter
Parameters
authorisedAccount
The authorisedAccount parameter is used to filter assets the provided account can edit.
Returns
The AssetsUriParameterBuilder object.
WithHideOffers
sets the _hideOffers
field to the value of the hideOffers
parameter
Parameters
hideOffers
If true, the response will not include any offers.
Returns
The AccountsUriParameterBuilder 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 AccountsUriParameterBuilder object.
WithLowerBound
sets the lower bound of the account_ids
parameter
Parameters
lowerBound
The lower bound of the accounts to retrieve.
Returns
The AssetsUriParameterBuilder 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 AssetsUriParameterBuilder 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 AssetsUriParameterBuilder object.
WithAfter
sets the _after
variable to the value of the after
parameter
Parameters
after
The later values of the results to return.
Returns
The AssetsUriParameterBuilder 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 AssetsUriParameterBuilder object.
WithLimit
sets the _limit
variable to the value of the limit
parameter
Parameters
limit
The number of results to return.
Returns
The AssetsUriParameterBuilder object.
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
It sets the sort parameter to the value passed in.
Parameters
sort
The sort order of the results.
Returns
A new instance of the AssetsUriParameterBuilder class.
It builds a query string based on the parameters that have been set.
Returns
A string that contains the parameters for the query.
Last updated