LocatorTask Class

// create the locator task
LocatorTask* 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

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.

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.

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

Signal emitted when this object is done loading.

• loadError - The Error object.

Note: If there is a load error it will also be emitted on the errorOccurred signal.

See also Loadable and Object.

[signal] void LocatorTask::geocodeCompleted(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.

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

Signal emitted when the load status changes for this object.

• loadStatus - The LoadStatus.

See also Loadable.

[override virtual] LocatorTask::~LocatorTask()

Destructor.

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

Reimplements: ApiKeyResource::apiKey() const.

Returns the API key. See ApiKeyResource.

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.

Note: Only applicable if using an online service that is secured.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocode(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).

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocodeWithParameters(const QString &searchText, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes an address with the given searchText and parameters.

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). The parameters allow you to set preferences, such as maximum number of results or search location.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocodeWithSearchValues(const QMap<QString, QString> &searchValues)

Geocodes an address with the given searchValues.

Use the LocatorTask::locatorInfo to determine the types of search text supported by the locator. SearchValues are key-value pairs, where the key is an attribute name, and the value is the value you are searching for in that field. Check LocatorInfo::searchAttributes for the search attributes available in the locator.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocodeWithSearchValuesAndParameters(const QMap<QString, QString> &searchValues, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes an address with the given searchValues and parameters.

Use the LocatorTask::locatorInfo to determine the types of search text supported by the locator. SearchValues are key-value pairs, where the key is an attribute name, and the value is the value you are searching for in that field. Check LocatorInfo::searchAttributes for the search attributes available in the locator. The parameters allow you to set preferences, such as maximum number of results or search location.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocodeWithSuggestResult(const Esri::ArcGISRuntime::SuggestResult &suggestResult)

Geocodes an address with the given suggestResult.

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. A SuggestResult can be selected by a user, and directly passed into this function to perform a geocode.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocodeWithSuggestResultAndParameters(const Esri::ArcGISRuntime::SuggestResult &suggestResult, const Esri::ArcGISRuntime::GeocodeParameters &parameters)

Geocodes an address with the given suggestResult and parameters.

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. A SuggestResult can be selected by a user, and directly passed into this function to perform a geocode. The parameters allow you to set preferences, such as maximum number of results or search location.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

[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.

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

Returns information about the locator used in this task.

[override virtual] 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.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::reverseGeocode(const Esri::ArcGISRuntime::Point &location)

Reverse Geocodes an address with the given location.

A common use case for this function is to create a Point from a mouse click on a map or from some other source, and use this function to obtain the nearest address to the location.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Note: The input point can be in any spatial reference. If the provided point does not have a spatial reference set on it, the locator task will assume it is in the spatial reference of the locator.

Esri::ArcGISRuntime::TaskWatcher LocatorTask::reverseGeocodeWithParameters(const Esri::ArcGISRuntime::Point &location, const Esri::ArcGISRuntime::ReverseGeocodeParameters &parameters)

Reverse Geocodes an address with the given location and parameters.

A common use case for this function is to create a Point from a mouse click on a map or from some other source, and use this function to obtain the nearest address to the location. The parameters allow you to set preferences, such as maximum number of results or maximum search distance.

The geocodeCompleted signal emits when the operation is complete, giving access to the list of GeocodeResult.

Note: The input point can be in any spatial reference. If the provided point does not have a spatial reference set on it, the locator task will assume it is in the spatial reference of the locator.

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

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

Sets the API key to apiKey. See ApiKeyResource.

This function was introduced in Esri::ArcGISRuntime 100.10.

See also apiKey().

[override virtual] 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().

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.