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

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

Types

data class AlongRouteResult( val searchResultId: SearchResultId, val poi: Poi, val position: GeoCoordinate, val distance: Distance? = null, val address: Address? = null, val entryPoints: Set<EntryPoint> = emptySet(), val detourDuration: Duration? = null, val detourDistance: Distance? = null, val detourOffset: Distance? = null, val chargingPark: ChargingPark? = null)

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

AutocompleteResult

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

Contains a list of results returned by the Autocomplete engine.

AutoCompleteResultType

@JvmInline

value class AutoCompleteResultType

The type of autocomplete result.

AutocompleteSegment

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.

SearchResult

data class SearchResult( val type: ResultType, val searchResultId: SearchResultId, val position: GeoCoordinate, val distance: Distance? = null, val poi: Poi? = null, val address: Address? = null, val boundingBox: GeoBoundingBox? = null, val entryPoints: List<EntryPoint> = emptyList(), val chargingPark: ChargingPark? = null)

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

SearchResultId

data class SearchResultId( val id: String, val source: Source, val fuelPriceId: String = "", val evConnectorAvailabilityId: String = "", val parkingInformationId: String = "", val geometryDataSourceId: String = "")

Identifier that represents the search result.

Source

@JvmInline

value class Source

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