Method GeocodeAsync
GeocodeAsync(String)
Executes a geocoding operation to find location candidates for a given address.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(string searchText)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchText | The address for which to find location candidates. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
Relevant samples
GeocodeAsync(String, CancellationToken)
Executes a geocoding operation to find location candidates for a given address.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(string searchText, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchText | The address for which to find location candidates. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(String, GeocodeParameters)
Executes a geocoding operation to find location candidates for a given address and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(string searchText, GeocodeParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchText | The address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
Relevant samples
GeocodeAsync(String, GeocodeParameters, CancellationToken)
Executes a geocoding operation to find location candidates for a given address and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(string searchText, GeocodeParameters parameters, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| String | searchText | The address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(Dictionary<String, String>)
Executes a geocoding operation to find location candidates for a given multiline address.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(Dictionary<string, string> searchValues)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<String, String> | searchValues | A dictionary containing the address for which to find location candidates. Each entry in the dictionary represents one line of the address. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(Dictionary<String, String>, CancellationToken)
Executes a geocoding operation to find location candidates for a given multiline address.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(Dictionary<string, string> searchValues, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<String, String> | searchValues | A dictionary containing the address for which to find location candidates. Each entry in the dictionary represents one line of the address. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(Dictionary<String, String>, GeocodeParameters)
Executes a geocoding operation to find location candidates for a given multiline address and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(Dictionary<string, string> searchValues, GeocodeParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<String, String> | searchValues | A dictionary containing the address for which to find location candidates. Each entry in the dictionary represents one line of the address. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(Dictionary<String, String>, GeocodeParameters, CancellationToken)
Executes a geocoding operation to find location candidates for a given multiline address and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(Dictionary<string, string> searchValues, GeocodeParameters parameters, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| Dictionary<String, String> | searchValues | A dictionary containing the address for which to find location candidates. Each entry in the dictionary represents one line of the address. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(SuggestResult)
Executes a geocoding operation to find location candidates for a given address suggestion.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(SuggestResult suggestResult)Parameters
| Type | Name | Description |
|---|---|---|
| SuggestResult | suggestResult | The suggested address for which to find location candidates. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 Android | 200 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .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.0 |
GeocodeAsync(SuggestResult, CancellationToken)
Executes a geocoding operation to find location candidates for a given address suggestion.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(SuggestResult suggestResult, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| SuggestResult | suggestResult | The suggested address for which to find location candidates. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |
GeocodeAsync(SuggestResult, GeocodeParameters)
Executes a geocoding operation to find location candidates for a given address suggestion and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(SuggestResult suggestResult, GeocodeParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| SuggestResult | suggestResult | The suggested address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 Android | 200 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .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.0 |
GeocodeAsync(SuggestResult, GeocodeParameters, CancellationToken)
Executes a geocoding operation to find location candidates for a given address suggestion and set of search parameters.
Declaration
public Task<IReadOnlyList<GeocodeResult>> GeocodeAsync(SuggestResult suggestResult, GeocodeParameters parameters, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| SuggestResult | suggestResult | The suggested address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
| CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| Task<IReadOnlyList<GeocodeResult>> | A task that represents the asynchronous geocoding operation. The value of the task result contains a read-only collection of GeocodeResult objects. |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.3 - 200.0 |
| .NET 6.0 | 100.13 - 200.0 |
| .NET 6.0 Windows | 100.13 - 200.0 |
| .NET 6.0 iOS | 200 |
| .NET Framework | 100.0 - 200.0 |
| .NET 5 | 100.10 - 100.12 |
| .NET Core 3.1 | 100.7 - 100.12 |
| Android | 100.0 - 100.14 |
| iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.0 |