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
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.
Adds an DestinationReachedListener which will inform about reaching destination the ArrivalDetectionEngine successfully detects arrival at the destination.
Adds an GuidanceUpdateListener which will inform about new Guidance each time a location change occurs and the GuidanceEngine successfully generates it.
Adds an HorizonUpdatedListener which will inform about new horizon snaphot each time a location change occurs and the HorizonEngine successfully updated it.
Adds an LaneGuidanceUpdatedListener which will report new LaneGuidance every time a location change occurs and the GuidanceEngine successfully generates it.
Adds an LanguageChangedListener which will report on changes to the navigation language.
Adds an LocationContextUpdatedListener which will inform about new LocationContext each time a location change occurs and the LocationContextProviderEngine successfully provides it.
Adds an LocationMapMatchedListener which will inform about new MapMatchingResult each time a location change occurs and the MapMatchingEngine successfully matched it.
Adds an NavigationFailureListener which will inform about failures that occurred during navigating.
Adds an NavigationStartedListener which will inform about successful navigation start.
Adds an ProgressUpdatedListener which will inform about new progress along the route each time a location change occurs and the RouteProgressEngine successfully calculates it.
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.
Adds an RouteDeviationListener which will inform about getting off the route when the RouteTrackingEngine successfully detects it.
Adds an RoutesChangedListener which will inform about any change to the set of routes in the navigation session.
Adds an RouteUpdatedListener which will inform about successful update of the Route.
Adds an WaypointVisitedListener which will inform about reaching waypoints when the ArrivalDetectionEngine successfully detects arrival at a waypoint.
Removes previously registered DestinationReachedListener.
Removes previously registered GuidanceUpdateListener.
Removes previously registered HorizonUpdatedListener.
Removes previously registered LaneGuidanceUpdatedListener.
Removes previously registered LanguageChangedListener.
Removes previously registered LocationContextUpdatedListener.
Removes previously registered LocationMapMatchedListener.
Removes previously registered NavigationFailureListener.
Removes previously registered NavigationStartedListener.
Removes previously registered ProgressUpdatedListener.
Removes previously registered ReplannedRouteProposedListener.
Removes previously registered RouteDeviationListener.
Removes previously registered RoutesChangedListener.
Removes previously registered RouteUpdatedListener.
Removes previously registered WaypointVisitedListener.
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:
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
The current ContinuousReplanningMode.
The current NavigationSnapshot. Can be null when navigation is not yet started or already stopped.