AuctionsUriParameterBuilder
Summary
Members | Descriptions |
---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| This function sets the schema name for the query. |
| It sets the value of the templateId variable. |
|
|
|
|
|
|
|
|
|
|
| This function takes an array of strings and joins them together with a comma. |
|
|
|
|
|
|
|
|
|
|
|
|
| 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. |
| A private variable that is used to store the value of the state parameter. |
| A nullable integer specfying max assets per listing. |
| A nullable integer specfying min assets per listing. |
| A nullable boolean specfying which sellerContracts to show. |
| A nullable boolean specfying accounts with contracts. |
| A nullable boolean specfying listing from sellers. |
| A nullable integer specifying the assetId. |
| A private variable that is used to store the value of the maketplace parameter. |
| A private variable that is used to store the value of the makerMarketplace parameter. |
| A private variable that is used to store the value of the takerMarketplace parameter. |
| A private variable that is used to store the value of the symbol parameter. |
| A private variable that is used to store the value of the seller parameter. |
| A private variable that is used to store the value of the buyer parameter. |
| A nullable integer specifying the min price. |
| A nullable integer specifying the max price. |
| A nullable integer specifying the minTemplateMint. |
| A nullable integer specifying the maxTemplateMint. |
| A private variable that is used to store the value of the owner parameter. |
| A nullable boolean specfying burned assets. |
| A private variable that is used to store the value of the collectionName parameter. |
| A private variable that is used to store the value of the schemaName parameter. |
| A private variable that is used to store the value of the templateId parameter. |
| A nullable boolean specfying transferable assets. |
| A nullable boolean specfying burnable assets. |
| A private variable that is used to store the value of the match parameter. |
| A private variable that is used to store the value of the collectionBlacklist parameter. |
| A private variable that is used to store the value of the collectionWhitelist parameter. |
| A private variable that is used to store the value of the ids parameter. |
| A private variable that is used to store the value of the lowerBound parameter. |
| A private variable that is used to store the value of the upperBound parameter. |
| A nullable integer specifying the previous timestamp. |
| A nullable integer specifying the next timestamp. |
| A nullable integer specifying the page. |
| A nullable integer specifying the limit of returned values. |
| A nullable enum specifying the sortStrategy. |
| Declaring a private variable called _sort. |
Members
public
AuctionsUriParameterBuilder
WithState
(params
State
states)
WithState
takes a list of State
s and converts them to a comma separated string of integers
Parameters
state
Filters by auction state.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMaxAssets
(int maxAssets)
WithMaxAssets
sets the _maxAssets
variable
Parameters
maxAssets
Max assets per listing returns.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMinAssets
(int minAssets)
WithMinAssets
sets the _minAssets
variable
Parameters
minAssets
Min assets per listing returns.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithShowSellerContracts
(bool showSellerContracts)
WithShowSellerContracts
sets the _showSellerContracts
field to the value of the showSellerContracts
parameter
Parameters
showSellerContracts
If false,no seller contracts are shown except if they are in contract whitelist.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithContractWhitelist
(bool contractWhitelist)
WithContractWhitelist
sets the _contractWhitelist
field to the value of the contractWhitelist
parameter
Parameters
contractWhitelist
Shows accounts even if they are contracts.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithSellerBlacklist
(bool sellerBlacklist)
WithSellerBlacklist
sets the _sellerBlacklist
field to the value of the sellerBlacklist
parameter
Parameters
sellerBlacklist
Doesnot show listing from sellers.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithAssetId
(int assetId)
WithAssetId
sets the _assetId
variable to the value of the asset_id
parameter
Parameters
assetId
Shows the asset id in the offer.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMarketplace
(string marketplace)
WithMarketplace
sets the marketplace
parameter
Parameters
marketplace
It filters by all sales where a certain marketplace is either taker or maker marketplace.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMakerMarketplace
(string makerMarketplace)
WithMakerMarketplace
sets the makerMarketplace
parameter
Parameters
makerMarketplace
separate multiple with ",".
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithTakerMarketplace
(string takerMarketplace)
WithTakerMarketplace
sets the takerMarketplace
parameter
Parameters
takerMarketplace
separate multiple with ",".
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithSymbol
(string symbol)
WithSymbol
sets the symbol
parameter
Parameters
symbol
Filters by symbol.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithSeller
(string seller)
WithSeller
sets the seller
parameter
Parameters
seller
Filter by seller.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithBuyer
(string buyer)
WithBuyer
sets the buyer
parameter
Parameters
buyer
Filter by buyer.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMinPrice
(int minPrice)
WithMinPrice
sets the _minPrice
variable to the value of the minPrice
parameter
Parameters
minPrice
The lower price limit.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMaxPrice
(int maxPrice)
WithMaxPrice
sets the _maxPrice
variable to the value of the maxPrice
parameter
Parameters
maxPrice
The upper price limit.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMinTemplateMint
(int minTemplateMint)
WithMinTemplateMint
sets the _minTemplateMint
variable to the value of the minTemplateMint
parameter
Parameters
minTemplateMint
Min template mint.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMaxTemplateMint
(int maxTemplateMint)
WithMaxTemplateMint
sets the _maxTemplateMint
variable to the value of the maxTemplateMint
parameter
Parameters
maxTemplateMint
Max template mint.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithOwner
(string owner)
WithOwner
sets the owner
parameter
Parameters
owner
The owner parameter is used to filter the results. The owner parameter is a string that is matched against the account name.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithBurned
(bool burned)
WithBurned
sets the _burned
field to the value of the burned
parameter
Parameters
burned
It filters for burned assets.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithCollectionName
(string collectionName)
WithCollectionName
is a function that takes a string as a parameter and returns an AuctionsUriParameterBuilder
object
Parameters
collectionName
The name of the collection you want to query.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithSchemaName
(string schemaName)
This function sets the schema name for the query.
Parameters
schemaName
The name of the schema to use.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithTemplateId
(string templateId)
It sets the value of the templateId variable.
Parameters
templateId
Results based on only transfers which cointain assets of template.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithIsTransferable
(bool isTransferable)
WithIsTransferable
sets the _isTransferable
field to the value of the isTransferable
parameter
Parameters
isTransferable
The isTransferable parameter filters for transferable assets.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithIsBurnable
(bool isBurnable)
WithIsBurnable
sets the _isBurnable
field to the value of the isBurnable
parameter
Parameters
isBurnable
Filters for burnable assets.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithMatch
(string match)
WithMatch
sets the match
parameter
Parameters
match
Search for input in asset name on template data.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithCollectionBlacklist
(string[] collectionBlacklist)
WithCollectionBlacklist
is a function that takes an array of strings and returns an AuctionsUriParameterBuilder
object
Parameters
collectionBlacklist
A list of collections to exclude from the results.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithCollectionWhitelist
(string[] collectionWhitelist)
WithCollectionWhitelist
is a function that takes an array of strings and returns an AuctionsUriParameterBuilder
object
Parameters
collectionWhitelist
A list of collections to include in the response.
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithLowerBound
(string lowerBound)
WithLowerBound
sets the lower bound of the account_ids
parameter
Parameters
lowerBound
The lower bound of the primary key
Returns
The AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
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 AuctionsUriParameterBuilder object.
public
AuctionsUriParameterBuilder
WithOrder
(
SortStrategy
sorting)
This function sets the sort strategy for the query.
Parameters
SortStrategy
Returns
The builder object itself.
public
AuctionsUriParameterBuilder
WithSort
(string sort)
It sets the sort parameter to the value passed in.
Parameters
sort
The sort order of the results.
The AuctionsUriParameterBuilder.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
_state
A private variable that is used to store the value of the state parameter.
private int?
_maxAssets
A nullable integer specfying max assets per listing.
private int?
_minAssets
A nullable integer specfying min assets per listing.
private bool?
_showSellerContracts
A nullable boolean specfying which sellerContracts to show.
private bool?
_contractWhitelist
A nullable boolean specfying accounts with contracts.
private bool?
_sellerBlacklist
A nullable boolean specfying listing from sellers.
private int?
_assetId
A nullable integer specifying the assetId.
private string
_marketplace
A private variable that is used to store the value of the maketplace parameter.
private string
_makerMarketplace
A private variable that is used to store the value of the makerMarketplace parameter.
private string
_takerMarketplace
A private variable that is used to store the value of the takerMarketplace parameter.
private string
_symbol
A private variable that is used to store the value of the symbol parameter.
private string
_seller
A private variable that is used to store the value of the seller parameter.
private string
_buyer
A private variable that is used to store the value of the buyer parameter.
private int?
_minPrice
A nullable integer specifying the min price.
private int?
_maxPrice
A nullable integer specifying the max price.
private int?
_minTemplateMint
A nullable integer specifying the minTemplateMint.
private int?
_maxTemplateMint
A nullable integer specifying the maxTemplateMint.
private string
_owner
A private variable that is used to store the value of the owner parameter.
private bool?
_burned
A nullable boolean specfying burned assets.
private string
_collectionName
A private variable that is used to store the value of the collectionName parameter.
private string
_schemaName
A private variable that is used to store the value of the schemaName parameter.
private string
_templateId
A private variable that is used to store the value of the templateId parameter.
private bool?
_isTransferable
A nullable boolean specfying transferable assets.
private bool?
_isBurnable
A nullable boolean specfying burnable assets.
private string
_match
A private variable that is used to store the value of the match parameter.
private string
_collectionBlacklist
A private variable that is used to store the value of the collectionBlacklist parameter.
private string
_collectionWhitelist
A private variable that is used to store the value of the collectionWhitelist parameter.
private string
_ids
A private variable that is used to store the value of the ids parameter.
private string
_lowerBound
A private variable that is used to store the value of the lowerBound parameter.
private string
_upperBound
A private variable that is used to store the value of the upperBound parameter.
private int?
_before
A nullable integer specifying the previous timestamp.
private int?
_after
A nullable integer specifying the next timestamp.
private int?
_page
A nullable integer specifying the page.
private int?
_limit
A nullable integer specifying the limit of returned values.
private
SortStrategy
?
_sortStrategy
A nullable enum specifying the sortStrategy.
private string
_sort
Declaring a private variable called _sort.
Last updated