SearchSuggestion

interface SearchSuggestion : Parcelable

Autocomplete common suggestion type.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

address

abstract val address: SearchAddress?

Address, might be null or incomplete.

categories

abstract val categories: List<String>

Search suggestion categories.

descriptionText

abstract val descriptionText: String?

Suggestion description.

distanceMeters

abstract val distanceMeters: Double?

Distance in meters from result to requested origin.

etaMinutes

abstract val etaMinutes: Double?

Estimated time of arrival (in minutes) based on the specified in the com.mapbox.search.SearchOptions origin point and navigation profile.

externalIDs

abstract val externalIDs: Map<String, String>

Experimental API, can be changed or removed in the next SDK releases.

abstract val id: String

Unique identifier for suggestion result.

isBatchResolveSupported

abstract val isBatchResolveSupported: Boolean

Denotes whether this suggestion can be passed as a parameter to a batch selection method of the com.mapbox.search.SearchEngine.

makiIcon

abstract val makiIcon: String?

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

matchingName

abstract val matchingName: String?

The feature name, as matched by the search algorithm.

metadata

abstract val metadata: SearchResultMetadata?

Search result metadata containing geo place's detailed information if available.

name

abstract val name: String

Suggestion name.

requestOptions

abstract val requestOptions: RequestOptions

Request options, that produced this suggestion.

serverIndex

abstract val serverIndex: Int?

Index in response from server.

type

abstract val type: SearchSuggestionType

Type of the suggestion.