NavigationSnapshot
data class NavigationSnapshot(val activeRoute: ActiveRoute?, val alternativeRoutes: List<RoutePlan>, 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 waypointSnapshot: NavigationWaypointSnapshot, val projectedRoutes: List<ProjectedRoute>, val vehicle: Vehicle?, val unitSystem: UnitSystem = UnitSystem.METRIC)
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.
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.
waypointSnapshot
Snapshot of the waypoints state in the navigation session.
projectedRoutes
A list of projected routes.
vehicle
Specifies the current active vehicle profile, if set.
unitSystem
UnitSystem.
Constructors
Link copied to clipboard
fun NavigationSnapshot(activeRoute: ActiveRoute?, alternativeRoutes: List<RoutePlan>, isGuidanceAvailable: Boolean, location: GeoLocation, mapMatchingResult: MapMatchingResult, locationContext: LocationContext, routeProgress: RouteProgress, history: NavigationHistorySnapshot, hasRouteDeviated: Boolean, hasReachedDestination: Boolean, currentInstructionId: UniqueId?, waypointSnapshot: NavigationWaypointSnapshot, projectedRoutes: List<ProjectedRoute>, vehicle: Vehicle?, unitSystem: UnitSystem = UnitSystem.METRIC)
Properties
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard