Namespace: Esri::GameEngine
Class: Esri/GameEngine/ArcGISRuntimeEnvironment
Since: 1.0.0
Summary
Provides environment settings, such as an API key for access to ArcGIS location services.
Properties
| Property | Type | Nullable | Readonly | Summary |
|---|---|---|---|---|
APIKey | FString | No | No | The API key allows your app to access ArcGIS location services and private portal items. |
AuthenticationManager | ArcGISAuthenticationManager | Yes | No | The object responsible for issuing authentication challenges and managing credential stores. |
APIKey
static FString GetAPIKey()
static void SetAPIKey(const FString& APIKey)
The API key allows your app to access ArcGIS location services and private portal items.
An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS Location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate AP privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.
AuthenticationManager
static ArcGISAuthenticationManager GetAuthenticationManager()
static void SetAuthenticationManager(const ArcGISAuthenticationManager& authenticationManager)
The object responsible for issuing authentication challenges and managing credential stores.