BasemapStylesService Class

Member Function Documentation

[explicit] BasemapStylesService::BasemapStylesService(QObject *parent = nullptr)

Creates a BasemapStylesService object.

• parent - The optional parent QObject.

[override virtual] BasemapStylesService::~BasemapStylesService()

Destructor.

[override virtual] QString BasemapStylesService::apiKey() const

Reimplements: ApiKeyResource::apiKey() const.

Returns 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 API keys` 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.

Note: An API key created with a referrer is not supported. If you need service requests to include the referrer, use the SDK's functionality to intercept the request and add an HTTP referer header.

In addition to setting an ArcGISRuntimeEnvironment::apiKey at a global level for your application, you can set it on any class that implements ApiKeyResource. 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 ApiKeyResource include:

• Basemap
• ArcGISSceneLayer
• ArcGISTiledLayer
• ArcGISVectorTiledLayer
• ServiceFeatureTable
• ExportVectorTilesTask
• LocatorTask
• GeodatabaseSyncTask
• ClosestFacilityTask
• RouteTask
• ServiceAreaTask
• ExportTileCacheTask

For more information, see API key authentication and Types of authentication.

See also setApiKey().

[override virtual] void BasemapStylesService::cancelLoad()

Reimplements: Loadable::cancelLoad().

Cancels loading metadata for the object.

Cancels loading the metadata if the object is loading and always calls doneLoading.

[override virtual] Esri::ArcGISRuntime::Credential *BasemapStylesService::credential() const

Reimplements: RemoteResource::credential() const.

Returns security credentials to access the remote resource. Only applicable if the resource is secured.

[signal] void BasemapStylesService::doneLoading(const Esri::ArcGISRuntime::Error &loadError)

Signal emitted when this object is done loading.

• loadError - Details about any error that may have occurred.

See also Loadable and Object.

Esri::ArcGISRuntime::BasemapStylesServiceInfo *BasemapStylesService::info() const

Returns information about the Basemap Style Service.

[override virtual] void BasemapStylesService::load()

Reimplements: Loadable::load().

Loads the metadata for the object asynchronously.

Loads the metadata if the object is not loaded and always calls doneLoading.

[override virtual] Esri::ArcGISRuntime::Error BasemapStylesService::loadError() const

Reimplements: Loadable::loadError() const.

Returns the load error.

See also Error.

[override virtual] Esri::ArcGISRuntime::LoadStatus BasemapStylesService::loadStatus() const

Reimplements: Loadable::loadStatus() const.

Returns the load status.

See also LoadStatus.

[signal] void BasemapStylesService::loadStatusChanged(Esri::ArcGISRuntime::LoadStatus loadStatus)

Signal emitted when the loadStatus property changes.

See also Loadable.

[override virtual] Esri::ArcGISRuntime::RequestConfiguration BasemapStylesService::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this service.

See also setRequestConfiguration().

[override virtual] void BasemapStylesService::retryLoad()

Reimplements: Loadable::retryLoad().

Loads or retries loading metadata for the object asynchronously.

Will retry loading the metadata if the object is failed to load. Will load the object if it is not loaded. Will not retry to load the object if the object is loaded. Will always call the done loading if this is called.

[override virtual] void BasemapStylesService::setApiKey(const QString &apiKey)

Reimplements: ApiKeyResource::setApiKey(const QString &apiKey).

Sets the apiKey to apiKey.

See also apiKey.

[override virtual] void BasemapStylesService::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

Reimplements: RemoteResource::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration).

Sets configuration parameters used for network requests sent by this service to requestConfiguration.

See also requestConfiguration().

[override virtual protected] QUrl BasemapStylesService::url() const

Reimplements: RemoteResource::url() const.

Gets the URL of the BasemapStylesService self-describing endpoint.

Returns the URL.