NavigationSnapshot

data class NavigationSnapshot(    val activeRoute: ActiveRoute?,     val alternativeRoutes: List<RoutePlan>,     val routes: List<Route>,     val routeCreationTime: Long,     val isGuidanceAvailable: Boolean,     val location: GeoLocation,     val mapMatchingResult: MapMatchingResult,     val locationContext: LocationContext,     val routeProgress: RouteProgress,     val history: NavigationHistorySnapshot,     val hasRouteDeviated: Boolean,     val hasReachedDestination: Boolean,     val currentInstructionId: UniqueId?,     val proposedRoute: ReplannedRoute?,     val waypointSnapshot: NavigationWaypointSnapshot)

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

activeRoute

ActiveRoute class contains an active RoutePlan, and a better proposal RoutePlan.

alternativeRoutes

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.

history

Sequence of visited locations with travel times and distances from the departure

hasRouteDeviated

Indicator of route deviated.

hasReachedDestination

Indicates if the destination has been reached.

currentInstructionId

Current instruction object.

proposedRoute

Describes the route after replanning.

waypointSnapshot

Snapshot of the waypoints state in the navigation session.

Constructors

Link copied to clipboard
fun NavigationSnapshot(    activeRoute: ActiveRoute?,     alternativeRoutes: List<RoutePlan>,     routes: List<Route>,     routeCreationTime: Long,     isGuidanceAvailable: Boolean,     location: GeoLocation,     mapMatchingResult: MapMatchingResult,     locationContext: LocationContext,     routeProgress: RouteProgress,     history: NavigationHistorySnapshot,     hasRouteDeviated: Boolean,     hasReachedDestination: Boolean,     currentInstructionId: UniqueId?,     proposedRoute: ReplannedRoute?,     waypointSnapshot: NavigationWaypointSnapshot)

Properties

Link copied to clipboard
val activeRoute: ActiveRoute?
Link copied to clipboard
val alternativeRoutes: List<RoutePlan>
Link copied to clipboard
val currentInstructionId: UniqueId?
Link copied to clipboard
val hasReachedDestination: Boolean
Link copied to clipboard
val hasRouteDeviated: Boolean
Link copied to clipboard
val history: NavigationHistorySnapshot
Link copied to clipboard
val isGuidanceAvailable: Boolean
Link copied to clipboard
val location: GeoLocation
Link copied to clipboard
val locationContext: LocationContext
Link copied to clipboard
val mapMatchingResult: MapMatchingResult
Link copied to clipboard
val proposedRoute: ReplannedRoute?
Link copied to clipboard
val routeCreationTime: Long
Link copied to clipboard
val routeProgress: RouteProgress
Link copied to clipboard
val routes: List<Route>
Link copied to clipboard
val waypointSnapshot: NavigationWaypointSnapshot