navigation-ux-ipc-client-core/com.mapbox.dash.sdk.ipc.client.core.model/SearchResult

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 isOffline: Boolean, val metadata: SearchResultMetadata?, val evStationId: String? = null, val isTransient: Boolean) : 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

SearchResult

constructor(id: String, coordinate: Point, address: Address?, name: String, customName: String?, type: String, categoryIds: List<String>?, description: String?, distanceMeters: Double?, isOffline: Boolean, metadata: SearchResultMetadata?, evStationId: String? = null, isTransient: Boolean)

Properties

address

val address: Address?

The address of the search result.

categoryIds

val categoryIds: List<String>?

The category IDs of the search result.

coordinate

val coordinate: Point

The coordinate of the search result.

customName

val customName: String?

The custom name of the search result.

description

val description: String?

The description of the search result.

distanceMeters

val distanceMeters: Double?

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

evStationId

val evStationId: String? = null

The ID of the EV charging station, not null if this SearchResult is a charging station.

val id: String

Unique ID.

isOffline

val isOffline: Boolean

Defines if search was executed by offline.

isTransient

val isTransient: Boolean

Indicates that the item was not explicitly requested by the user and may have been added automatically by the system (for example, a charging station). Filter out items with isTransient == true if you only want entries that were added by the user.

metadata

val metadata: SearchResultMetadata?

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

name

val name: String

The name of the search result.

type

val type: String

Type of the search result.

Functions

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String