sdk-search / com.tomtom.online.sdk.search.data.alongroute / AlongRouteSearchResult

AlongRouteSearchResult

open class AlongRouteSearchResult : Serializable

The result of an Along Route Search query.

Constructors

AlongRouteSearchResult()

The result of an Along Route Search query.

Properties

additionalDataSources	`var additionalDataSources: AdditionalDataSources!` Information about the sources of additional data that can be used with the Additional Data service.
address	`var address: Address!` Detailed address of the result.
detourOffset	`var detourOffset: Int!` Detour offset in meters.
detourTime	`var detourTime: Int` The time it takes to reach the POI from the closest point on the route.
distance	`var distance: Double` The distance from the route provided in the request.
entryPoints	`var entryPoints: Array<EntryPoint!>!` A list of entrances to the POI.
id	`var id: String!` The id of the result.
info	`var info: String!` Additional info.
mapCodes	`var mapCodes: Array<MapCode!>!` A list of MapCode objects.
poi	`var poi: Poi!` Information about the POI.
position	`var position: LatLng!` The geographical position of the POI.
relatedPois	`var relatedPois: Array<RelatedPoi!>!` A list of RelatedPoi objects.
score	`var score: Double` The score of the result.
type	`var type: String!` The type of result (should always be "POI").
viewport	`var viewport: BoundingBox!` The viewport.

Functions

getAdditionalDataSources	`open fun getAdditionalDataSources(): AdditionalDataSources!` Returns information about the sources of additional data.
getAddress	`open fun getAddress(): Address!` Returns a detailed address of the result.
getDetourOffset	`open fun getDetourOffset(): Int!` Returns a detour offset in meters.
getDetourTime	`open fun getDetourTime(): Int` Returns the time it takes to reach the POI from the closest point on the route.
getDistance	`open fun getDistance(): Double` Returns the distance from the route provided in the request.
getEntryPoints	`open fun getEntryPoints(): Array<EntryPoint!>!` Returns a list of entrances to the POI.
getId	`open fun getId(): String!` Returns the id of the result.
getInfo	`open fun getInfo(): String!` Returns additional info.
getMapCodes	`open fun getMapCodes(): ImmutableList<MapCode!>!`
getPoi	`open fun getPoi(): Poi!` Returns information about the POI.
getPosition	`open fun getPosition(): LatLng!` Returns the geographical position of the POI.
getRelatedPois	`open fun getRelatedPois(): ImmutableList<RelatedPoi!>!`
getScore	`open fun getScore(): Double` Returns the score of the result.
getType	`open fun getType(): String!` Returns the type of result (should always be "POI").
getViewport	`open fun getViewport(): BoundingBox!` Returns the viewport.
toString	`open fun toString(): String`