navigation-ux-search-api/com.mapbox.dash.sdk.search.api/DashFavoriteSearchResult

DashFavoriteSearchResult

interface DashFavoriteSearchResult : DashSearchResult

A favorite record.

See also

@DashFavoriteType.Type for favorite types.

Properties

abstract val address: DashAddress?

The address of the search result.

abstract val categories: List<String>?

The categories of the search result.

abstract val categoryIds: List<String>?

The ids of the categories of the search result.

abstract val coordinate: Point

The coordinate of the search result.

abstract val customName: String?

The custom name of the search result.

abstract val description: String?

The description of the search result.

abstract val distanceMeters: Double?

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

abstract val etaMinutes: Double?

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

abstract val favoriteType: String?

abstract val id: String

Unique identifier for search record.

isChargingAvailable

open val isChargingAvailable: Boolean

True when the user can charge the car at this favorite. For a route to this favorite the charge planner then uses the minimum charge at a charging station as the minimum charge at arrival.

abstract val mapboxId: String?

Unique and stable identifier for search record.

abstract val metadata: Map<String, String>?

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

abstract val name: String

The name of the search result.

abstract val pinCoordinate: Point

The pin coordinate of the search result. This is used to display the pin on the map. Can be null or the same as coordinate.

abstract val routablePoints: List<RoutablePoint>?

Represent entries to the building, associated with original search result.

abstract val type: String

Type of the search result. see DashSearchResultType.Type