SearchResult

class SearchResult : Parcelable

Resolved search object with populated fields.

Functions

describeContents

abstract fun describeContents(): Int

writeToParcel

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

Properties

accuracy

val accuracy: ResultAccuracy?

A point accuracy metric for the returned address.

address

val address: SearchAddress?

Result address.

categories

val categories: List<String>?

Poi categories.

coordinate

val coordinate: Point

Result coordinates.

descriptionText

val descriptionText: String?

Additional description for the search result.

distanceMeters

val distanceMeters: Double?

Distance in meters from result to requested origin (for forward geocoding and category search) or provided point (for reverse geocoding).

etaMinutes

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

val externalIDs: Map<String, String>

Map of external ids.

fullAddress

val fullAddress: String?

Full formatted address.

val id: String

Result unique identifier.

indexableRecord

val indexableRecord: IndexableRecord?

Returns IndexableRecord if this SearchResult is based on item from com.mapbox.search.record.IndexableDataProvider, null otherwise.

makiIcon

val makiIcon: String?

Maki icon name for search result.

matchingName

val matchingName: String?

The feature name, as matched by the search algorithm.

metadata

val metadata: SearchResultMetadata?

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

name

val name: String

Result name.

requestOptions

val requestOptions: RequestOptions

Search request options.

routablePoints

val routablePoints: List<RoutablePoint>?

List of points near coordinate, that represents entries to associated building.

serverIndex

val serverIndex: Int?

Index in response from server.

types

val types: List<SearchResultType>

Non-empty list of resolved SearchResult types.