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.

Functions

Link copied to clipboard
abstract fun acceptProposedRoute()

Accepts the proposed Route. The Route is proposed via ReplannedRouteProposedListener. The navigation will switch to navigate along the proposed route and the RouteUpdatedListener will be notified. If the acceptance of the proposed route fails, the NavigationFailureListener will be triggered with the RouteUpdateFailure.

Link copied to clipboard

Adds an DestinationReachedListener which will inform about reaching destination the ArrivalDetectionEngine successfully detects arrival at the destination.

Link copied to clipboard

Adds an GuidanceUpdateListener which will inform about new Guidance each time a location change occurs and the GuidanceEngine successfully generates it.

Link copied to clipboard

Adds an HorizonUpdatedListener which will inform about new horizon snaphot each time a location change occurs and the HorizonEngine successfully updated it.

Link copied to clipboard

Adds an LaneGuidanceUpdatedListener which will report new LaneGuidance every time a location change occurs and the GuidanceEngine successfully generates it.

Link copied to clipboard

Adds an LanguageChangedListener which will report on changes to the navigation language.

Link copied to clipboard

Adds an LocationContextUpdatedListener which will inform about new LocationContext each time a location change occurs and the LocationContextProviderEngine successfully provides it.

Link copied to clipboard

Adds an LocationMapMatchedListener which will inform about new MapMatchingResult each time a location change occurs and the MapMatchingEngine successfully matched 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 change occurs and the RouteProgressEngine successfully calculates it.

Link copied to clipboard

Adds an ReplannedRouteProposedListener which will report on the new ReplannedRoute. Its Route can be used for navigation by accepting this proposal using the acceptProposedRoute method. The listener will only be triggered if ContinuousReplanningMode is set to ContinuousReplanningMode.Manual or ContinuousReplanningMode.UnreachableOnly in NavigationConfiguration.

Link copied to clipboard

Adds an RouteDeviationListener which will inform about getting off the route when the RouteTrackingEngine successfully detects it.

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 an WaypointVisitedListener which will inform about reaching waypoints when the ArrivalDetectionEngine successfully detects arrival at a waypoint.

Link copied to clipboard
abstract fun close()
Link copied to clipboard

Removes previously registered DestinationReachedListener.

Link copied to clipboard

Removes previously registered GuidanceUpdateListener.

Link copied to clipboard

Removes previously registered HorizonUpdatedListener.

Link copied to clipboard
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 previously registered RouteDeviationListener.

Link copied to clipboard

Removes previously registered RoutesChangedListener.

Link copied to clipboard

Removes previously registered RouteUpdatedListener.

Link copied to clipboard

Removes previously registered WaypointVisitedListener.

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.

Properties

Link copied to clipboard
abstract var language: Locale

Language to be used within TomTomNavigation.

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

UnitSystem to be used within TomTomNavigation.