Classes for working with Cesium ion clients. More...

Classes
struct	ApplicationData
	Data retrieved from the Cesium ion server via an "appData" request from Cesium ion. This actually represents information about the server itself. More...

struct	Asset
	A Cesium ion Asset, such as a 3D Tiles tileset or an imagery layer. More...

struct	Assets
	A page of assets obtained from the Cesium ion `v1/assets` endpoint, including a link to obtain the next page, if one exists. More...

class	Connection
	A connection to Cesium ion that can be used to interact with it via its REST API. More...

struct	DefaultAssets
	The default assets. More...

struct	Defaults
	The data returned by Cesium ion's `v1/defaults` service. It includes information about default imagery, terrain and building assets along with quick add assets that can be useful to use within other applications. More...

struct	GeocoderAttribution
	Attribution information for a query to a geocoder service. More...

struct	GeocoderFeature
	A single feature (a location or region) obtained from a geocoder service. More...

struct	GeocoderResult
	The result of making a request to a geocoder service. More...

struct	ListTokensOptions
	Options to be passed to `Connection::tokens`. More...

struct	NoValue
	A non-value, for use with a valueless `Response`. More...

struct	Profile
	Contains of a Cesium ion user. More...

struct	ProfileStorage
	Information about the amount of storage available in a user's account. More...

struct	QuickAddAsset
	A quick add asset. More...

struct	QuickAddRasterOverlay
	A raster overlay available for use with a quick add asset. More...

struct	Response
	A response from Cesium ion. More...

struct	Token
	A Cesium ion access token. More...

struct	TokenList
	A list of Cesium ion access tokens, as returned by the "List Tokens" service. More...

Enumerations
enum	AuthenticationMode { CesiumIon , Saml , SingleUser }
	An enumeration representing the values of the `authenticationMode` property in the `appData` response. More...

enum class	SortOrder { Ascending , Descending }
	Whether sorted results should be ascending or descending. More...

enum	GeocoderRequestType { Search , Autocomplete }
	The supported types of requests to geocoding API. More...

enum	GeocoderProviderType { Google , Bing , Default }
	The supported providers that can be accessed through ion's geocoder API. More...

Detailed Description

Classes for working with Cesium ion clients.

--- comment: This file was generated by dep-graph-gen. DO NOT EDIT THIS FILE! title: CesiumIonClient Dependency Graph --- graph TD classDef dependencyNode fill:#fff,stroke:#ccc,color:#666,font-weight:bold,font-size:28px classDef libraryNode fill:#9f9,font-weight:bold,font-size:28px CesiumIonClient[CesiumIonClient] --> CesiumAsync[CesiumAsync] CesiumIonClient[CesiumIonClient] --> CesiumGeospatial[CesiumGeospatial] CesiumIonClient[CesiumIonClient] --> CesiumUtility[CesiumUtility] CesiumIonClient[CesiumIonClient] --> OpenSSL_Crypto{{OpenSSL::Crypto}} CesiumIonClient[CesiumIonClient] --> httplib_httplib{{httplib::httplib}} CesiumIonClient[CesiumIonClient] --> modp_b64_modp_b64{{modp_b64::modp_b64}} CesiumIonClient[CesiumIonClient] --> picosha2_picosha2{{picosha2::picosha2}} class OpenSSL_Crypto,httplib_httplib,modp_b64_modp_b64,picosha2_picosha2 dependencyNode class CesiumAsync,CesiumGeospatial,CesiumUtility,CesiumIonClient libraryNode

Enumeration Type Documentation

◆ AuthenticationMode

enum CesiumIonClient::AuthenticationMode

An enumeration representing the values of the authenticationMode property in the appData response.

Enumerator
CesiumIon	Authentication using OAuth with an ion.cesium.com account.
Saml	Authentication using OAuth with Cesium ion Self-Hosted. On the server, this uses the Security Assertion Markup Language (SAML) to communicate with another authentication server. From our perspective, we can treat this the same as `AuthenticationMode::CesiumIon`.
SingleUser	A Cesium ion Self-Hosted server without authentication. In single-user mode, any application that can reach the server has permissions to use its endpoints. In this mode, some endpoints (like /me and /tokens) are unavailable.

Definition at line 11 of file ApplicationData.h.

◆ GeocoderProviderType

enum CesiumIonClient::GeocoderProviderType

The supported providers that can be accessed through ion's geocoder API.

Enumerator
Google	Google geocoder, for use with Google data.
Bing	Bing geocoder, for use with Bing data.
Default	Use the default geocoder as set on the server. Used when neither Bing or Google data is used.

Definition at line 34 of file Geocoder.h.

◆ GeocoderRequestType

enum CesiumIonClient::GeocoderRequestType

The supported types of requests to geocoding API.

Enumerator
Search	Perform a full search from a complete query.
Autocomplete	Perform a quick search based on partial input, such as while a user is typing. The search results may be less accurate or exhaustive than using `GeocoderRequestType::Search`.

Definition at line 16 of file Geocoder.h.

◆ SortOrder

enum class CesiumIonClient::SortOrder

strong

Whether sorted results should be ascending or descending.

Definition at line 22 of file Connection.h.