sdk / com.mapbox.search.result / SearchSuggestion

SearchSuggestion

interface SearchSuggestion : Parcelable

Autocomplete common suggestion type. To retrieve coordinate and detailed address information, you have to push suggestion back to com.mapbox.search.SearchEngine.select method.

Types

TypeDescription

Experimental field, can be changed or removed in the next SDK releases. Type description of the suggestion.

sealed class TypeDescription : Parcelable

Properties

descriptionText

Suggestion description.

abstract val descriptionText: String?

distanceMeters

Distance in meters from result to requested proximity bias. May be null even for correct proximity argument.

abstract val distanceMeters: Double?

id

Unique identifier for suggestion result. Attention: Mapbox backend may change the identifier of the object in the future.

abstract val id: String

makiIcon

Experimental field, can be changed or removed in the next SDK releases. Optional MAKI-icon name describing suggestion. See Also: Mapbox MAKI

abstract val makiIcon: String?

name

Suggestion name.

abstract val name: String

requestOptions

Request options, that produced this suggestion.

abstract val requestOptions: RequestOptions

typeDescription

Experimental field, can be changed or removed in the next SDK releases. Type of the suggestion.

abstract val typeDescription: TypeDescription

Inheritors

SearchCategorySuggestion

Autocomplete category search suggestion type.

interface SearchCategorySuggestion : SearchSuggestion