TransfersUriParameterBuilder
Summary
WithAccount
sets the account
parameter
WithRecipient
sets the recipient
parameter
WithAssetId
sets the assetId parameter
WithSender
sets the sender
parameter
WithCollectionName
is a function that takes a string as a parameter and returns an TransfersUriParameterBuilder
object
This function sets the schema name for the query.
It sets the value of the templateId variable.
WithCollectionBlacklist
is a function that takes an array of strings and returns an TransfersUriParameterBuilder
object
WithCollectionWhitelist
is a function that takes an array of strings and returns an TransfersUriParameterBuilder
object
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.
>This function sets the sort order of the results
It builds a query string based on the parameters that have been set.
Members
WithAccount
sets the account
parameter
Parameters
account
Notified account.
Returns
The TransfersUriParameterBuilder object.
WithRecipient
sets the recipient
parameter
Parameters
recipient
Results base on transfer recipient.
Returns
The TransfersUriParameterBuilder object.
WithAssetId
sets the assetId parameter
Parameters
assetId
The assetId parameter shows transfers based on a certain assetId.
Returns
The TransfersUriParameterBuilder object.
WithSender
sets the sender
parameter
Parameters
sender
The sender parameter is used to filter the results. The sender parameter is a string that is matched against the account name.
Returns
The TransfersUriParameterBuilder object.
WithCollectionName
is a function that takes a string as a parameter and returns an TransfersUriParameterBuilder
object
Parameters
collectionName
The name of the collection you want to query.
Returns
The TransfersUriParameterBuilder object.
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The TransfersUriParameterBuilder object.
It sets the value of the templateId variable.
Parameters
templateId
Results based on only transfers which cointain assets of template.
Returns
The TranfersUriParameterBuilder object.
WithCollectionBlacklist
is a function that takes an array of strings and returns an TransfersUriParameterBuilder
object
Parameters
collectionBlacklist
A list of collections to exclude from the results.
Returns
The TransfersUriParameterBuilder object.
WithCollectionWhitelist
is a function that takes an array of strings and returns an TransfersUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The TransfersUriParameterBuilder 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 TransfersUriParameterBuilder object.
WithLimit
sets the _limit
variable to the value of the limit
parameter
Parameters
limit
The number of results to return.
Returns
The TranfersUriParameterBuilder object.
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
This function sets the sort order of the results
Parameters
sort
The sort order of the results.
Returns
The builder object itself.
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