arcgis-maps-kotlin/com.arcgismaps.tasks.geocode/LocatorTask/suggest

suggest

suspend fun suggest(searchText: String, parameters: SuggestParameters? = null): Result<List<SuggestResult>>

Suggest address with parameters and returns possible variants. 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 SuggestParameters.getPreferredSearchLocation() or the SuggestParameters.getSearchArea(). Using the SuggestParameters.getPreferredSearchLocation() is similar to how ArcGIS Pro limits the suggestions returned.

Return

A Result returning a List of SuggestResult

Since

200.1.0

Parameters

searchText

a text string entered by a user

parameters

an object containing parameters for the suggest operation

See also