NavigationSnapshot

data class NavigationSnapshot( val trip: Trip, val routes: List<Route>, val routeCreationTime: Long, val isGuidanceAvailable: Boolean, val location: GeoLocation, val mapMatchingResult: MapMatchingResult, val locationContext: LocationContext, val routeProgress: RouteProgress, val hasRouteDeviated: Boolean, val hasReachedDestination: Boolean, val currentInstructionId: UniqueId? = null, val proposedRoute: ReplannedRoute? = null, val nextWaypoint: Waypoint? = null)

Read-only snapshot of the current navigation session.

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

Parameters

trip

Trip class contains an active RoutePlan, and a list of alternative RoutePlan

routes

List of routes.

routeCreationTime

Current route's creation timestamp.

isGuidanceAvailable

Indicator of guidance availability.

location

Current location.

mapMatchingResult

Current map-matching result.

routeProgress

Represents current progress along the route.

hasRouteDeviated

Indicator of route deviated.

hasReachedDestination

Indicates if the destination has been reached.

currentInstructionId

Current instruction object.

proposedRoute

Describes the route after replanning.

nextWaypoint

The Waypoint, which the user currently navigates to or null if none.

fun NavigationSnapshot( trip: Trip, routes: List<Route>, routeCreationTime: Long, isGuidanceAvailable: Boolean, location: GeoLocation, mapMatchingResult: MapMatchingResult, locationContext: LocationContext, routeProgress: RouteProgress, hasRouteDeviated: Boolean, hasReachedDestination: Boolean, currentInstructionId: UniqueId? = null, proposedRoute: ReplannedRoute? = null, nextWaypoint: Waypoint? = null)