cesium-native  0.41.0
CesiumIonClient::ListTokensOptions Struct Reference

Options to be passed to Connection::tokens. More...

#include <CesiumIonClient/Connection.h>

Public Attributes

std::optional< int32_t > limit
 The maximum number of tokens to return in a single page. More...
 
std::optional< int32_t > page
 The page number, where the first page of results is page 1 (not 0).
 
std::optional< std::string > search
 One or more keywords separated by whitespace by which to filter the list of tokens. The token name will contain each keyword of the search string.
 
std::optional< std::string > sortBy
 The property by which to sort results. Valid values are "NAME" and "LAST_USED".
 
std::optional< SortOrdersortOrder
 The property by which to sort results. Valid values are "NAME" and "LAST_USED".
 

Detailed Description

Options to be passed to Connection::tokens.

Definition at line 27 of file Connection.h.

Member Data Documentation

◆ limit

std::optional<int32_t> CesiumIonClient::ListTokensOptions::limit

The maximum number of tokens to return in a single page.

Receiving fewer tokens should not be interpreted as the end of the collection. The end of the collection is reached when the response does not contain Response::nextPageUrl.

Definition at line 35 of file Connection.h.


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