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

SearchResult

data class SearchResult( val type: String, val id: String, val score: Double, val distance: Double, val info: String = "", val entityType: EntityType?, val poi: Poi?, val relatedPois: List<RelatedPoi> = emptyList(), val address: Address?, val position: GeoCoordinate, val mapCodes: List<MapCode> = emptyList(), val viewport: GeoBoundingBox?, val boundingBox: GeoBoundingBox?, val entryPoints: List<EntryPoint> = emptyList(), val addressRanges: AddressRanges?, val chargingPark: ChargingPark?, val dataSources: AdditionalDataSources?)

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

Parameters

type

The type of result.

The ID of the result.

score

The score of the result.

distance

Distance from the provided route.

info

Additional information.

entityType

(Only for results of type "Geography") EntityType the type of the entity.

poi

Information about the Point Of Interest.

relatedPois

List of related Points Of Interest.

address

The detailed address of the result.

position

The geographical position of the Point Of Interest.

mapCodes

A list of MapCode objects.

viewport

The viewport.

boundingBox

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.

entryPoints

A list of entrances to the Point Of Interest.

addressRanges

Address ranges on a street segment. Only available for results where the result type is equal to "Address Range".

chargingPark

Present only when the Points of Interest are of the Electric Vehicle Station type.

dataSources

Information about the sources of additional data that can be used with the Additional Data service.

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

Constructors

SearchResult

fun SearchResult( type: String, id: String, score: Double, distance: Double, info: String = "", entityType: EntityType?, poi: Poi?, relatedPois: List<RelatedPoi> = emptyList(), address: Address?, position: GeoCoordinate, mapCodes: List<MapCode> = emptyList(), viewport: GeoBoundingBox?, boundingBox: GeoBoundingBox?, entryPoints: List<EntryPoint> = emptyList(), addressRanges: AddressRanges?, chargingPark: ChargingPark?, dataSources: AdditionalDataSources?)