Route
data class Route(val id: RouteId, val summary: Summary, val legs: List<RouteLeg>, val routeStops: List<RouteStop>, val sections: Sections, val modificationHistory: RouteModificationHistory, val routeCoordinates: List<RouteCoordinate> = emptyList(), val forkPoints: List<ForkPoint> = emptyList(), val incrementEndOffset: Distance = Distance.ZERO)
The route class contains the route to be navigated, including geometry and generated guidance messages.
Important: This is a Public Preview API. It may be changed or removed at any time.
Parameters
id
Unique ID.
summary
A collection of data fields representing the properties of the route.
legs
List of route legs.
routeStops
List containing every route stop along the route, including origin and destination.
sections
Information about sections of the route.
modificationHistory
Information about route creation and last route update.
routeCoordinates
Optional extended representation of the route.
forkPoints
List containing fork points with other routes.
incrementEndOffset
Position where the last increment generation has ended or 0 if the first increment is being requested.
Constructors
Link copied to clipboard
fun Route(id: RouteId, summary: Summary, legs: List<RouteLeg>, routeStops: List<RouteStop>, sections: Sections, modificationHistory: RouteModificationHistory, routeCoordinates: List<RouteCoordinate> = emptyList(), forkPoints: List<ForkPoint> = emptyList(), incrementEndOffset: Distance = Distance.ZERO)