TransfersUriParameterBuilder

Summary

Members
Descriptions

WithAccount sets the account parameter

WithRecipient sets the recipient parameter

WithAssetId sets the assetId parameter

WithSender sets the sender parameter

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

This function sets the schema name for the query.

It sets the value of the templateId variable.

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

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

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.

>This function sets the sort order of the results

It builds a query string based on the parameters that have been set.

Members

public TransfersUriParameterBuilder WithAccount(string account)

WithAccount sets the account parameter

Parameters

  • account Notified account.

Returns

The TransfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithRecipient(string recipient)

WithRecipient sets the recipient parameter

Parameters

  • recipient Results base on transfer recipient.

Returns

The TransfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithAssetId(string assetId)

WithAssetId sets the assetId parameter

Parameters

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

Returns

The TransfersUriParameterBuilder object.

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

public TransfersUriParameterBuilder WithCollectionName(string collectionName)

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

Parameters

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

Returns

The TransfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

  • schemaName The name of the schema to use.

Returns

The TransfersUriParameterBuilder object.

public TransfersUriParameterBuilder 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 TranfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

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

Parameters

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

Returns

The TransfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

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

Parameters

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

Returns

The TransfersUriParameterBuilder object.

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

public TransfersUriParameterBuilder 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 TranfersUriParameterBuilder object.

public TransfersUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

  • SortStrategy

Returns

The builder object itself.

public TransfersUriParameterBuilder WithSort(string sort)

This function sets the sort order of the results

Parameters

  • sort The sort order of the results.

Returns

The builder object itself.

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

private string _sender

private string _recipient

private string _assetId

private string _templateId

private string _schemaName

private string _collectionName

private string _collectionBlacklist

private string _collectionWhitelist

private int? _page

private int? _limit

private SortStrategy? _sortStrategy

private string _sort

Last updated