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

AlongRouteResult

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.

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

Parameters

searchResultId

The ID of the search result. Can be used to obtain an additional data.

poi

The detailed information about the Point Of Interest.

position

The geographical position of the Point Of Interest.

distance

Distance from the provided route.

address

The detailed address of the Point Of Interest.

entryPoints

The entrances to the Point Of Interest.

detourDuration

The detour duration for a passenger car in seconds. The detour duration is the value added to the estimated time of arrival (to the final destination), after a point of interest has been added to the route. If the route that passes through the found point is faster than the original one, the detour duration value is negative.

detourDistance

The detour Distance is the added value to the route length, after a point of interest has been added to the route. If the route that passes through the found point is shorter than the original one, the detour distance value is negative.

detourOffset

The length of the route part from the starting point to the detour starting point.

chargingPark

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

Constructors

AlongRouteResult

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