AssetsUriParameterBuilder

Summary

Members
Descriptions

WithOwner sets the owner parameter

public AssetsUriParameterBuilder WithCollectionName(string collectionName)

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

public AssetsUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

WithTemplateId sets the _templateId variable to the value of the templateId parameter

WithMatch sets the match parameter

public AssetsUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

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

public AssetsUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

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

public AssetsUriParameterBuilder WithOnlyDuplicateTemplate(bool onlyDuplicateTemplates)

WithOnlyDuplicatedTemplate sets the _onlyDuplicatedTemplate field to the value of the 'onlyDuplicateTemplate' parameter

public AssetsUriParameterBuilder WithAuthorisedAccount(string authorisedAccount)

WithAuthorisedAccount sets the authorisedAccount parameter

WithHideOffers sets the _hideOffers field to the value of the hideOffers parameter

public AssetsUriParameterBuilder WithIds(string[] ids)

This function takes an array of strings and joins them together with a comma.

public AssetsUriParameterBuilder WithLowerBound(string lowerBound)

WithLowerBound sets the lower bound of the account_ids parameter

public AssetsUriParameterBuilder WithUpperBound(string upperBound)

WithUpperBound sets the upper bound of the range of accounts to be returned

WithBefore sets the _before variable to the value of the before parameter

WithAfter sets the _after variable to the value of the after parameter

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.

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 _owner

private string _collectionName

private string _schemaName

private int? _templateId

private string _match

private string _collectionBlacklist

private string _collectionWhitelist

private string _authorisedAccount

private bool? _hideOffers

private string _ids

private string _lowerBound

private string _upperBound

private int? _before

private int? _after

private int? _page

private int? _limit

private string _sort

Members

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

public AssetsUriParameterBuilder WithCollectionName(string collectionName)

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

Parameters

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

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

  • schemaName The name of the schema to use.

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithTemplateId(int templateId)

WithTemplateId sets the _templateId variable to the value of the templateId parameter

Parameters

  • templateId The templateId of the results to return.

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithMatch(string match)

WithMatch sets the match parameter

Parameters

  • match The match parameter is used to filter the results. The match parameter is a string that is matched against the account name.

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

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

Parameters

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

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

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

Parameters

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

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithOnlyDuplicateTemplate(bool onlyDuplicateTemplates)

WithOnlyDuplicatedTemplate sets the _onlyDuplicatedTemplate field to the value of the 'onlyDuplicateTemplate' parameter

Parameters

  • onlyDuplicateTemplate Show only duplicated assets grouped by template

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithAuthorisedAccount(string authorisedAccount)

WithAuthorisedAccount sets the authorisedAccount parameter

Parameters

  • authorisedAccount The authorisedAccount parameter is used to filter assets the provided account can edit.

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithHideOffers(bool hideOffers)

WithHideOffers sets the _hideOffers field to the value of the hideOffers parameter

Parameters

  • hideOffers If true, the response will not include any offers.

Returns

The AccountsUriParameterBuilder object.

public AssetsUriParameterBuilder 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 AccountsUriParameterBuilder object.

public AssetsUriParameterBuilder WithLowerBound(string lowerBound)

WithLowerBound sets the lower bound of the account_ids parameter

Parameters

  • lowerBound The lower bound of the accounts to retrieve.

Returns

The AssetsUriParameterBuilder object.

public AssetsUriParameterBuilder WithUpperBound(string upperBound)

WithUpperBound sets the upper bound of the range of accounts to be returned

Parameters

  • upperBound The upper bound of the range to query.

Returns

The AssetsUriParameterBuilder object.

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

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

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

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

public AssetsUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

  • SortStrategy

Returns

The builder object itself.

public AssetsUriParameterBuilder WithSort(string sort)

It sets the sort parameter to the value passed in.

Parameters

  • sort The sort order of the results.

Returns

A new instance of the AssetsUriParameterBuilder class.

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 _owner

private string _collectionName

private string _schemaName

private int? _templateId

private string _match

private string _collectionBlacklist

private string _collectionWhitelist

private bool? _onlyDuplicateTemplates

private string _authorisedAccount

private bool? _hideOffers

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

Last updated