ActiveRouteChangedListener

Informs the caller that the active route has changed. The active route is the only route that is being followed for which the navigation provides guidance.

The active route is changed when:

• The navigation is started with a route using the TomTomNavigation.start method with NavigationOptions argument.

• A replanning is completed by the navigation and a new route is set as the active route.

• The active route plan is updated using the TomTomNavigation.setActiveRoutePlan method. Note, if TomTomNavigation.setActiveRoutePlan is called on the currently active route, this listener will not receive an active route changed notification.

• A better route proposal is accepted using the TomTomNavigation.selectActiveRoute method.

• A better route proposal is accepted by steering onto it.

To listen for active route changes, first implement the interface below to create the listener:

val activeRouteChangedListener = ActiveRouteChangedListener { route ->
    // add code here that handles the active route being changed
}

Then add this listener using TomTomNavigation.addActiveRouteChangedListener. To stop listening to active route changes, remove the listener using TomTomNavigation.removeActiveRouteChangedListener.

The ActiveRouteChangedListener is called post the addition of the new route to the navigation and prior to the removal of the old active route. Hence, it is called after the RouteAddedListener and before the RouteRemovedListener.