BurnsUriParameterBuilder
Summary
WithCollectionName is a function that takes a string as a parameter and returns an BurnsUriParameterBuilder 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 BurnsUriParameterBuilder object
WithCollectionWhitelist is a function that takes an array of strings and returns an BurnsUriParameterBuilder object
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
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 builds a query string based on the parameters that have been set.
Members
public BurnsUriParameterBuilder WithCollectionName(string collectionName)
WithCollectionName is a function that takes a string as a parameter and returns an BurnsUriParameterBuilder object
Parameters
collectionNameThe name of the collection you want to query.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithSchemaName(string schemaName)
This function sets the schema name for the query.
Parameters
schemaNameThe name of the schema to use.
Returns
The AccountsUriParameterBuilder object.
public BurnsUriParameterBuilder WithTemplateId(string templateId)
It sets the value of the templateId variable.
Parameters
templateIdThe ID of the template to use for the account.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithCollectionBlacklist(string[] collectionBlacklist)
WithCollectionBlacklist is a function that takes an array of strings and returns an BurnsUriParameterBuilder object
Parameters
collectionBlacklistA list of collections to exclude from the results.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithCollectionWhitelist(string[] collectionWhitelist)
WithCollectionWhitelist is a function that takes an array of strings and returns an BurnsUriParameterBuilder object
Parameters
collectionWhitelistA list of collections to include in the response.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder 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 BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithLowerBound(string lowerBound)
WithLowerBound sets the lower bound of the account_ids parameter
Parameters
lowerBoundThe lower bound of the accounts to retrieve.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder 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 BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder 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 BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithLimit(int limit)
WithLimit sets the _limit variable to the value of the limit parameter
Parameters
limitThe number of results to return.
Returns
The BurnsUriParameterBuilder object.
public BurnsUriParameterBuilder WithOrder( SortStrategy sorting)
This function sets the sort strategy for the query.
Parameters
SortStrategy
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 _collectionName
private string _schemaName
private string _templateId
private string _collectionBlacklist
private string _collectionWhitelist
private string _ids
private string _lowerBound
private string _upperBound
private int? _page
private int? _limit
private SortStrategy? _sortStrategy
Last updated