SearchResult

class SearchResult : Parcelable

Resolved search object with populated fields.

Functions

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

Properties

accuracy
Link copied to clipboard
val accuracy: ResultAccuracy?
A point accuracy metric for the returned address.
address
Link copied to clipboard
val address: SearchAddress?
Result address.
categories
Link copied to clipboard
val categories: List<String>?
Poi categories.
coordinate
Link copied to clipboard
val coordinate: Point
Result coordinates.
descriptionText
Link copied to clipboard
val descriptionText: String?
Additional description for the search result.
distanceMeters
Link copied to clipboard
val distanceMeters: Double?
Distance in meters from result to requested origin (for forward geocoding and category search) or provided point (for reverse geocoding).
etaMinutes
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.
externalIDs
Link copied to clipboard
val externalIDs: Map<String, String>
Map of external ids.
fullAddress
Link copied to clipboard
val fullAddress: String?
Full formatted address.
id
Link copied to clipboard
val id: String
Result unique identifier.
indexableRecord
Link copied to clipboard
val indexableRecord: IndexableRecord?
Returns IndexableRecord if this SearchResult is based on item from com.mapbox.search.record.IndexableDataProvider, null otherwise.
makiIcon
Link copied to clipboard
val makiIcon: String?
Maki icon name for search result.
matchingName
Link copied to clipboard
val matchingName: String?
The feature name, as matched by the search algorithm.
metadata
Link copied to clipboard
val metadata: SearchResultMetadata?
Search result metadata containing geo place's detailed information if available.
name
Link copied to clipboard
val name: String
Result name.
requestOptions
Link copied to clipboard
val requestOptions: RequestOptions
Search request options.
routablePoints
Link copied to clipboard
val routablePoints: List<RoutablePoint>?
List of points near coordinate, that represents entries to associated building.
serverIndex
Link copied to clipboard
val serverIndex: Int?
Index in response from server.
types
Link copied to clipboard
val types: List<SearchResultType>
Non-empty list of resolved SearchResult types.