TomTomNavigation

Responsible for interacting with and customizing a navigation.

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

Properties

Link copied to clipboard

Controls how the route deviations are handled. When the deviation is detected the RouteTrackingStateUpdatedListener provides a RouteTrackingState with a RouteTrackingState.hasDeviated property set to true.

Link copied to clipboard
abstract val language: Locale

The current language used within TomTomNavigation in guidance instructions and announcement language.

Link copied to clipboard

The LocationProvider used by the TomTomNavigation for providing location updates to the navigation.

Link copied to clipboard

Provides access to current registered engines and allows updating them.

Link copied to clipboard

The current NavigationSnapshot. Can be null when navigation is not yet started or already stopped.

Link copied to clipboard

The preferred language to be used within TomTomNavigation in guidance instructions and announcement language.

Link copied to clipboard

UnitSystem to be used within TomTomNavigation.

Link copied to clipboard

The VehicleProvider used by the TomTomNavigation for providing vehicle updates to the navigation.

Functions

Link copied to clipboard

Adds an ActiveRouteChangedListener which reports that a new active route has been set.

Link copied to clipboard

Adds a DestinationArrivalListener. The listener will be notified when the ArrivalDetectionEngine successfully detects destination arrival.

Link copied to clipboard

Registers a GuidanceUpdatedListener that informs about new Guidance instances. This is triggered whenever there is a change in location and the GuidanceEngine successfully generates a new Guidance.

Link copied to clipboard

Adds a HorizonUpdatedListener for a specific set of horizon options. The listener will be notified about updates to the horizon snapshot and the horizon position that are generated for these options.

Link copied to clipboard

Registers a LaneGuidanceUpdatedListener to observe and handle new LaneGuidance instances. This is triggered whenever there is a change in location and the GuidanceEngine successfully generates a new lane guidance.

Link copied to clipboard

Adds a LanguageChangedListener, that reports on changes to the navigation language.

Link copied to clipboard

Adds a LocationContextUpdatedListener. The listener will be notified with location context data for the current location.

Link copied to clipboard

Adds an LocationMapMatchedListener which will inform about new MapMatchingResult each time a location change occurs and the MapMatchingEngine successfully matches it.

Link copied to clipboard

Adds an NavigationFailureListener which will inform about failures that occurred during navigating.

Link copied to clipboard

Adds an NavigationStartedListener which will inform about successful navigation start.

Link copied to clipboard

Adds an ProgressUpdatedListener which will inform about new progress along the route each time a location update occurs and the RouteProgressEngine successfully calculates it.

Link copied to clipboard

Adds a RouteAddedListener that reports on the new Route added to the navigation session.

Link copied to clipboard

Adds a RouteRemovedListener that reports on the Route being removed from the navigation session.

Link copied to clipboard

Adds an RoutesChangedListener which will inform about any change to the set of routes in the navigation session.

Link copied to clipboard

Adds an RouteUpdatedListener which will inform about successful update of the Route.

Link copied to clipboard

Adds a WaypointArrivalListener. The listener will be notified when the ArrivalDetectionEngine successfully detects a waypoint arrival or departure.

Link copied to clipboard
abstract fun departFromWaypoint(waypoint: RouteStop)

Marks a departure from the given waypoint independently from ArrivalDetectionEngine.hasArrivedAtWaypoint.

Link copied to clipboard

Removes a previously registered ActiveRouteChangedListener.

Link copied to clipboard
Link copied to clipboard

Unregisters a previously registered GuidanceUpdatedListener. This method allows you to stop receiving updates about guidance changes.

Link copied to clipboard

Removes a previously added HorizonUpdatedListener.

Link copied to clipboard

Unregisters a previously registered LaneGuidanceUpdatedListener. This method allows you to stop receiving updates about lane guidance changes.

Link copied to clipboard

Removes previously registered LanguageChangedListener.

Link copied to clipboard

Removes previously registered LocationMapMatchedListener.

Link copied to clipboard

Removes previously registered NavigationFailureListener.

Link copied to clipboard

Removes previously registered NavigationStartedListener.

Link copied to clipboard

Removes previously registered ProgressUpdatedListener.

Link copied to clipboard

Removes a previously registered RouteAddedListener.

Link copied to clipboard

Removes a previously registered RouteRemovedListener.

Link copied to clipboard

Removes previously registered RoutesChangedListener.

Link copied to clipboard

Removes previously registered RouteUpdatedListener.

Link copied to clipboard

Removes a previously registered WaypointArrivalListener.

Link copied to clipboard
abstract fun selectActiveRoute(routeId: RouteId)

Selects the Route with provided RouteId as active. The navigation will switch to navigate along the desired route and the RouteUpdatedListener will be notified. If the route corresponding to the given routeId is not available, the NavigationFailureListener will be triggered with the RouteUpdateFailure.

Link copied to clipboard
abstract fun start()

Starts navigation without a Route. In this case navigation will just provide a MapMatchingResult and LocationContext, therefore navigation will interact only with LocationMapMatchedListener and LocationContextUpdatedListener.

abstract fun start(navigationOptions: NavigationOptions)

Starts navigation with provided NavigationOptions. Navigation will go through all steps:

Link copied to clipboard
abstract fun stop()

Stops current navigation session and clears data related to it. Calling this method will have no effect if start was not called previously.

Link copied to clipboard
abstract fun update(navigationOptions: NavigationOptions)

Updates the navigation session with a Route from a provided NavigationOptions. If the navigation was started with a Route then this method will replace the current Route with the provided one. If the navigation was started without a Route then this method will start navigating on the provided Route. Note that the initial instances of navigation engines will be used in the new navigation session.

Inherited functions

Link copied to clipboard
abstract fun close()