sdk/com.mapbox.search.result/SearchResult

SearchResult

class SearchResult : Parcelable

Resolved search object with populated fields.

Functions

describeContents

abstract fun describeContents(): Int

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

Properties

val accuracy: ResultAccuracy?

A point accuracy metric for the returned address.

val address: SearchAddress?

Result address.

val categories: List<String>?

Poi categories. Always empty for non-POI search results.

val coordinate: Point

Result coordinates.

descriptionText

val descriptionText: String?

Additional description for the search result.

val distanceMeters: Double?

Distance in meters from result to requested origin (for forward geocoding and category search) or provided point (for reverse geocoding). For provided point always returns non-null distance.

val etaMinutes: Double?

Estimated time of arrival (in minutes) based on the specified in the com.mapbox.search.SearchOptions origin point and navigation profile. For com.mapbox.search.result.SearchResult this property is not null only if it was present in the corresponding com.mapbox.search.result.SearchSuggestion.

val externalIDs: Map<String, String>

Map of external ids. Returned Map instance is unmodifiable.

val fullAddress: String?

Full formatted address.

Result unique identifier.

indexableRecord

val indexableRecord: IndexableRecord?

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

val makiIcon: String?

Maki icon name for search result.

val mapboxId: String?

Result MapboxID

val matchingName: String?

The feature name, as matched by the search algorithm.

val metadata: SearchResultMetadata?

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

val name: String

Result name.

val requestOptions: RequestOptions

Search request options.

val routablePoints: List<RoutablePoint>?

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

val serverIndex: Int?

Index in response from server.

val types: List<SearchResultType>

Non-empty list of resolved SearchResult types.