SearchResult

class SearchResult(val id: String, val coordinate: Point, val address: Address?, val name: String, val customName: String?, val type: String, val categoryIds: List<String>?, val description: String?, val distanceMeters: Double?, val etaMinutes: Double?, val isOffline: Boolean, val metadata: SearchResultMetadata?) : SearchItem

Represents a place on a map that the user can navigate to. Must not necessary be instantiated by Mapbox, can also be created on the client side to convert 3rd-party search results into Mapbox format to then navigate to them.

Constructors

Link copied to clipboard
constructor(id: String, coordinate: Point, address: Address?, name: String, customName: String?, type: String, categoryIds: List<String>?, description: String?, distanceMeters: Double?, etaMinutes: Double?, isOffline: Boolean, metadata: SearchResultMetadata?)

Properties

Link copied to clipboard

The address of the search result.

Link copied to clipboard

The category IDs of the search result.

Link copied to clipboard

The coordinate of the search result.

Link copied to clipboard

The custom name of the search result.

Link copied to clipboard

The description of the search result.

Link copied to clipboard

The distance in meters from the search result to the user location.

Link copied to clipboard

The estimated time of arrival in minutes from the search result to the user location.

Link copied to clipboard
val id: String

Unique ID.

Link copied to clipboard

Defines if search was executed by offline.

Link copied to clipboard

The metadata of the search result. Can be used to store additional information.

Link copied to clipboard

The name of the search result.

Link copied to clipboard

Type of the search result.

Functions

Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String