search:search-client-api/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.

Important: This is a Public Preview API. It may be changed or removed at any time.

Constructors

SearchResult

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

Properties

boundingBox

val boundingBox: GeoBoundingBox? = null

A rectangle into which the shape of an administrative area is inscribed. Only available for results where the result type is equal to "Geography", and municipality information is not present.

detour

val detour: Detour? = null

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

distance

val distance: Distance? = null

Distance from the provided route.

place

val place: Place

The place information of the search result.

poi

val poi: Poi? = null

Information about the Point Of Interest.