Method SuggestAsync
SuggestAsync(String)
Retrieves a list of possible address variants for a given partial address.
Declaration
public Task<IReadOnlyList<SuggestResult>> SuggestAsync(string searchText)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchText | The partial address for which to get suggestions. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SuggestResult>> | A task that represents the asynchronous suggestion operation. The value of the task result contains a read-only collection of SuggestResult objects. |
Remarks
Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the PreferredSearchLocation or the SearchArea. Using the PreferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.
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 |
Relevant samples
SuggestAsync(String, CancellationToken)
Retrieves a list of possible address variants for a given partial address and set of search parameters.
Declaration
public Task<IReadOnlyList<SuggestResult>> SuggestAsync(string searchText, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchText | The partial address for which to get suggestions. |
| 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<SuggestResult>> | A task that represents the asynchronous suggestion operation. The value of the task result contains a read-only collection of SuggestResult objects. |
Remarks
Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the PreferredSearchLocation or the SearchArea. Using the PreferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.
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 |
SuggestAsync(String, SuggestParameters)
Retrieves a list of possible address variants for a given partial address and set of search parameters.
Declaration
public Task<IReadOnlyList<SuggestResult>> SuggestAsync(string searchText, SuggestParameters parameters)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchText | The partial address for which to get suggestions. |
| SuggestParameters | parameters | Additional search parameters for the suggestion operation. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<SuggestResult>> | A task that represents the asynchronous suggestion operation. The value of the task result contains a read-only collection of SuggestResult objects. |
Remarks
Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the PreferredSearchLocation or the SearchArea. Using the PreferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.
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 |
Relevant samples
SuggestAsync(String, SuggestParameters, CancellationToken)
Retrieves a list of possible address variants for a given partial address and set of search parameters.
Declaration
public Task<IReadOnlyList<SuggestResult>> SuggestAsync(string searchText, SuggestParameters parameters, CancellationToken cancellationToken)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | searchText | Part of address text. |
| SuggestParameters | parameters | Suggest method parameters. |
| 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<SuggestResult>> | A task that represents the asynchronous suggestion operation. The value of the task result contains a read-only collection of SuggestResult objects. |
Remarks
Geocoding suggestions provide a mechanism for implementing character-by-character auto-complete. Using a text input and optional SuggestParameters, suggested addresses can be quickly found and presented to the user. Suggestions are not limited to addresses, they can also be used for POIs (Points of Interest). To return a focused set of suggestions, set the PreferredSearchLocation or the SearchArea. Using the PreferredSearchLocation is similar to how ArcGIS Pro limits the suggestions returned.
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 |