com.tomtom.sdk.search:search/com.tomtom.sdk.search.model.result/SearchResult

SearchResult

data class SearchResult(val type: SearchResultType, val searchResultId: SearchResultId, val place: Place, val distance: Distance? = null, val poi: Poi? = null, val boundingBox: GeoBoundingBox? = null, val detour: Detour? = null)

Describes the details of a single result item returned by the Search API.

Constructors

constructor(type: SearchResultType, searchResultId: SearchResultId, place: Place, distance: Distance? = null, poi: Poi? = null, boundingBox: GeoBoundingBox? = null, detour: Detour? = null)

Properties

val boundingBox: GeoBoundingBox? = null

A rectangle into which the shape of an administrative area is inscribed. Provided only if type is set to SearchResultType.Area.

val detour: Detour? = null

The detailed information about detour which should be taken to reach the search result position.

val distance: Distance? = null

Distance from the provided route.

val place: Place

The place information of the search result.

val poi: Poi? = null

Information about the Point Of Interest.

val searchResultId: SearchResultId

The ID of the result.

val type: SearchResultType

The type of result.