CollectionsUriParameterBuilder
Summary
public
CollectionsUriParameterBuilder
WithAuthor
(string author)
WithAuthor
sets the author
parameter
public
CollectionsUriParameterBuilder
WithMatch
(string match)
WithMatch
sets the match
parameter
public
CollectionsUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
WithCollectionBlacklist
is a function that takes an array of strings and returns an AssetsUriParameterBuilder
object
public
CollectionsUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
WithCollectionWhitelist
is a function that takes an array of strings and returns an CollectionsUriParameterBuilder
object
public
CollectionsUriParameterBuilder
WithAuthorisedAccount
(string authorisedAccount)
WithAuthorisedAccount
sets the authorisedAccount
parameter
public
CollectionsUriParameterBuilder
WithIds
(string[] ids)
This function takes an array of strings and joins them together with a comma.
public
CollectionsUriParameterBuilder
WithNotifyAccount
(string notifyAccount)
WithNotifyAccount
sets the notifyAccount
parameter
public
CollectionsUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the account_ids
parameter
public
CollectionsUriParameterBuilder
WithUpperBound
(string upperBound)
WithUpperBound
sets the upper bound of the range of accounts to be returned
public
CollectionsUriParameterBuilder
WithBefore
(int before)
WithBefore
sets the _before
variable to the value of the before
parameter
public
CollectionsUriParameterBuilder
WithAfter
(int after)
WithAfter
sets the _after
variable to the value of the after
parameter
public
CollectionsUriParameterBuilder
WithPage
(int page)
WithPage
sets the _page
variable to the value of the page
parameter
public
CollectionsUriParameterBuilder
WithLimit
(int limit)
WithLimit
sets the _limit
variable to the value of the limit
parameter
public
CollectionsUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
public
CollectionsUriParameterBuilder
WithSort
(string sort)
WithSort
is a function that takes a string as an argument and returns a CollectionsUriParameterBuilder
object.
public string
Build
()
It takes all the properties of the class and builds a query string based on the values of those properties.
private string
_author
private string
_match
private string
_authorisedAccount
private string
_notifyAccount
private string
_collectionBlacklist
private string
_collectionWhitelist
private string
_ids
private string
_lowerBound
private string
_upperBound
private int?
_before
private int?
_after
private int?
_page
private int?
_limit
private
SortStrategy
?
_sortStrategy
private string
_sort
Members
public
CollectionsUriParameterBuilder
WithAuthor
(string author)
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.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
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.
public
CollectionsUriParameterBuilder
WithAuthorisedAccount
(string authorisedAccount)
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.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
WithNotifyAccount
(string notifyAccount)
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.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
WithAfter
(int after)
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.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
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 CollectionsUriParameterBuilder object.
public
CollectionsUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
public
CollectionsUriParameterBuilder
WithSort
(string sort)
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.
public string
Build
()
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.
private string
_author
private string
_match
private string
_authorisedAccount
private string
_notifyAccount
private string
_collectionBlacklist
private string
_collectionWhitelist
private string
_ids
private string
_lowerBound
private string
_upperBound
private int?
_before
private int?
_after
private int?
_page
private int?
_limit
private
SortStrategy
?
_sortStrategy
private string
_sort
Last updated