SchemasUriParameterBuilder

Summary

Members	Descriptions
public SchemasUriParameterBuilder WithCollectionName(string collectionName)	WithCollectionName is a function that takes a string as a parameter and returns an SchemasUriParameterBuilder object
public SchemasUriParameterBuilder WithSchemaName(string schemaName)	This function sets the schema name for the query.
public SchemasUriParameterBuilder WithMatch(string match)	WithMatch sets the match parameter
public SchemasUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)	WithCollectionBlacklist is a function that takes an array of strings and returns an SchemasUriParameterBuilder object
public SchemasUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)	WithCollectionWhitelist is a function that takes an array of strings and returns an SchemasUriParameterBuilder object
public SchemasUriParameterBuilder WithAuthorisedAccount(string authorisedAccount)	WithAuthorisedAccount sets the authorisedAccount parameter
public SchemasUriParameterBuilder WithIds(string[] ids)	This function takes an array of strings and joins them together with a comma.
public SchemasUriParameterBuilder WithLowerBound(string lowerBound)	WithLowerBound sets the lower bound of the account_ids parameter
public SchemasUriParameterBuilder WithUpperBound(string upperBound)	WithUpperBound sets the upper bound of the range of accounts to be returned
public SchemasUriParameterBuilder WithBefore(int before)	WithBefore sets the _before variable to the value of the before parameter
public SchemasUriParameterBuilder WithAfter(int after)	WithAfter sets the _after variable to the value of the after parameter
public SchemasUriParameterBuilder WithPage(int page)	WithPage sets the _page variable to the value of the page parameter
public SchemasUriParameterBuilder WithLimit(int limit)	WithLimit sets the _limit variable to the value of the limit parameter
public SchemasUriParameterBuilder WithOrder( SortStrategy sorting)	This function sets the sort strategy for the query.
public SchemasUriParameterBuilder WithSort(string sort)	It sets the sort parameter.
public string Build()	It builds a query string based on the parameters that have been set.
private string _collectionName
private string _authorisedAccount
private string _schemaName
private string _match
private string _collectionBlacklist
private string _collectionWhitelist
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

Members

public SchemasUriParameterBuilder WithCollectionName(string collectionName)

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

Parameters

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

Returns

The SchemasUriParameterBuilder object.

public SchemasUriParameterBuilder WithSchemaName(string schemaName)

This function sets the schema name for the query.

Parameters

• schemaName The name of the schema to use.

Returns

The ShemasUriParameterBuilder object.

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

public SchemasUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)

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

Parameters

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

Returns

The SchemasUriParameterBuilder object.

public SchemasUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)

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

Parameters

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

Returns

The SchemasUriParameterBuilder object.

public SchemasUriParameterBuilder WithAuthorisedAccount(string authorisedAccount)

WithAuthorisedAccount sets the authorisedAccount parameter

Parameters

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

Returns

The SchemasUriParameterBuilder object.

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

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

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

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

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

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

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

public SchemasUriParameterBuilder WithOrder( SortStrategy sorting)

This function sets the sort strategy for the query.

Parameters

• SortStrategy

Returns

The builder object itself.

public SchemasUriParameterBuilder WithSort(string sort)

It sets the sort parameter.

Parameters

• sort The sort order of the results.

Returns

A new instance of the SchemasUriParameterBuilder 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 _collectionName

private string _authorisedAccount

private string _schemaName

private string _match

private string _collectionBlacklist

private string _collectionWhitelist

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