OffersUriParameterBuilder
Last updated
Last updated
Members | Descriptions |
---|---|
public
OffersUriParameterBuilder
WithAccountWhitelist
(string accountWhitelist)
WithAccountWhitelist
sets the accountWhiteList parameter
accountWhitelist
The accountWhitelist shows only offers sent by one of the accounts.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithAccountBlacklist
(string accountBlacklist)
WithAccountBlacklist
sets the accounBlacklist parameter
accountWhitelist
The accountBlackist excludes offers sent by one of the accounts.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithSenderAssetWhitelist
(string senderAssetwhitelist)
WithSenderAssetWhitelist
sets the senderAssetWhitelist parameter
senderAssetWhitelist
The senderAssetWhitelist only shows offers that contain assets.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithSenderAssetBlacklist
(string senderAssetBlacklist)
WithSenderAssetBlacklist
sets the senderAssetBlacklist parameter
senderAssetBlacklistlist
The senderAssetBlacklist excludes offers that contain assets.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithRecipientAssetWhitelist
(string recipientAssetwhitelist)
WithRecipientAssetWhitelist
sets the recipientAssetWhitelist parameter
recipientAssetWhitelist
The recipientAssetWhitelist only shows offers that contain assets recieved.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithRecipientAssetBlacklist
(string recipientAssetBlacklist)
WithRecipientAssetBlacklist
sets the recipientAssetBlacklist parameter
recipientAssetBlacklist
The recipientAssetBlacklist excludes offers that contain assets recieved.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithAccount
(string account)
WithAccount
sets the account
parameter
account
The account parameter is used to filter the results. The account parameter is a string that is matched against the account .
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithSender
(string sender)
WithSender
sets the sender
parameter
sender
The sender parameter is used to filter the results. The sender parameter is a string that is matched against the account name.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithRecipient
(string recipient)
WithRecipient
sets the recipient
parameter
recipient
The recipient parameter is used show offers recieved by a recipient.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithState
(string state)
WithRecipient
sets the state
parameter
state
The state parameter filters results depending on the state of the offer.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithIsRecipientContract
(bool isRecipientContract)
WithIsRecipientContract
sets the _isRecipientContract
variable.
isRecipientContract
Filters offers where recipient is a contract.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithAssetId
(string assetId)
WithAssetId
sets the assetId parameter
assetId
The assetId parameter shows offers based on a certain assetId.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithTemplateId
(string temlpateId)
It sets the value of the templateId variable.
templateId
Results based on only offers which contain assets of template.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithCollectionName
(string collectionName)
WithCollectionName
is a function that takes a string as a parameter and returns an OffersUriParameterBuilder
object
collectionName
The name of the collection you want to query.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithSchemaName
(string schemaName)
This function sets the schema name for the query.
schemaName
The name of the schema to use.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
WithCollectionBlacklist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
collectionBlacklist
A list of collections to exclude from the results.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
WithCollectionWhitelist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
collectionWhitelist
A list of collections to include in the response.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithIds
(string[] ids)
This function takes an array of strings and joins them together with a comma.
ids
A comma-separated list of account IDs.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the primary key
lowerBound
The lower bound of primary key.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithUpperBound
(string upperBound)
WithUpperBound
sets the upper bound of the range of primary key
upperBound
The upper bound of primary key.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithBefore
(int before)
WithBefore
sets the _before
variable to the value of the before
parameter
before
The previous values of the results to return.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithAfter
(int after)
WithAfter
sets the _after
variable to the value of the after
parameter
after
The next values of the results to return.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithPage
(int page)
WithPage
sets the _page
variable to the value of the page
parameter
page
The page number of the results to return.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithLimit
(int limit)
WithLimit
sets the _limit
variable to the value of the limit
parameter
limit
The number of results to return.
The OffersUriParameterBuilder object.
public
OffersUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
SortStrategy
The builder object itself.
public
OffersUriParameterBuilder
WithSort
(string sort)
It sets the sort parameter to the value passed in.
sort
The field to sort the results by.
The OffersUriParameterBuilder object.
public string
Build
()
It builds a query string based on the parameters that have been set.
A string that contains the parameters for the query.
private string
_account
private string
_sender
private string
_recipient
private string
_state
private bool?
_isRecipientContract
private string
_assetId
private string
_templateId
private string
_schemaName
private string
_collectionName
private string
_accountWhitelist
private string
_accountBlacklist
private string
_senderAssetWhitelist
private string
_senderAssetBlacklist
private string
_recipientAssetWhitelist
private string
_recipientAssetBlacklist
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
public
OffersUriParameterBuilder
WithAccountWhitelist
(string accountWhitelist)
WithAccountWhitelist
sets the accountWhiteList parameter
public
OffersUriParameterBuilder
WithAccountBlacklist
(string accountBlacklist)
WithAccountBlacklist
sets the accounBlacklist parameter
public
OffersUriParameterBuilder
WithSenderAssetWhitelist
(string senderAssetwhitelist)
WithSenderAssetWhitelist
sets the senderAssetWhitelist parameter
public
OffersUriParameterBuilder
WithSenderAssetBlacklist
(string senderAssetBlacklist)
WithSenderAssetBlacklist
sets the senderAssetBlacklist parameter
public
OffersUriParameterBuilder
WithRecipientAssetWhitelist
(string recipientAssetwhitelist)
WithRecipientAssetWhitelist
sets the recipientAssetWhitelist parameter
public
OffersUriParameterBuilder
WithRecipientAssetBlacklist
(string recipientAssetBlacklist)
WithRecipientAssetBlacklist
sets the recipientAssetBlacklist parameter
public
OffersUriParameterBuilder
WithAccount
(string account)
WithAccount
sets the account
parameter
public
OffersUriParameterBuilder
WithSender
(string sender)
WithSender
sets the sender
parameter
public
OffersUriParameterBuilder
WithRecipient
(string recipient)
WithRecipient
sets the recipient
parameter
public
OffersUriParameterBuilder
WithState
(string state)
WithRecipient
sets the state
parameter
public
OffersUriParameterBuilder
WithIsRecipientContract
(bool isRecipientContract)
WithIsRecipientContract
sets the _isRecipientContract
variable.
public
OffersUriParameterBuilder
WithAssetId
(string assetId)
WithAssetId
sets the assetId parameter
public
OffersUriParameterBuilder
WithTemplateId
(string temlpateId)
It sets the value of the templateId variable.
public
OffersUriParameterBuilder
WithCollectionName
(string collectionName)
WithCollectionName
is a function that takes a string as a parameter and returns an OffersUriParameterBuilder
object
public
OffersUriParameterBuilder
WithSchemaName
(string schemaName)
This function sets the schema name for the query.
public
OffersUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
WithCollectionBlacklist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
public
OffersUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
WithCollectionWhitelist
is a function that takes an array of strings and returns an OffersUriParameterBuilder
object
public
OffersUriParameterBuilder
WithIds
(string[] ids)
This function takes an array of strings and joins them together with a comma.
public
OffersUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the primary key
public
OffersUriParameterBuilder
WithUpperBound
(string upperBound)
WithUpperBound
sets the upper bound of the range of primary key
public
OffersUriParameterBuilder
WithBefore
(int before)
WithBefore
sets the _before
variable to the value of the before
parameter
public
OffersUriParameterBuilder
WithAfter
(int after)
WithAfter
sets the _after
variable to the value of the after
parameter
public
OffersUriParameterBuilder
WithPage
(int page)
WithPage
sets the _page
variable to the value of the page
parameter
public
OffersUriParameterBuilder
WithLimit
(int limit)
WithLimit
sets the _limit
variable to the value of the limit
parameter
public
OffersUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
public
OffersUriParameterBuilder
WithSort
(string sort)
It sets the sort parameter to the value passed in.
public string
Build
()
It builds a query string based on the parameters that have been set.
private string
_account
private string
_sender
private string
_recipient
private string
_state
private bool?
_isRecipientContract
private string
_assetId
private string
_templateId
private string
_schemaName
private string
_collectionName
private string
_accountWhitelist
private string
_accountBlacklist
private string
_senderAssetWhitelist
private string
_senderAssetBlacklist
private string
_recipientAssetWhitelist
private string
_recipientAssetBlacklist
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