AssetsUriParameterBuilder
Summary
Members | Descriptions |
---|---|
|
|
|
|
| This function sets the schema name for the query. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| This function takes an array of strings and joins them together with a comma. |
|
|
|
|
|
|
|
|
|
|
|
|
| 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. |
| A private variable that is used to store the value of the owner parameter. |
| A private variable that is used to store the value of the collectionName parameter. |
| A private variable that is used to store the value of the schemaName parameter. |
| A nullable integer specfying the templateId. |
| A private variable that is used to store the value of the match parameter. |
| A private variable that is used to store the value of the CollectionBlacklist parameter. |
| A private variable that is used to store the value of the collectionWhitelist parameter. |
| A nullable boolean specfying if onlyDuplicatedTemplates should be shown. |
| A private variable that is used to store the value of the authorisedAccount parameter. |
| A nullable boolean specfying if offers should be hidden. |
| A private variable that is used to store the value of the ids parameter. |
| A private variable that is used to store the value of the lowerBound parameter. |
| A private variable that is used to store the value of the upperBound parameter. |
| A nullable integer specifying the previous timestamp. |
| A nullable integer specifying the after timestamp. |
| A nullable integer specifying the page. |
| A nullable integer specifying the limit of returned values. |
| A nullable enum specifying the sortStrategy. |
| Declaring a private variable called _sort. |
Members
public
AssetsUriParameterBuilder
WithOwner
(string owner)
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.
public
AssetsUriParameterBuilder
WithCollectionName
(string collectionName)
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.
public
AssetsUriParameterBuilder
WithSchemaName
(string schemaName)
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The AssetsUriParameterBuilder object.
public
AssetsUriParameterBuilder
WithTemplateId
(int templateId)
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.
public
AssetsUriParameterBuilder
WithMatch
(string match)
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.
public
AssetsUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
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.
public
AssetsUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
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.
public
AssetsUriParameterBuilder
WithOnlyDuplicateTemplate
(bool onlyDuplicateTemplates)
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.
public
AssetsUriParameterBuilder
WithAuthorisedAccount
(string authorisedAccount)
WithAuthorisedAccount
sets the authorisedAccount
parameter
Parameters
authorisedAccount
The authorisedAccount parameter is used to filter assets the provided account can edit.
Returns
The AssetsUriParameterBuilder object.
public
AssetsUriParameterBuilder
WithHideOffers
(bool hideOffers)
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.
public
AssetsUriParameterBuilder
WithIds
(string[] ids)
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.
public
AssetsUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the account_ids
parameter
Parameters
lowerBound
The lower bound of the accounts to retrieve.
Returns
The AssetsUriParameterBuilder object.
public
AssetsUriParameterBuilder
WithUpperBound
(string upperBound)
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.
public
AssetsUriParameterBuilder
WithBefore
(int before)
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.
public
AssetsUriParameterBuilder
WithAfter
(int after)
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.
public
AssetsUriParameterBuilder
WithPage
(int page)
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.
public
AssetsUriParameterBuilder
WithLimit
(int limit)
WithLimit
sets the _limit
variable to the value of the limit
parameter
Parameters
limit
The number of results to return.
Returns
The AssetsUriParameterBuilder object.
public
AssetsUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
public
AssetsUriParameterBuilder
WithSort
(string sort)
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.
public string
Build
()
It builds a query string based on the parameters that have been set.
Returns
A string that contains the parameters for the query.
private string
_owner
A private variable that is used to store the value of the owner parameter.
private string
_collectionName
A private variable that is used to store the value of the collectionName parameter.
private string
_schemaName
A private variable that is used to store the value of the schemaName parameter.
private int?
_templateId
A nullable integer specfying the templateId.
private string
_match
A private variable that is used to store the value of the match parameter.
private string
_collectionBlacklist
A private variable that is used to store the value of the CollectionBlacklist parameter.
private string
_collectionWhitelist
A private variable that is used to store the value of the collectionWhitelist parameter.
private bool?
_onlyDuplicateTemplates
A nullable boolean specfying if onlyDuplicatedTemplates should be shown.
private string
_authorisedAccount
A private variable that is used to store the value of the authorisedAccount parameter.
private bool?
_hideOffers
A nullable boolean specfying if offers should be hidden.
private string
_ids
A private variable that is used to store the value of the ids parameter.
private string
_lowerBound
A private variable that is used to store the value of the lowerBound parameter.
private string
_upperBound
A private variable that is used to store the value of the upperBound parameter.
private int?
_before
A nullable integer specifying the previous timestamp.
private int?
_after
A nullable integer specifying the after timestamp.
private int?
_page
A nullable integer specifying the page.
private int?
_limit
A nullable integer specifying the limit of returned values.
private
SortStrategy
?
_sortStrategy
A nullable enum specifying the sortStrategy.
private string
_sort
Declaring a private variable called _sort.
Last updated