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 |
|---|---|---|---|---|
No | No | The default API key to access API key enabled services and resources in ArcGIS Online. |
APIKey
static FString GetAPIKey()
static void SetAPIKey(const FString& APIKey)
The default API key to access API key enabled services and resources in ArcGIS Online.
An API key is a unique key used to authorize access to specific services and resources in ArcGIS Online. It is also used to monitor access to those services. An API key is created and managed in the ArcGIS developer dashboard and is tied to a specific ArcGIS account.
In addition to setting an ArcGISRuntimeEnvironment::APIKey at a global level for your application, you
can set it on any class that implements APIKey. This overrides the
ArcGISRuntimeEnvironment::APIKey and enables more granular usage telemetry and management of ArcGIS
location resources used by your app.
Classes that expose an API key property by implementing APIKey include:
BasemapArcGISSceneLayer ArcGISTiledLayer ArcGISVectorTiled Layer ServiceFeature Table ExportVector Tiles Task LocatorTask GeodatabaseSync Task ClosestFacility Task RouteTask ServiceArea Task ExportTile Cache Task