NavigationController

interface NavigationController : Disposable

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 addOnDestinationReachedListener(listener: OnDestinationReachedListener)

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

Link copied to clipboard
abstract fun addOnGuidanceUpdateListener(listener: OnGuidanceUpdateListener)

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

Link copied to clipboard
abstract fun addOnLaneGuidanceUpdatedListener(listener: OnLaneGuidanceUpdateListener)

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

Link copied to clipboard
abstract fun addOnLocationContextUpdateListener(listener: OnLocationContextUpdateListener)

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

Link copied to clipboard
abstract fun addOnLocationMatchedListener(listener: OnLocationMatchedListener)

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.

Link copied to clipboard
abstract fun addOnNavigationErrorListener(listener: OnErrorListener)

Adds an OnErrorListener which will inform about errors that occurred during navigating.

Link copied to clipboard
abstract fun addOnNavigationStartedListener(listener: OnNavigationStartedListener)

Adds an OnNavigationStartedListener which will inform about successful navigation start.

Link copied to clipboard
abstract fun addOnProgressUpdateListener(listener: OnProgressUpdateListener)

Adds an OnProgressUpdateListener which will inform about new progress along the route each time a location change occurs and the RouteProgressCalculationEngine successfully calculates it.

Link copied to clipboard
abstract fun addOnReplannedRouteProposedListener(listener: OnReplannedRouteProposedListener)

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.

Link copied to clipboard
abstract fun addOnRouteDeviationListener(listener: OnRouteDeviationListener)

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

Link copied to clipboard
abstract fun addOnRouteUpdatedListener(listener: OnRouteUpdatedListener)

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

Link copied to clipboard
abstract fun addOnWaypointVisitedListener(listener: OnWaypointVisitedListener)

Adds an OnWaypointVisitedListener which will inform about reaching waypoints when the ArrivalDetectionEngine successfully detects arrival at a waypoint.

Link copied to clipboard
abstract fun arrivalDetectionEngine(): ArrivalDetectionEngine

Returns the current ArrivalDetectionEngine.

Link copied to clipboard
abstract fun changeContinuousReplanningMode(continuousReplanningMode: ContinuousReplanningMode)

Replaces the current ContinuousReplanningMode with the new one.

Link copied to clipboard
abstract fun continuousReplanningMode(): ContinuousReplanningMode

Returns the current ContinuousReplanningMode.

Link copied to clipboard
abstract fun dispose()
Link copied to clipboard
abstract fun guidanceEngine(): GuidanceEngine

Returns the current GuidanceEngine.

Link copied to clipboard
abstract fun locationContextProviderEngine(): LocationContextProviderEngine

Returns the current LocationContextProviderEngine.

Link copied to clipboard
abstract fun locationEngine(): LocationEngine

Returns the current LocationEngine.

Link copied to clipboard
abstract fun mapMatchingEngine(): MapMatchingEngine

Returns the current MapMatchingEngine.

Link copied to clipboard
abstract fun navigationSnapshot(): NavigationSnapshot?

Returns the current NavigationSnapshot. The return value is null when navigation is not yet started or already stopped.

Link copied to clipboard
abstract fun removeOnDestinationReachedListener(listener: OnDestinationReachedListener)

Removes previously registered OnDestinationReachedListener.

Link copied to clipboard
abstract fun removeOnGuidanceUpdateListener(listener: OnGuidanceUpdateListener)

Removes previously registered OnGuidanceUpdateListener.

Link copied to clipboard
abstract fun removeOnLaneGuidanceUpdatedListener(listener: OnLaneGuidanceUpdateListener)

Removes previously registered OnLaneGuidanceUpdateListener.

Link copied to clipboard
abstract fun removeOnLocationContextUpdateListener(listener: OnLocationContextUpdateListener)

Removes previously registered OnLocationContextUpdateListener.

Link copied to clipboard
abstract fun removeOnLocationMatchedListener(listener: OnLocationMatchedListener)

Removes previously registered OnLocationMatchedListener.

Removes previously registered OnLocationPredictionsGeneratedListener.

Link copied to clipboard
abstract fun removeOnNavigationErrorListener(listener: OnErrorListener)

Removes previously registered OnErrorListener.

Link copied to clipboard
abstract fun removeOnNavigationStartedListener(listener: OnNavigationStartedListener)

Removes previously registered OnNavigationStartedListener.

Link copied to clipboard
abstract fun removeOnProgressUpdateListener(listener: OnProgressUpdateListener)

Removes previously registered OnProgressUpdateListener.

Link copied to clipboard
abstract fun removeOnReplannedRouteProposedListener(listener: OnReplannedRouteProposedListener)

Removes previously registered OnReplannedRouteProposedListener.

Link copied to clipboard
abstract fun removeOnRouteDeviationListener(listener: OnRouteDeviationListener)

Removes previously registered OnRouteDeviationListener.

Link copied to clipboard
abstract fun removeOnRouteUpdatedListener(listener: OnRouteUpdatedListener)

Removes previously registered OnRouteUpdatedListener.

Link copied to clipboard
abstract fun removeOnWaypointVisitedListener(listener: OnWaypointVisitedListener)

Removes previously registered OnWaypointVisitedListener.

Link copied to clipboard
abstract fun routeProgressDetectionEngine(): RouteProgressCalculationEngine

Returns the current RouteProgressCalculationEngine.

Link copied to clipboard
abstract fun routeTrackingEngine(): RouteTrackingEngine

Returns the current RouteTrackingEngine.

Link copied to clipboard
abstract fun setArrivalDetectionEngine(engine: ArrivalDetectionEngine)

Replaces current ArrivalDetectionEngine with the new one.

Link copied to clipboard
abstract fun setDataStoreUpdateContextEngine(engine: DataStoreUpdateContextEngine)

Replaces current DataStoreUpdateContextEngine with the new one.

Link copied to clipboard
abstract fun setGuidanceEngine(engine: GuidanceEngine)

Replaces current GuidanceEngine with the new one.

Link copied to clipboard
abstract fun setLocationContextProviderEngine(engine: LocationContextProviderEngine)

Replaces current LocationContextProviderEngine with the new one.

Link copied to clipboard
abstract fun setLocationEngine(engine: LocationEngine)

Replaces current LocationEngine with the new one.

Link copied to clipboard
abstract fun setMapMatchingEngine(engine: MapMatchingEngine)

Replaces current MapMatchingEngine with the new one.

Link copied to clipboard
abstract fun setRouteProgressDetectionEngine(engine: RouteProgressCalculationEngine)

Replaces current RouteProgressCalculationEngine with the new one.

Link copied to clipboard
abstract fun setRouteTrackingEngine(engine: RouteTrackingEngine)

Replaces current RouteTrackingEngine with the new one.

Link copied to clipboard
abstract fun start(navigationStartedCallback: NavigationStartedCallback? = null)

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.

abstract fun start(routePlan: RoutePlan, navigationStartedCallback: NavigationStartedCallback? = null)

Starts navigation with provided RoutePlan. 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(routePlan: RoutePlan, routeUpdatedCallback: RouteUpdatedCallback? = null)

Updates the navigation session with a Route from a provided RoutePlan. 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.

Inheritors

Link copied to clipboard