navigation:engine/com.tomtom.sdk.navigation

Package-level declarations

Types

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

ActiveRoute class contains an active RoutePlan, and a better proposal RoutePlan. Better proposal RoutePlan can be null.

data class NavigationConfiguration constructor(val context: Context, val apiKey: String, val locationProvider: LocationProvider, val routeReplanner: RouteReplanner, val mapMatchingEngine: MapMatchingEngine = LegacyMapMatchingEngineFactory.create(context), val horizonEngine: HorizonEngine? = null, val guidanceEngine: GuidanceEngine = GuidanceEngineFactory.createStaticGuidanceEngine( context, GuidanceEngineOptions() ), val routeTrackingEngine: RouteTrackingEngine = RouteTrackingEngineFactory.create(context), val routeProgressEngine: RouteProgressEngine = RouteProgressEngineFactory.create(), val routeProjectionEngine: RouteProjectionEngine? = null, val locationContextProviderEngine: LocationContextProviderEngine = LegacyLocationContextProviderEngineFactory.create(context), val arrivalDetectionEngine: ArrivalDetectionEngine = DefaultArrivalDetectionEngineFactory.create(), val routeReplanningEngine: RouteReplanningEngine = RouteReplanningEngineFactory.create(routeReplanner), val replanningRetryPolicy: ReplanningRetryPolicy = TomTomReplanningRetryPolicy(), val continuousReplanningMode: ContinuousReplanningMode = ContinuousReplanningMode.Manual, val deviationReplanningMode: DeviationReplanningMode = DeviationReplanningMode.Automatic, val maintainRoutesMode: MaintainRoutesMode = MaintainRoutesMode.ActiveRouteOnly, val apiPath: URI? = null, val apiKeyParamName: String? = null, val navigationProcessingThrottle: Duration = DEFAULT_LOCATION_UPDATE_THROTTLE, val telemetry: Telemetry? = null)

Configuration of the Navigation SDK.

NavigationController

interface NavigationController : AutoCloseable

Responsible for interacting with and customizing a navigation.

NavigationError

open class NavigationError

Represents an error raised when something went wrong in navigation.

NavigationHistorySnapshot

data class NavigationHistorySnapshot(val visitedRouteCoordinates: List<RouteCoordinate>)

Navigation history is a structure containing info regarding the passed history of the route, such as visited polyline points (route coordinates).

NavigationOptions

data class NavigationOptions(val activeRoutePlan: RoutePlan)

NavigationOptions encapsulate options for starting navigation.

NavigationSnapshot

data class NavigationSnapshot(val activeRoute: ActiveRoute?, val alternativeRoutes: List<RoutePlan>, val routes: List<Route>, 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, val projectedRoutes: List<ProjectedRoute>, val vehicle: Vehicle?, val unitSystem: UnitSystem = UnitSystem.METRIC)

Read-only snapshot of the current navigation session.

NavigationStartError

class NavigationStartError : NavigationError

Returned when an error occurred during initialization of the underlying services.

NavigationWaypointSnapshot

data class NavigationWaypointSnapshot(val nextWaypoint: Waypoint?, val numberOfVisitedWaypoints: Int)

Read-only snapshot of the waypoints in the current navigation session.

OnDestinationReachedListener

fun interface OnDestinationReachedListener

Used to inform caller about the arrival at the destination.

OnGuidanceUpdateListener

interface OnGuidanceUpdateListener

Used to inform caller about guidance.

OnHorizonUpdatedListener

fun interface OnHorizonUpdatedListener

Used to inform caller that a new horizon snapshot is available.

OnLaneGuidanceUpdateListener

interface OnLaneGuidanceUpdateListener

Used to inform caller about lane guidance.

OnLocationContextUpdateListener

fun interface OnLocationContextUpdateListener

Used to inform caller about detailed information in current location on road.

OnLocationMatchedListener

fun interface OnLocationMatchedListener

Used to inform caller that current location has been matched to the road.

OnLocationPredictionsGeneratedListener

fun interface OnLocationPredictionsGeneratedListener

Used to inform caller that new predictions has been generated.

OnNavigationErrorListener

fun interface OnNavigationErrorListener

Used to inform caller about errors during navigating. Can be registered with TomTomNavigation.addOnNavigationErrorListener.

OnNavigationStartedListener

fun interface OnNavigationStartedListener

Used to inform caller that navigation has been started.

OnProgressUpdateListener

fun interface OnProgressUpdateListener

Used to inform caller about progress on Route.

OnReplannedRouteProposedListener

interface OnReplannedRouteProposedListener

Informs about new ReplannedRoute when ContinuousReplanningMode is set to ContinuousReplanningMode.Manual or ContinuousReplanningMode.UnreachableOnly in NavigationConfiguration.

OnRouteDeviationListener

fun interface OnRouteDeviationListener

Used to inform caller about getting off the route.

OnRoutesChangedListener

fun interface OnRoutesChangedListener

Used to inform the caller that the set of routes in the navigation session. has changed. Can be registered with TomTomNavigation.addOnRoutesChangedListener.

OnRouteUpdatedListener

fun interface OnRouteUpdatedListener

Used to inform caller that the route has been updated.

OnWaypointVisitedListener

fun interface OnWaypointVisitedListener

Used to inform a caller that the waypoint has been visited.

PublicPreviewNavigationApi

annotation class PublicPreviewNavigationApi

RoutePlan