LocatorTask Class

// create the locator task
auto* locatorTask = new LocatorTask(QUrl("http://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer"), this);

// connect to the loadStatusChanged signal
connect(locatorTask, &LocatorTask::loadStatusChanged, this, [](LoadStatus loadStatus)
{
  if (loadStatus == LoadStatus::Loaded)
  {
    qDebug() << "Locator is ready to use";
  }
  else if (loadStatus == LoadStatus::FailedToLoad)
  {
    qDebug() << "Locator failed to load";
  }
});

// load the locator task
locatorTask->load();

Member Function Documentation

[explicit] LocatorTask::LocatorTask(const QUrl &url, QObject *parent = nullptr)

Constructor that takes a url to a local locator or online geocode service, with an optional parent.

LocatorTask::LocatorTask(const QUrl &url, Esri::ArcGISRuntime::Credential *credential, QObject *parent = nullptr)

Constructor that takes a url to a secured online geocode service and a credential, with an optional parent.

[override virtual] LocatorTask::~LocatorTask()

Destructor.

[override virtual, since Esri::ArcGISRuntime 100.10] QString LocatorTask::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:

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

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

This function was introduced in Esri::ArcGISRuntime 100.10.

See also setApiKey().

[override virtual] void LocatorTask::cancelLoad()

Reimplements: Loadable::cancelLoad().

See Loadable.

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

Reimplements: RemoteResource::credential() const.

Returns the security credential used to access the geocoding service.

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

Signal emitted when this object is done loading.

• loadError - The Error object.

See also Loadable and Object.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeAsync(const QString &searchText)

Geocodes an address with the given searchText.

Use the LocatorTask::locatorInfo to determine the types of search text supported by the locator. Potential searches could be an address (380 New York St.), a point of interest (Starbucks), or an intersection (Redlands Blvd and Tennessee St).

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[signal] void LocatorTask::geocodeCompleted(const QUuid &taskId, const QList<Esri::ArcGISRuntime::GeocodeResult> &geocodeResults)

Signal emitted after any of the geocode asynchronous methods complete.

• taskId - The task ID of the asynchronous task.
• geocodeResults - The generated list of geocode results.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeWithParametersAsync(const QString &searchText, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes address with parameters and returns candidates.

• searchText - Address inputs.
• parameters - Geocode method parameters.

Executes a geocoding operation to find location candidates for a given address.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeWithSearchValuesAndParametersAsync(const QMap<QString, QString> &searchValues, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes multiline address with parameters and returns candidates.

• searchValues - Multiline address inputs.
• parameters - Geocode method parameters.

Executes a geocoding operation to find location candidates for a given multiline address.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeWithSearchValuesAsync(const QMap<QString, QString> &searchValues)

Geocodes multiline address and returns candidates.

• searchValues - Multiline address inputs.

Executes a geocoding operation to find location candidates for a given multiline address.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeWithSuggestResultAndParametersAsync(const Esri::ArcGISRuntime::SuggestResult &suggestResult, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes suggest with parameters and returns candidates.

• suggestResult - Suggest method result.
• parameters - Geocode parameters.

Executes geocoding based on result of suggestion.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::geocodeWithSuggestResultAsync(const Esri::ArcGISRuntime::SuggestResult &suggestResult)

Geocodes suggest and returns candidates.

• suggestResult - Suggest method result.

Executes geocoding based on result of suggestion.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[override virtual] void LocatorTask::load()

Reimplements: Loadable::load().

See Loadable.

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

Reimplements: Loadable::loadError() const.

See Loadable.

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

Reimplements: Loadable::loadStatus() const.

See Loadable.

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

Signal emitted when the load status changes for this object.

• loadStatus - The LoadStatus.

See also Loadable.

Esri::ArcGISRuntime::LocatorInfo LocatorTask::locatorInfo() const

Returns information about the locator used in this task.

[override virtual, since Esri::ArcGISRuntime 100.1] Esri::ArcGISRuntime::RequestConfiguration LocatorTask::requestConfiguration() const

Reimplements: RemoteResource::requestConfiguration() const.

Returns the RequestConfiguration in use by this task.

This function was introduced in Esri::ArcGISRuntime 100.1.

See also setRequestConfiguration().

[override virtual] void LocatorTask::retryLoad()

Reimplements: Loadable::retryLoad().

See Loadable.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::reverseGeocodeAsync(const Esri::ArcGISRuntime::Point &location)

Finds address by location point.

• location - The location point.

Executes a reverse-geocoding operation to find address candidates for a given location.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::GeocodeResult>> LocatorTask::reverseGeocodeWithParametersAsync(const Esri::ArcGISRuntime::Point &location, const Esri::ArcGISRuntime::ReverseGeocodeParameters &parameters)

Finds address with parameters by location point.

• location - The location point.
• parameters - The reverse geocode parameters.

Executes a reverse-geocoding operation to find address candidates for a given location.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[override virtual, since Esri::ArcGISRuntime 100.10] void LocatorTask::setApiKey(const QString &apiKey)

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

Sets the API key to apiKey.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also apiKey().

[override virtual, since Esri::ArcGISRuntime 100.1] void LocatorTask::setRequestConfiguration(const Esri::ArcGISRuntime::RequestConfiguration &requestConfiguration)

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

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

This function was introduced in Esri::ArcGISRuntime 100.1.

See also requestConfiguration().

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::SuggestResult>> LocatorTask::suggestAsync(const QString &searchText)

Suggest address and returns possible variants.

• searchText - Part of address text.

Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the SuggestParameters::preferredSearchLocation or the SuggestParameters::searchArea. Using the SuggestParameters::preferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

[since Esri::ArcGISRuntime 200.2] QFuture<QList<Esri::ArcGISRuntime::SuggestResult>> LocatorTask::suggestAsync(const QString &searchText, const Esri::ArcGISRuntime::SuggestParameters &parameters)

Suggest address with parameters and returns possible variants.

• searchText - Part of address text.
• parameters - Suggest method parameters.

Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the SuggestParameters::preferredSearchLocation or the SuggestParameters::searchArea. Using the SuggestParameters::preferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.

This method returns a QFuture for the asynchronous operation. Use future.then() to continue processing when the operation completes. Use future.onFailed() to handle exceptions of type ErrorException.

See Working with QFuture for further details.

This function was introduced in Esri::ArcGISRuntime 200.2.

Esri::ArcGISRuntime::SuggestListModel *LocatorTask::suggestions() const

Returns the SuggestListModel for this LocatorTask.

Use the LocatorTask::locatorInfo to determine if suggestions are supported by the locator. If so, suggestions can be used to provide a nice user experience where potential results are shown to the user while typing. If suggestions are supported by the LocatorTask, suggestions can be automatically generated by calling SuggestListModel::setSearchText. This list model can then be applied to a view to show suggested addresses or place names. See the SuggestListModel API documentation for further details.

[override virtual] QUrl LocatorTask::url() const

Reimplements: RemoteResource::url() const.

Returns the URL specified on the constructor.