onRouteAlternativeRequestFinished
abstract fun onRouteAlternativeRequestFinished( routeProgress: RouteProgress, alternatives: List<DirectionsRoute>, routerOrigin: RouterOrigin)
Content copied to clipboard
Invoked when on-demand alternative routes request finishes.
The alternatives list always represent all available, up-to-date, alternatives for the current route.
The alternatives are not automatically added to MapboxNavigation, you need to add them manually to trigger RoutesObserver, for example:
mapboxNavigation.requestAlternativeRoutes(
RouteAlternativesRequestListener { routeProgress, alternatives, routerOrigin ->
val newRoutes = mutableListOf<DirectionsRoute>().apply {
add(mapboxNavigation.getRoutes().first())
addAll(alternatives)
}
mapboxNavigation.setRoutes(newRoutes)
}
)Content copied to clipboard
You can filter the alternatives out before setting them back to MapboxNavigation based on requirements.
Parameters
routeProgress
the current route's progress.
alternatives
list of alternative routes, can be empty.
routerOrigin
reports the source of all the new alternative routes in the list. If there are no new routes, reports the source that returned the latest additions.