TomTomNavigation

The current BetterProposalAcceptanceMode.

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.

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

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

Provides access to current registered engines and allows updating them.

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

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

UnitSystem to be used within TomTomNavigation.

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

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

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

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.

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.

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.

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

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

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

Adds an NavigationStartedListener which will inform about successful navigation start.

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

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

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

Adds a RouteTrackingStateUpdatedListener that informs about the current RouteTrackingState.

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

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

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

Removes a previously registered ActiveRouteChangedListener.

Removes a previously added DestinationArrivalListener.

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

Removes a previously added HorizonUpdatedListener.

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

Removes previously registered LanguageChangedListener.

Removes a previously added LocationContextUpdatedListener.

Removes previously registered LocationMapMatchedListener.

Removes previously registered NavigationStartedListener.

Removes previously registered ProgressUpdatedListener.

Removes a previously registered RouteAddedListener.

Removes a previously registered RouteRemovedListener.

Removes previously registered RouteTrackingStateUpdatedListener.

Removes previously registered RouteUpdatedListener.

Removes a previously registered WaypointArrivalListener.

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 selection operation will have no effect.

Sets a provided routePlan as active. If the navigation has been successfully started with an active route plan, then this method will replace it with the provided one. If the navigation has been started without an active route plan, then this method will start navigating on the provided one.

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.

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

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