An interface for getting and setting the API key of an object. More...
This class was introduced in Esri::ArcGISRuntime 100.10.
Public Functions
| virtual | ~ApiKeyResource() |
| virtual QString | apiKey() const = 0 |
| virtual void | setApiKey(const QString &apiKey) = 0 |
Protected Functions
Detailed Description
This interface gets and sets the API key generated from the ArcGIS Developers website. website on objects where required.
Member Function Documentation
[protected] ApiKeyResource::ApiKeyResource ()
Constructor.
[virtual] ApiKeyResource::~ApiKeyResource ()
Destructor.
[pure virtual] QString ApiKeyResource::apiKey () const
Returns the 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 API key at a global level for your application using the ArcGISRuntimeEnvironment::apiKey property, you can set an ApiKeyResource::apiKey property on any ArcGIS Runtime class that implements ApiKeyResource. Setting an individual ApiKeyResource::apiKey property on an ApiKeyResource will override the default key at the global level (ArcGISRuntimeEnvironment::apiKey property), enabling more granular usage and management of the ArcGIS Online resources used by your app.
Classes that expose an API key property by implementing ApiKeyResource include:
- Basemap
- ArcGISSceneLayer
- ArcGISTiledLayer
- ArcGISVectorTiledLayer
- ServiceFeatureTable
- ExportVectorTilesTask
- LocatorTask
- GeodatabaseSyncTask
- ClosestFacilityTask
- RouteTask
- ServiceAreaTask
- ExportTileCacheTask
See also setApiKey().
[pure virtual] void ApiKeyResource::setApiKey (const QString &apiKey )
Sets the API key to apiKey.
See also apiKey().