Obsolete Members for LocatorTask

  • LocatorTask
  • The following members of class LocatorTask are deprecated. They are provided to keep old source code working. We strongly advise against using them in new code.

    Public Functions

    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocode(const QString &searchText)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocodeWithParameters(const QString &searchText, const Esri::ArcGISRuntime::GeocodeParameters &parameters)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocodeWithSearchValues(const QMap<QString, QString> &searchValues)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocodeWithSearchValuesAndParameters(const QMap<QString, QString> &searchValues, const Esri::ArcGISRuntime::GeocodeParameters &parameters)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocodeWithSuggestResult(const Esri::ArcGISRuntime::SuggestResult &suggestResult)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher geocodeWithSuggestResultAndParameters(const Esri::ArcGISRuntime::SuggestResult &suggestResult, const Esri::ArcGISRuntime::GeocodeParameters &parameters)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher reverseGeocode(const Esri::ArcGISRuntime::Point &location)
    (deprecated) Esri::ArcGISRuntime::TaskWatcher reverseGeocodeWithParameters(const Esri::ArcGISRuntime::Point &location, const Esri::ArcGISRuntime::ReverseGeocodeParameters &parameters)

    Member Function Documentation

    Esri::ArcGISRuntime::TaskWatcher LocatorTask::geocode(const QString &searchText)

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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.

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

    This function is deprecated. We strongly advise against using it in new code.

    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)

    This function is deprecated. We strongly advise against using it in new code.

    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.

    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.