sdk/com.mapbox.search.result/SearchSuggestion

SearchSuggestion

class SearchSuggestion : Parcelable

Autocomplete common suggestion type.

Functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)

Properties

Link copied to clipboard
val address: SearchAddress?

Address, might be null or incomplete.

Link copied to clipboard
val categories: List<String>?

Poi categories. Always empty for non-POI suggestions.

Link copied to clipboard
val coordinate: Point?

Search suggestion coordinate. Coordinates at suggestions step are available for selected customers only. Contact our team, if you're interested in this API.

Link copied to clipboard
val descriptionText: String?

Suggestion description.

Link copied to clipboard
val distanceMeters: Double?

Distance in meters from result to requested origin.

Link copied to clipboard
val etaMinutes: Double?

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

Link copied to clipboard
val externalIDs: Map<String, String>

Map of external ids. Returned Map instance is unmodifiable.

Link copied to clipboard
val fullAddress: String?

Full formatted address.

Link copied to clipboard
val id: String

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

Link copied to clipboard
val isBatchResolveSupported: Boolean

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

Link copied to clipboard
val makiIcon: String?

Maki icon name for search suggestion.

Link copied to clipboard
val matchingName: String?

The feature name, as matched by the search algorithm.

Link copied to clipboard
val metadata: SearchResultMetadata?

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

Link copied to clipboard
val name: String

Suggestion name.

Link copied to clipboard
val requestOptions: RequestOptions

Request options, that produced this suggestion.

Link copied to clipboard
val routablePoints: List<RoutablePoint>?

List of points near coordinate, that represents entries to associated building. Routable points at suggestions step are available for selected customers only. Contact our team, if you're interested in this API.

Link copied to clipboard
val serverIndex: Int?

Index in response from server.

Link copied to clipboard
val type: SearchSuggestionType

Type of the suggestion.