SchemasUriParameterBuilder
Summary
WithCollectionName is a function that takes a string as a parameter and returns an SchemasUriParameterBuilder object
This function sets the schema name for the query.
WithMatch sets the match parameter
WithCollectionBlacklist is a function that takes an array of strings and returns an SchemasUriParameterBuilder object
WithCollectionWhitelist is a function that takes an array of strings and returns an SchemasUriParameterBuilder object
WithAuthorisedAccount sets the authorisedAccount parameter
This function takes an array of strings and joins them together with a comma.
WithLowerBound sets the lower bound of the account_ids parameter
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.
It builds a query string based on the parameters that have been set.
Members
public SchemasUriParameterBuilder WithCollectionName(string collectionName)
WithCollectionName is a function that takes a string as a parameter and returns an SchemasUriParameterBuilder object
Parameters
collectionNameThe 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
schemaNameThe name of the schema to use.
Returns
The ShemasUriParameterBuilder object.
public SchemasUriParameterBuilder WithMatch(string match)
WithMatch sets the match parameter
Parameters
matchThe 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
collectionBlacklistA 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
collectionWhitelistA list of collections to include in the response.
Returns
The SchemasUriParameterBuilder object.
public SchemasUriParameterBuilder WithAuthorisedAccount(string authorisedAccount)
WithAuthorisedAccount sets the authorisedAccount parameter
Parameters
authorisedAccountThe 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
idsA 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
lowerBoundThe 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
upperBoundThe 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
beforeThe 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
afterThe 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
pageThe 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
limitThe 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
sortThe 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
Last updated