OffersUriParameterBuilder
Summary
WithAccountWhitelist
sets the accountWhiteList parameter
WithAccountBlacklist
sets the accounBlacklist parameter
WithSenderAssetWhitelist
sets the senderAssetWhitelist parameter
WithSenderAssetBlacklist
sets the senderAssetBlacklist parameter
WithRecipientAssetWhitelist
sets the recipientAssetWhitelist parameter
WithRecipientAssetBlacklist
sets the recipientAssetBlacklist parameter
WithAccount
sets the account
parameter
WithSender
sets the sender
parameter
WithRecipient
sets the recipient
parameter
WithRecipient
sets the state
parameter
WithIsRecipientContract
sets the _isRecipientContract
variable.
WithAssetId
sets the assetId parameter
It sets the value of the templateId variable.
WithCollectionName
is a function that takes a string as a parameter and returns an OffersUriParameterBuilder
object
This function sets the schema name for the query.
WithCollectionBlacklist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
WithCollectionWhitelist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
This function takes an array of strings and joins them together with a comma.
WithLowerBound
sets the lower bound of the primary key
WithUpperBound
sets the upper bound of the range of primary key
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
WithAccountWhitelist
sets the accountWhiteList parameter
Parameters
accountWhitelist
The accountWhitelist shows only offers sent by one of the accounts.
Returns
The OffersUriParameterBuilder object.
WithAccountBlacklist
sets the accounBlacklist parameter
Parameters
accountWhitelist
The accountBlackist excludes offers sent by one of the accounts.
Returns
The OffersUriParameterBuilder object.
WithSenderAssetWhitelist
sets the senderAssetWhitelist parameter
Parameters
senderAssetWhitelist
The senderAssetWhitelist only shows offers that contain assets.
Returns
The OffersUriParameterBuilder object.
WithSenderAssetBlacklist
sets the senderAssetBlacklist parameter
Parameters
senderAssetBlacklistlist
The senderAssetBlacklist excludes offers that contain assets.
Returns
The OffersUriParameterBuilder object.
WithRecipientAssetWhitelist
sets the recipientAssetWhitelist parameter
Parameters
recipientAssetWhitelist
The recipientAssetWhitelist only shows offers that contain assets recieved.
Returns
The OffersUriParameterBuilder object.
WithRecipientAssetBlacklist
sets the recipientAssetBlacklist parameter
Parameters
recipientAssetBlacklist
The recipientAssetBlacklist excludes offers that contain assets recieved.
Returns
The OffersUriParameterBuilder object.
WithAccount
sets the account
parameter
Parameters
account
The account parameter is used to filter the results. The account parameter is a string that is matched against the account .
Returns
The OffersUriParameterBuilder 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 OffersUriParameterBuilder object.
WithRecipient
sets the recipient
parameter
Parameters
recipient
The recipient parameter is used show offers recieved by a recipient.
Returns
The OffersUriParameterBuilder object.
WithRecipient
sets the state
parameter
Parameters
state
The state parameter filters results depending on the state of the offer.
Returns
The OffersUriParameterBuilder object.
WithIsRecipientContract
sets the _isRecipientContract
variable.
Parameters
isRecipientContract
Filters offers where recipient is a contract.
Returns
The OffersUriParameterBuilder object.
WithAssetId
sets the assetId parameter
Parameters
assetId
The assetId parameter shows offers based on a certain assetId.
Returns
The OffersUriParameterBuilder object.
It sets the value of the templateId variable.
Parameters
templateId
Results based on only offers which contain assets of template.
Returns
The OffersUriParameterBuilder object.
WithCollectionName
is a function that takes a string as a parameter and returns an OffersUriParameterBuilder
object
Parameters
collectionName
The name of the collection you want to query.
Returns
The OffersUriParameterBuilder object.
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The OffersUriParameterBuilder object.
WithCollectionBlacklist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
Parameters
collectionBlacklist
A list of collections to exclude from the results.
Returns
The OffersUriParameterBuilder object.
WithCollectionWhitelist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The OffersUriParameterBuilder 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 OffersUriParameterBuilder object.
WithLowerBound
sets the lower bound of the primary key
Parameters
lowerBound
The lower bound of primary key.
Returns
The OffersUriParameterBuilder object.
WithUpperBound
sets the upper bound of the range of primary key
Parameters
upperBound
The upper bound of primary key.
Returns
The OffersUriParameterBuilder 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 OffersUriParameterBuilder object.
WithAfter
sets the _after
variable to the value of the after
parameter
Parameters
after
The next values of the results to return.
Returns
The OffersUriParameterBuilder 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 OffersUriParameterBuilder object.
WithLimit
sets the _limit
variable to the value of the limit
parameter
Parameters
limit
The number of results to return.
Returns
The OffersUriParameterBuilder 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 field to sort the results by.
Returns
The OffersUriParameterBuilder object.
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