RouteSnapshot

data class RouteSnapshot(val routePlan: RoutePlan, val projection: ProjectedRoute? = null, val numberOfVisitedWaypoints: Int = 0, val nextWaypoint: RouteStop? = null, val routeProgress: RouteProgress = RouteProgress(), val isFollowed: Boolean = true, val waypointArrivalHistory: List<WaypointArrivalStatus> = emptyList())

Snapshot of the current route.

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

Parameters

routePlan

Active RoutePlan.

projection

Projected route ProjectedRoute.

numberOfVisitedWaypoints

The number of waypoints already visited on the current route.

nextWaypoint

The RouteStop the user is currently navigating to, or null if the user is navigating directly to the destination.

waypointArrivalHistory

List of WaypointArrivalStatus published by the arrival engine.

routeProgress

Current progress along the route.

isFollowed

Indicates if the route is being followed.

Constructors

Link copied to clipboard
constructor(routePlan: RoutePlan, projection: ProjectedRoute? = null, numberOfVisitedWaypoints: Int = 0, nextWaypoint: RouteStop? = null, routeProgress: RouteProgress = RouteProgress(), isFollowed: Boolean = true, waypointArrivalHistory: List<WaypointArrivalStatus> = emptyList())

Properties

Link copied to clipboard
val isFollowed: Boolean = true
Link copied to clipboard
val nextWaypoint: RouteStop? = null
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard