Core/com.mapbox.navigation.core.reroute/RerouteController

RerouteController

@UiThread
abstract class RerouteController

Provides API to trigger reroute and observe reroute state.

See also

Types

Link copied to clipboard
fun interface RerouteStateObserver

RerouteState observer

Link copied to clipboard
fun interface RerouteStateV2Observer

RerouteStateV2 observer

Link copied to clipboard
@UiThread
fun interface RoutesCallback

Route Callback is useful to set new route(s) on reroute event. Doing the same as MapboxNavigation.setNavigationRoutes.

Properties

Link copied to clipboard
abstract val state: RerouteState

Reroute state.

Link copied to clipboard
abstract val stateV2: RerouteStateV2

Reroute state with additional substates, see RerouteStateV2.

Functions

Link copied to clipboard
abstract fun registerRerouteStateObserver(rerouteStateObserver: RerouteController.RerouteStateObserver): Boolean

Add a RerouteStateObserver to collection and immediately invoke rerouteStateObserver with current re-route state.

Link copied to clipboard
abstract fun registerRerouteStateV2Observer(rerouteStateObserver: RerouteController.RerouteStateV2Observer): Boolean

Add a RerouteStateV2Observer to collection and immediately invoke rerouteStateObserver with current re-route state.

Link copied to clipboard
abstract fun reroute(callback: RerouteController.RoutesCallback)

Invoked whenever re-route is needed. For instance when a driver is off-route. Called just after an off-route event.

Link copied to clipboard
abstract fun unregisterRerouteStateObserver(rerouteStateObserver: RerouteController.RerouteStateObserver): Boolean

Remove rerouteStateObserver from collection of observers.

Link copied to clipboard
abstract fun unregisterRerouteStateV2Observer(rerouteStateObserver: RerouteController.RerouteStateV2Observer): Boolean

Remove rerouteStateObserver from collection of observers.