AtomicMarketApiClient--Sales--SalesUriParameterBuilder.md

SalesUriParameterBuilder

class AtomicMarketApiClient::Sales::SalesUriParameterBuilder
  : public IUriParameterBuilder

Summary

Members	Descriptions
public SalesUriParameterBuilder `` WithState`(params` `State` `states)`	WithState is a function that takes an array of strings and returns an SalesUriParameterBuilder object
public SalesUriParameterBuilder `` WithMaxAssets`(int maxAssets)`	WithMaxAssets sets the _maxAssets variable
public SalesUriParameterBuilder `` WithMinAssets`(int minAssets)`	WithMinAssets sets the _minAssets variable
public SalesUriParameterBuilder `` WithShowSellerContracts`(bool showSellerContracts)`	WithShowSellerContracts sets the _showSellerContracts field to the value of the showSellerContracts parameter
public SalesUriParameterBuilder `` WithContractWhitelist`(bool contractWhitelist)`	It sets the value of the _contractWhitelist variable to the value of the contractWhitelist parameter.
public SalesUriParameterBuilder `` WithSellerBlacklist`(bool sellerBlacklist)`	WithSellerBlacklist is a function that takes a boolean value and returns a SalesUriParameterBuilder object
public SalesUriParameterBuilder `` WithAssetId`(int assetId)`	WithAssetId is a function that takes an int and returns a SalesUriParameterBuilder
public SalesUriParameterBuilder `` WithMarketplace`(string marketplace)`	WithMarketplace sets the marketplace parameter
public SalesUriParameterBuilder `` WithMakerMarketplace`(string makerMarketplace)`	WithMakerMarketplace sets the makerMarketplace parameter
public SalesUriParameterBuilder `` WithTakerMarketplace`(string takerMarketplace)`	WithTakerMarketplace sets the takerMarketplace parameter
public SalesUriParameterBuilder `` WithSymbol`(string symbol)`	A function that is used to set the symbol of the stock.
public SalesUriParameterBuilder `` WithSeller`(string seller)`	WithSeller sets the seller parameter
public SalesUriParameterBuilder `` WithBuyer`(string buyer)`	WithBuyer sets the buyer parameter
public SalesUriParameterBuilder `` WithMinPrice`(int minPrice)`	WithMinPrice sets the _minPrice variable to the value of the minPrice parameter
public SalesUriParameterBuilder `` WithMaxPrice`(int maxPrice)`	WithMaxPrice sets the _maxPrice variable to the value of the maxPrice parameter
public SalesUriParameterBuilder `` WithMinTemplateMint`(int minTemplateMint)`	WithMinTemplateMint sets the _minTemplateMint variable to the value of the minTemplateMint parameter
public SalesUriParameterBuilder `` WithMaxTemplateMint`(int maxTemplateMint)`	WithMaxTemplateMint sets the _maxTemplateMint variable to the value of the maxTemplateMint parameter
public SalesUriParameterBuilder `` WithOwner`(string owner)`	WithOwner sets the owner parameter
public SalesUriParameterBuilder `` WithBurned`(bool burned)`	WithBurned sets the _burned field to the value of the burned parameter
public SalesUriParameterBuilder `` WithCollectionName`(string collectionName)`	WithCollectionName is a function that takes a string as a parameter and returns an SalesUriParameterBuilder object
public SalesUriParameterBuilder `` WithSchemaName`(string schemaName)`	This function sets the schema name for the query.
public SalesUriParameterBuilder `` WithTemplateId`(string templateId)`	It sets the value of the templateId variable.
public SalesUriParameterBuilder `` WithIsTransferable`(bool isTransferable)`	WithIsTransferable sets the _isTransferable field to the value of the isTransferable parameter
public SalesUriParameterBuilder `` WithIsBurnable`(bool isBurnable)`	WithIsBurnable sets the _isBurnable field to the value of the isBurnable parameter
public SalesUriParameterBuilder `` WithMatch`(string match)`	WithMatch sets the match parameter
public SalesUriParameterBuilder `` WithCollectionBlacklist`(string[] collectionBlacklist)`	WithCollectionBlacklist is a function that takes an array of strings and returns an SalesUriParameterBuilder object
public SalesUriParameterBuilder `` WithCollectionWhitelist`(string[] collectionWhitelist)`	WithCollectionWhitelist is a function that takes an array of strings and returns an SalesUriParameterBuilder object
public SalesUriParameterBuilder `` WithIds`(string[] ids)`	This function takes an array of strings and joins them together with a comma.
public SalesUriParameterBuilder `` WithLowerBound`(string lowerBound)`	WithLowerBound sets the lower bound of the account_ids parameter
public SalesUriParameterBuilder `` WithUpperBound`(string upperBound)`	WithUpperBound sets the upper bound of the range of accounts to be returned
public SalesUriParameterBuilder `` WithBefore`(int before)`	WithBefore sets the _before variable to the value of the before parameter
public SalesUriParameterBuilder `` WithAfter`(int after)`	WithAfter sets the _after variable to the value of the after parameter
public SalesUriParameterBuilder `` WithPage`(int page)`	WithPage sets the _page variable to the value of the page parameter
public SalesUriParameterBuilder `` WithLimit`(int limit)`	WithLimit sets the _limit variable to the value of the limit parameter
public SalesUriParameterBuilder `` WithOrder`(` `SortStrategy` `sorting)`	This function sets the sort strategy for the query.
public SalesUriParameterBuilder `` 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 _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.

Members

public SalesUriParameterBuilder `` WithState`(params` `State` `states)`

WithState is a function that takes an array of strings and returns an SalesUriParameterBuilder object

Parameters

• state Filters by sales state.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMaxAssets`(int maxAssets)`

WithMaxAssets sets the _maxAssets variable

Parameters

• maxAssets Max assets per listing returns.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMinAssets`(int minAssets)`

WithMinAssets sets the _minAssets variable

Parameters

• minAssets Min assets per listing returns.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithContractWhitelist`(bool contractWhitelist)`

It sets the value of the _contractWhitelist variable to the value of the contractWhitelist parameter.

Parameters

• contractWhitelist If true, only contracts that are in the whitelist will be returned.

Returns

The SalesUriParameterBuilder object is being returned.

public SalesUriParameterBuilder `` WithSellerBlacklist`(bool sellerBlacklist)`

WithSellerBlacklist is a function that takes a boolean value and returns a SalesUriParameterBuilder object

Parameters

• sellerBlacklist If true, the seller will be added to the blacklist.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithAssetId`(int assetId)`

WithAssetId is a function that takes an int and returns a SalesUriParameterBuilder

Parameters

• assetId The ID of the asset you want to sell.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMakerMarketplace`(string makerMarketplace)`

WithMakerMarketplace sets the makerMarketplace parameter

Parameters

• makerMarketplace separate multiple with ",".

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithTakerMarketplace`(string takerMarketplace)`

WithTakerMarketplace sets the takerMarketplace parameter

Parameters

• takerMarketplace separate multiple with ",".

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithSymbol`(string symbol)`

A function that is used to set the symbol of the stock.

Parameters

• symbol The symbol of the stock you want to get the sales data for.

Returns

The SalesUriParameterBuilder object is being returned.

public SalesUriParameterBuilder `` WithSeller`(string seller)`

WithSeller sets the seller parameter

Parameters

• seller Filter by seller.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithBuyer`(string buyer)`

WithBuyer sets the buyer parameter

Parameters

• buyer Filter by buyer.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMinPrice`(int minPrice)`

WithMinPrice sets the _minPrice variable to the value of the minPrice parameter

Parameters

• minPrice The lower price limit.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMaxPrice`(int maxPrice)`

WithMaxPrice sets the _maxPrice variable to the value of the maxPrice parameter

Parameters

• maxPrice The upper price limit.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMinTemplateMint`(int minTemplateMint)`

WithMinTemplateMint sets the _minTemplateMint variable to the value of the minTemplateMint parameter

Parameters

• minTemplateMint Min template mint.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMaxTemplateMint`(int maxTemplateMint)`

WithMaxTemplateMint sets the _maxTemplateMint variable to the value of the maxTemplateMint parameter

Parameters

• maxTemplateMint Max template mint.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithBurned`(bool burned)`

WithBurned sets the _burned field to the value of the burned parameter

Parameters

• burned It filters for burned assets.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithCollectionName`(string collectionName)`

WithCollectionName is a function that takes a string as a parameter and returns an SalesUriParameterBuilder object

Parameters

• collectionName The name of the collection you want to query.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithSchemaName`(string schemaName)`

This function sets the schema name for the query.

Parameters

• schemaName The name of the schema to use.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithIsBurnable`(bool isBurnable)`

WithIsBurnable sets the _isBurnable field to the value of the isBurnable parameter

Parameters

• isBurnable Filters for burnable assets.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithMatch`(string match)`

WithMatch sets the match parameter

Parameters

• match Search for input in asset name on template data.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithCollectionBlacklist`(string[] collectionBlacklist)`

WithCollectionBlacklist is a function that takes an array of strings and returns an SalesUriParameterBuilder object

Parameters

• collectionBlacklist A list of collections to exclude from the results.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithCollectionWhitelist`(string[] collectionWhitelist)`

WithCollectionWhitelist is a function that takes an array of strings and returns an SalesUriParameterBuilder object

Parameters

• collectionWhitelist A list of collections to include in the response.

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithLowerBound`(string lowerBound)`

WithLowerBound sets the lower bound of the account_ids parameter

Parameters

• lowerBound The lower bound of the primary key

Returns

The SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` 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 SalesUriParameterBuilder object.

public SalesUriParameterBuilder `` WithOrder**`(` ** `SortStrategy` `sorting)`

This function sets the sort strategy for the query.

Parameters

• SortStrategy

Returns

The builder object itself.

public SalesUriParameterBuilder `` WithSort`(string sort)`

It sets the sort parameter to the value passed in.

Parameters

• sort The sort order of the results.

Returns

The SalesUriParameterBuilder object is being returned.

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.