OffersUriParameterBuilder

Summary

Members	Descriptions
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	A private variable that is used to store the value of the account parameter.
private string _sender	A private variable that is used to store the value of the sender parameter.
private string _recipient	A private variable that is used to store the value of the recipient parameter.
private string _state	A private variable that is used to store the value of the state parameter.
private bool? _isRecipientContract	A nullable boolean specfying recipient contracts.
private string _assetId	A private variable that is used to store the value of the assetId parameter.
private string _templateId	A private variable that is used to store the value of the template parameter.
private string _schemaName	A private variable that is used to store the value of the schemeName parameter.
private string _collectionName	A private variable that is used to store the value of the collectionName parameter.
private string _accountWhitelist	A private variable that is used to store the value of the accountWhitelist parameter.
private string _accountBlacklist	A private variable that is used to store the value of the accountBlacklist parameter.
private string _senderAssetWhitelist	A private variable that is used to store the value of the senderAssetWhitelist parameter.
private string _senderAssetBlacklist	A private variable that is used to store the value of the senderAssetBlacklist parameter.
private string _recipientAssetWhitelist	A private variable that is used to store the value of the recipientAssetWhitelist parameter.
private string _recipientAssetBlacklist	A private variable that is used to store the value of the recipientAssetBlacklist 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 collectionBlacklist 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 OffersUriParameterBuilder WithAccountWhitelist(string accountWhitelist)

WithAccountWhitelist sets the accountWhiteList parameter

Parameters

• accountWhitelist The accountWhitelist shows only offers sent by one of the accounts.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAccountBlacklist(string accountBlacklist)

WithAccountBlacklist sets the accounBlacklist parameter

Parameters

• accountWhitelist The accountBlackist excludes offers sent by one of the accounts.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSenderAssetWhitelist(string senderAssetwhitelist)

WithSenderAssetWhitelist sets the senderAssetWhitelist parameter

Parameters

• senderAssetWhitelist The senderAssetWhitelist only shows offers that contain these assets.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithSenderAssetBlacklist(string senderAssetBlacklist)

WithSenderAssetBlacklist sets the senderAssetBlacklist parameter

Parameters

• senderAssetBlacklistlist The senderAssetBlacklist excludes offers that contain assets.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithRecipientAssetWhitelist(string recipientAssetwhitelist)

WithRecipientAssetWhitelist sets the recipientAssetWhitelist parameter

Parameters

• recipientAssetWhitelist The recipientAssetWhitelist only shows offers that contain assets recieved.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithRecipientAssetBlacklist(string recipientAssetBlacklist)

WithRecipientAssetBlacklist sets the recipientAssetBlacklist parameter

Parameters

• recipientAssetBlacklist The recipientAssetBlacklist excludes offers that contain assets recieved.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAccount(string account)

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.

public OffersUriParameterBuilder WithSender(string sender)

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.

public OffersUriParameterBuilder WithRecipient(string recipient)

WithRecipient sets the recipient parameter

Parameters

• recipient The recipient parameter is used show offers recieved by a recipient.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithState(string state)

WithRecipient sets the state parameter

Parameters

• state The state parameter filters results depending on the state of the offer.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithIsRecipientContract(bool isRecipientContract)

WithIsRecipientContract sets the _isRecipientContract variable.

Parameters

• isRecipientContract Filters offers where recipient is a contract.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAssetId(string assetId)

WithAssetId sets the assetId parameter

Parameters

• assetId The assetId parameter shows offers based on a certain assetId.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithTemplateId(string temlpateId)

It sets the value of the templateId variable.

Parameters

• templateId Results based on only offers which contain assets of template.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithCollectionName(string collectionName)

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.

public OffersUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

• schemaName The name of the schema to use.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

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.

public OffersUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

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.

public OffersUriParameterBuilder 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 OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithLowerBound(string lowerBound)

WithLowerBound sets the lower bound of the primary key

Parameters

• lowerBound The lower bound of primary key.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithUpperBound(string upperBound)

WithUpperBound sets the upper bound of the range of primary key

Parameters

• upperBound The upper bound of primary key.

Returns

The OffersUriParameterBuilder object.

public OffersUriParameterBuilder 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 OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithAfter(int after)

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.

public OffersUriParameterBuilder 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 OffersUriParameterBuilder object.

public OffersUriParameterBuilder 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 OffersUriParameterBuilder object.

public OffersUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

• SortStrategy

Returns

The builder object itself.

public OffersUriParameterBuilder WithSort(string sort)

It sets the sort parameter to the value passed in.

Parameters

• sort The field to sort the results by.

Returns

The OffersUriParameterBuilder 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 _account

A private variable that is used to store the value of the account parameter.

private string _sender

A private variable that is used to store the value of the sender parameter.

private string _recipient

A private variable that is used to store the value of the recipient parameter.

private string _state

A private variable that is used to store the value of the state parameter.

private bool? _isRecipientContract

A nullable boolean specfying recipient contracts.

private string _assetId

A private variable that is used to store the value of the assetId parameter.

private string _templateId

A private variable that is used to store the value of the template parameter.

private string _schemaName

A private variable that is used to store the value of the schemeName parameter.

private string _collectionName

A private variable that is used to store the value of the collectionName parameter.

private string _accountWhitelist

A private variable that is used to store the value of the accountWhitelist parameter.

private string _accountBlacklist

A private variable that is used to store the value of the accountBlacklist parameter.

private string _senderAssetWhitelist

A private variable that is used to store the value of the senderAssetWhitelist parameter.

private string _senderAssetBlacklist

A private variable that is used to store the value of the senderAssetBlacklist parameter.

private string _recipientAssetWhitelist

A private variable that is used to store the value of the recipientAssetWhitelist parameter.

private string _recipientAssetBlacklist

A private variable that is used to store the value of the recipientAssetBlacklist 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 collectionBlacklist 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.