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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Find address: Find the location for an address.

Find place: Find places of interest near a location or within a specific area.

Offline geocode: Geocode addresses to locations and reverse geocode locations to addresses offline.

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

Relevant samples

Find place: Find places of interest near a location or within a specific area.

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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

SuggestAsync(string)

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.0 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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

SuggestAsync(string)

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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

SuggestAsync(string)

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.0 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.15
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8

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

SuggestAsync(string)

Applies to

Platforms and versions

Target	Versions
.NET Standard 2.0	100.3 - 200.8
.NET	100.13 - 300.0
.NET Windows	100.13 - 300.0
.NET Android	200.2 - 300.0
.NET iOS	200.0 - 300.0
.NET Framework	100.0 - 200.8
Xamarin.Android	100.0 - 100.14
Xamarin.iOS	100.0 - 100.15
UWP	100.0 - 200.8