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

Link copied to clipboard

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

Link copied to clipboard

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

Adds an OnHorizonUpdatedListener 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 OnLaneGuidanceUpdateListener which will report new LaneGuidance every time a location change occurs and the GuidanceEngine successfully generates it.

Link copied to clipboard

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

Adds an OnLocationMatchedListener which will inform about new MatchedLocation each time a location change occurs and the MapMatchingEngine successfully matched it.

Link copied to clipboard

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

Link copied to clipboard

Adds an OnNavigationStartedListener which will inform about successful navigation start.

Link copied to clipboard

Adds an OnProgressUpdateListener 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
Link copied to clipboard

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

Link copied to clipboard

Adds an OnRoutesChangedListener which will inform about any change to the set of routes in the navigation session.

Link copied to clipboard

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

Link copied to clipboard

Adds an OnWaypointVisitedListener 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
Link copied to clipboard

Removes previously registered OnGuidanceUpdateListener.

Link copied to clipboard

Removes previously registered OnHorizonUpdatedListener.

Link copied to clipboard
Link copied to clipboard

Removes previously registered OnLocationMatchedListener.

Link copied to clipboard

Removes previously registered OnNavigationErrorListener.

Link copied to clipboard
Link copied to clipboard

Removes previously registered OnProgressUpdateListener.

Link copied to clipboard

Removes previously registered OnRouteDeviationListener.

Link copied to clipboard

Removes previously registered OnRoutesChangedListener.

Link copied to clipboard

Removes previously registered OnRouteUpdatedListener.

Link copied to clipboard

Removes previously registered OnWaypointVisitedListener.

Link copied to clipboard
abstract fun start()

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(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(routePlan: RoutePlan)

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.

Properties

Link copied to clipboard

The current GuidanceEngine.

Link copied to clipboard

The current HorizonEngine.

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Inheritors

Link copied to clipboard