Package-level declarations

Types

data class ActiveRoute(val routePlan: RoutePlan, val proposedRoutePlan: RoutePlan?)

ActiveRoute class contains an active RoutePlan and an optional RoutePlan proposal.

class ConfigurationSnapshot(val unitSystem: UnitSystem = UnitSystem.Metric, val language: Locale = Locale.ENGLISH)

Snapshot of the current navigation configuration.

class DrivingHistorySnapshot(val drivenPath: List<RoutePoint> = emptyList())

A structure containing information about things in the route that the driver has already passed, such as visited locations and driven distance.

data class LocationSnapshot(val rawLocation: GeoLocation, val mapMatchingResult: MapMatchingResult, val locationContext: LocationContext)

Snapshot of current location information during navigation.

data class NavigationSnapshot(val locationSnapshot: LocationSnapshot, val historySnapshot: DrivingHistorySnapshot, val configurationSnapshot: ConfigurationSnapshot, val vehicleProfile: Vehicle = Vehicle.Car(), val tripSnapshot: TripSnapshot? = null)

Snapshot of the current navigation session.

class RoutePlan(val route: Route, val routePlanningOptions: RoutePlanningOptions)

Defines parameters required for a single route in navigation session.

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

Snapshot of the current route.

data class TripSnapshot(val activeRoute: RouteSnapshot, val betterProposal: RouteSnapshot? = null, val hasDeviated: Boolean = false, val hasReachedDestination: Boolean = false)

A structure containing information about the route.