NavigationController
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
Adds an OnDestinationReachedListener which will inform about reaching destination the ArrivalDetectionEngine successfully detects arrival at the destination.
Adds an OnGuidanceUpdateListener which will inform about new Guidance each time a location change occurs and the GuidanceEngine successfully generates it.
Adds an OnLaneGuidanceUpdateListener which will report new LaneGuidance every time a location change occurs and the GuidanceEngine successfully generates it.
Adds an OnLocationContextUpdateListener which will inform about new LocationContext each time a location change occurs and the LocationContextProviderEngine successfully provides it.
Adds an OnLocationMatchedListener which will inform about new MatchedLocation each time a location change occurs and the MapMatchingEngine successfully matched it.
Adds an OnLocationPredictionsGeneratedListener which will inform about new predictions.
Adds an OnErrorListener which will inform about errors that occurred during navigating.
Adds an OnNavigationStartedListener which will inform about successful navigation start.
Adds an OnProgressUpdateListener which will inform about new progress along the route each time a location change occurs and the RouteProgressCalculationEngine successfully calculates it.
Adds an OnReplannedRouteProposedListener which will inform about new ReplannedRoute. Its Route can either be used in update or discarded. Listener will only be triggered if ContinuousReplanningMode is set to ContinuousReplanningMode.MANUAL or ContinuousReplanningMode.UNREACHABLE_ONLY in NavigationConfiguration.
Adds an OnRouteDeviationListener which will inform about getting off the route when the RouteTrackingEngine successfully detects it.
Adds an OnRouteUpdatedListener which will inform about successful update of the Route.
Adds an OnWaypointVisitedListener which will inform about reaching waypoints when the ArrivalDetectionEngine successfully detects arrival at a waypoint.
Returns the current ArrivalDetectionEngine.
Replaces the current ContinuousReplanningMode with the new one.
Returns the current ContinuousReplanningMode.
Returns the current GuidanceEngine.
Returns the current LocationContextProviderEngine.
Returns the current LocationEngine.
Returns the current MapMatchingEngine.
Returns the current NavigationSnapshot. The return value is null when navigation is not yet started or already stopped.
Removes previously registered OnDestinationReachedListener.
Removes previously registered OnGuidanceUpdateListener.
Removes previously registered OnLaneGuidanceUpdateListener.
Removes previously registered OnLocationContextUpdateListener.
Removes previously registered OnLocationMatchedListener.
Removes previously registered OnLocationPredictionsGeneratedListener.
Removes previously registered OnErrorListener.
Removes previously registered OnNavigationStartedListener.
Removes previously registered OnProgressUpdateListener.
Removes previously registered OnReplannedRouteProposedListener.
Removes previously registered OnRouteDeviationListener.
Removes previously registered OnRouteUpdatedListener.
Removes previously registered OnWaypointVisitedListener.
Returns the current RouteProgressCalculationEngine.
Returns the current RouteTrackingEngine.
Replaces current ArrivalDetectionEngine with the new one.
Replaces current DataStoreUpdateContextEngine with the new one.
Replaces current GuidanceEngine with the new one.
Replaces current LocationContextProviderEngine with the new one.
Replaces current LocationEngine with the new one.
Replaces current MapMatchingEngine with the new one.
Replaces current RouteProgressCalculationEngine with the new one.
Replaces current RouteTrackingEngine with the new one.
Starts navigation without a Route. In this case navigation will just provide a MatchedLocation and LocationContext, therefore navigation will interact only with OnLocationMatchedListener and OnLocationContextUpdateListener.
Starts navigation with provided RoutePlan. Navigation will go through all steps: