Package com.tomtom.sdk.search.client.model.result

Types

Link copied to clipboard
data class AlongRouteResult(    val id: SearchResultId,     val poi: Poi,     val distance: Distance? = null,     val address: Address? = null,     val position: GeoCoordinate? = null,     val viewport: GeoBoundingBox? = null,     val entryPoints: Set<EntryPoint> = emptySet(),     val detourTime: Duration? = null,     val detourDistance: Distance? = null,     val detourOffset: Int? = null,     val chargingPark: EvChargingPark? = null)

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

Link copied to clipboard
data class AutocompleteResults(val segments: List<AutocompleteSegment> = emptyList())

Contains a list of results returned by the Autocomplete engine.

Link copied to clipboard
data class AutocompleteSegment(    val type: AutocompleteMatchType,     val value: String,     val id: String = "",     val matchedAlternativeName: String = "")

Describes an entity found within the autocomplete search term. An entity is a distinct part of the search term that can be used to generate a query.

Link copied to clipboard
data class SearchResult(    val type: SearchResultType,     val id: SearchResultId,     val distance: Distance? = null,     val poi: Poi? = null,     val address: Address? = null,     val position: GeoCoordinate,     val mapCodes: List<MapCode> = emptyList(),     val boundingBox: GeoBoundingBox? = null,     val entryPoints: List<EntryPoint> = emptyList(),     val chargingPark: EvChargingPark? = null)

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

Link copied to clipboard
data class SearchResultId(    val id: String,     val source: Source,     val fuelPriceDataSourceId: String = "",     val evConnectorAvailabilityDataSourceId: String = "",     val parkingAvailabilityDataSourceId: String = "",     val geometryDataSourceId: String = "")

Represents the search result.

Link copied to clipboard
value class Source

The source of the result can be either the onboard NDS map or the remote online service.