A common set of query parameters used across list operations in the Bentley API. More...

#include <CesiumITwinClient/Connection.h>

Public Member Functions
void	addToQuery (CesiumUtility::UriQuery &uriQuery) const
	Adds the parameters in this object to the provided URI query string.

void	addToUri (CesiumUtility::Uri &uri) const
	Adds the parameters in this object to the query of the provided URI.

Public Attributes
std::optional< std::string >	search
	A search string to use to limit results. Not used by all endpoints.

std::optional< std::string >	orderBy
	Used to order the results.

std::optional< uint32_t >	top
	Limits the number of items that can be returned.

std::optional< uint32_t >	skip
	Requests that this number of items in the results will be skipped and not returned.

Detailed Description

A common set of query parameters used across list operations in the Bentley API.

Definition at line 31 of file Connection.h.

Member Data Documentation

◆ orderBy

std::optional<std::string> CesiumITwinClient::QueryParameters::orderBy

Used to order the results.

Ascending or descending order can be selected with the asc and desc keywords. Ordering by multiple properties at a time is supported: name desc,createdDateTime desc.

The set of properties that orderBy can reference is endpoint-specific.

Definition at line 46 of file Connection.h.

◆ search

std::optional<std::string> CesiumITwinClient::QueryParameters::search

A search string to use to limit results. Not used by all endpoints.

Definition at line 36 of file Connection.h.

◆ skip

std::optional<uint32_t> CesiumITwinClient::QueryParameters::skip

Requests that this number of items in the results will be skipped and not returned.

Definition at line 60 of file Connection.h.

◆ top

std::optional<uint32_t> CesiumITwinClient::QueryParameters::top

Limits the number of items that can be returned.

For example, top = 50 would return only the first 50 items. The limit is 1,000.

Definition at line 54 of file Connection.h.

The documentation for this struct was generated from the following file:

/home/runner/work/cesium-native/cesium-native/CesiumITwinClient/include/CesiumITwinClient/Connection.h