Class LocatorTask
Represents a task that enables geocoding and reverse geocoding against an ArcGIS locator.
Namespace: Esri.ArcGISRuntime.Tasks.Geocoding
Assembly: Esri.ArcGISRuntime.dll
Syntax
public sealed class LocatorTask : ILoadable, IDisposable, IApiKeyResourceRemarks
Geocoding is the process of assigning a location, usually in the form of coordinate values (points), to an address by comparing the descriptive location elements in the address to those present in the reference material. Addresses come in many forms, ranging from the common address format of a house number followed by the street name and succeeding information to other location descriptions such as postal zone or census tract. An address includes any type of information that distinguishes a place. Reverse geocoding is the process of determining the closest address to a location usually given in the form of a coordinate value (point).
Constructors
| Name | Description |
|---|---|
| LocatorTask(Uri) | Initializes a new instance of the LocatorTask class |
Properties
| Name | Description |
|---|---|
| ApiKey | Gets or sets the unique key generated from ArcGIS Developers website. |
| LoadError | Gets the Exception associated with the last load error. |
| LoadStatus | Gets the load status. |
| LocatorInfo | Gets the locator's metadata. |
| Uri | Gets the URI of the locator. |
Methods
| Name | Description |
|---|---|
| CancelLoad() | Cancel loading metadata for the object. |
| CreateAsync(Uri) | Creates a new instance of the LocatorTask class |
| Dispose() | |
| GeocodeAsync(SuggestResult) | Executes a geocoding operation to find location candidates for a given address suggestion. |
| GeocodeAsync(SuggestResult, GeocodeParameters) | Executes a geocoding operation to find location candidates for a given address suggestion and set of search parameters. |
| GeocodeAsync(SuggestResult, GeocodeParameters, CancellationToken) | Executes a geocoding operation to find location candidates for a given address suggestion and set of search parameters. |
| GeocodeAsync(SuggestResult, CancellationToken) | Executes a geocoding operation to find location candidates for a given address suggestion. |
| GeocodeAsync(Dictionary<String, String>) | Executes a geocoding operation to find location candidates for a given multiline address. |
| GeocodeAsync(Dictionary<String, String>, GeocodeParameters) | Executes a geocoding operation to find location candidates for a given multiline address and set of search parameters. |
| GeocodeAsync(Dictionary<String, String>, GeocodeParameters, CancellationToken) | Executes a geocoding operation to find location candidates for a given multiline address and set of search parameters. |
| GeocodeAsync(Dictionary<String, String>, CancellationToken) | Executes a geocoding operation to find location candidates for a given multiline address. |
| GeocodeAsync(String) | Executes a geocoding operation to find location candidates for a given address. |
| GeocodeAsync(String, GeocodeParameters) | Executes a geocoding operation to find location candidates for a given address and set of search parameters. |
| GeocodeAsync(String, GeocodeParameters, CancellationToken) | Executes a geocoding operation to find location candidates for a given address and set of search parameters. |
| GeocodeAsync(String, CancellationToken) | Executes a geocoding operation to find location candidates for a given address. |
| LoadAsync() | Load the metadata for the object asynchronously. |
| RetryLoadAsync() | Loads or retries loading metadata for the object asynchronously. |
| ReverseGeocodeAsync(MapPoint) | Executes a reverse geocoding operation to find address candidates for a given location. |
| ReverseGeocodeAsync(MapPoint, ReverseGeocodeParameters) | Executes a reverse geocoding operation to find address candidates for a given location and set of search parameters. |
| ReverseGeocodeAsync(MapPoint, ReverseGeocodeParameters, CancellationToken) | Executes a reverse geocoding operation to find address candidates for a given location and set of search parameters. |
| ReverseGeocodeAsync(MapPoint, CancellationToken) | Executes a reverse geocoding operation to find address candidates for a given location. |
| SuggestAsync(String) | Retrieves a list of possible address variants for a given partial address. |
| SuggestAsync(String, SuggestParameters) | Retrieves a list of possible address variants for a given partial address and set of search parameters. |
| SuggestAsync(String, SuggestParameters, CancellationToken) | Retrieves a list of possible address variants for a given partial address and set of search parameters. |
| SuggestAsync(String, CancellationToken) | Retrieves a list of possible address variants for a given partial address and set of search parameters. |
Events
| Name | Description |
|---|---|
| Loaded | Event that is raised when the object is done loading. |
| LoadStatusChanged | Event that is raised when the LoadStatus property changes. |
Applies to
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.2 |
| .NET 6.0 | 100.13 - 200.2 |
| .NET 6.0 Windows | 100.13 - 200.2 |
| .NET 6.0 Android | 200.0 - 200.2 |
| .NET 6.0 iOS | 200.0 - 200.2 |
| .NET Framework | 100.0 - 200.2 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.15 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.2 |