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 |
|---|---|---|
| System.String | searchText | The address for which to find location candidates. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.String | searchText | The address for which to find location candidates. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.String | searchText | The address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.String | searchText | The address for which to find location candidates. |
| GeocodeParameters | parameters | Additional search parameters to apply to the geocoding operation. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.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 |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> | searchValues | A dictionary containing the address for which to find location candidates. Each entry in the dictionary represents one line of the address. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.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 |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|---|
| System.Collections.Generic.Dictionary<System.String, System.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. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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 |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.0 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.15 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |
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. |
| System.Threading.CancellationToken | cancellationToken | A cancellation token that can be used by other objects or threads to receive notice of cancellation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.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.5 |
| .NET | 100.13 - 200.5 |
| .NET Windows | 100.13 - 200.5 |
| .NET Android | 200.2 - 200.5 |
| .NET iOS | 200.0 - 200.5 |
| .NET Framework | 100.0 - 200.5 |
| Xamarin.Android | 100.0 - 100.14 |
| Xamarin.iOS | 100.0 - 100.15 |
| UWP | 100.0 - 200.5 |