TemplatesUriParameterBuilder
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 builds a query string based on the parameters that have been set. |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Members
public
TemplatesUriParameterBuilder
WithIssuedSupply
(int issuedSupply)
WithIssuedSupply
sets the _issuedSupply
variable to the value of the issuedSupply
parameter
Parameters
issuedSupply
The issuedSupply parameter filters results.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithMinIssuedSupply
(int minIssuedSupply)
WithMinIssuedSupply
sets the _minIssuedSupply
variable to the value of the minIssuedSupply
parameter
Parameters
minIssuedSupply
The minIssuedSupply parameter filters results by issuedSupply.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithMaxIssuedSupply
(int maxIssuedSupply)
WithMaxIssuedSupply
sets the _maxIssuedSupply
variable to the value of the maxIssuedSupply
parameter
Parameters
minIssuedSupply
The maxIssuedSupply parameter filters results by issuedSupply.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithMaxSupply
(int maxSupply)
WithMaxSupply
sets the _maxSupply
variable to the value of the maxSupply
parameter
Parameters
maxSupply
The maxSupply parameter filters results by maxSupply.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithHasAssets
(bool hasAssets)
WithHasAssets
sets the _hasAssets
field to the value of the hasAssets
parameter
Parameters
hasAssets
The parameter only shows template with an existing supply of >0.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithIsBurnable
(bool isBurnable)
WithIsBurnable
sets the _isBurnable
field to the value of the isBurnable
parameter
Parameters
isBurnable
The isBurnable parameter filters results.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithIsTransferable
(bool isTransferable)
WithIsTransferable
sets the _isTransferable
field to the value of the isTransferable
parameter
Parameters
isTransferable
The isTransferable parameter filters results.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithCollectionName
(string collectionName)
WithCollectionName
is a function that takes a string as a parameter and returns an TemplatesUriParameterBuilder
object
Parameters
collectionName
The name of the collection you want to query.
Returns
The TemplatessUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithSchemaName
(string schemaName)
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
WithCollectionBlacklist
is a function that takes an array of strings and returns an TemplatesUriParameterBuilder
object
Parameters
collectionBlacklist
A list of collections to exclude from the results.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
WithCollectionWhitelist
is a function that takes an array of strings and returns an TemplatesUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithAuthorisedAccount
(string authorisedAccount)
WithAuthorisedAccount
sets the authorisedAccount
parameter
Parameters
authorisedAccount
The authorisedAccount parameter is used to filter the results the provided account can use.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the account_ids
parameter
Parameters
lowerBound
The lower bound of the primary key
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithUpperBound
(string upperBound)
WithUpperBound
sets the upper bound of the range of accounts to be returned
Parameters
upperBound
The upper bound of the primary key.
Returns
The TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
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 TemplatesUriParameterBuilder object.
public
TemplatesUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
public
TemplatesUriParameterBuilder
WithSort
(string sort)
WithSort
is a function that takes a string as a parameter and returns a TemplatesUriParameterBuilder
object.
Parameters
sort
The sort order of the results.
Returns
A TemplatesUriParameterBuilder object.
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
_collectionName
private string
_schemaName
private int?
_issuedSupply
private int?
_minIssuedSupply
private int?
_maxIssuedSupply
private bool?
_hasAssets
private int?
_maxSupply
private bool?
_isBurnable
private bool?
_isTransferable
private string
_authorisedAccount
private string
_match
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