UI Drop-In/com.mapbox.navigation.dropin/NavigationViewApi

NavigationViewApi

abstract class NavigationViewApi

Api that gives you the ability to change the state for navigation apps.

Constructors

NavigationViewApi

fun NavigationViewApi()

Functions

isReplayEnabled

abstract fun isReplayEnabled(): Boolean

Checks if the current trip is being simulated.

routeReplayEnabled

abstract fun routeReplayEnabled(enabled: Boolean)

Enable/Disable replay trip session based on simulated locations.

startActiveGuidance

abstract fun startActiveGuidance(): Expected<NavigationViewApiError, Unit>

Request NavigationView to enter Active Navigation state.

abstract fun startActiveGuidance(routes: List<NavigationRoute>): Expected<NavigationViewApiError, Unit>

Sets routes and request NavigationView to enter Active Navigation state. Last DirectionsWaypoint location will be used as the destination.

abstract fun startArrival(): Expected<NavigationViewApiError, Unit>

Request NavigationView to enter Arrival state.

abstract fun startArrival(routes: List<NavigationRoute>): Expected<NavigationViewApiError, Unit>

Sets routes and request NavigationView to enter Arrival state. Last DirectionsWaypoint location will be used as the destination.

startDestinationPreview

abstract fun startDestinationPreview(point: Point)

Sets a point as destination and request NavigationView to enter Destination Preview state.

abstract fun startFreeDrive()

Clear Route data and request NavigationView to enter Free Drive state.

startRoutePreview

abstract fun startRoutePreview(): Expected<NavigationViewApiError, Unit>

Request NavigationView to enter Route Preview state.

abstract fun startRoutePreview(routes: List<NavigationRoute>): Expected<NavigationViewApiError, Unit>

Sets a preview routes and request Request NavigationView to enter Route Preview state. Last DirectionsWaypoint location will be used as the destination.