search:search-client-api/com.tomtom.sdk.search.model.result

Package-level declarations

Types

data class AlongRouteResult(val searchResultId: SearchResultId, val poi: Poi, val position: GeoPoint, val distance: Distance? = null, val address: Address? = null, val detourDuration: Duration? = null, val detourDistance: Distance? = null, val detourOffset: Distance? = null)

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

data class AutocompleteResult(val segments: List<AutocompleteSegment> = emptyList())

Contains a list of results returned by the Autocomplete engine.

The type of autocomplete result.

data class AutocompleteSegment(val type: AutocompleteMatchType, val category: Category? = null, val brand: Brand? = null, val plainText: 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.

data class SearchResult(val type: ResultType, val searchResultId: SearchResultId, val position: GeoPoint, val distance: Distance? = null, val poi: Poi? = null, val address: Address? = null, val boundingBox: GeoBoundingBox? = null)

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

data class SearchResultId(val id: String, val source: Source, val fuelPriceId: FuelPriceId? = null, val evChargingAvailabilityId: EvChargingAvailabilityId? = null, val parkingInformationId: ParkingInformationId? = null, val geometryId: GeometryId? = null)

Identifier that represents the search result.

value class Source

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