setNavigationRoutes
suspend fun MapboxRouteLineApi.setNavigationRoutes(newRoutes: List<NavigationRoute>): Expected<RouteLineError, RouteSetValue>
Content copied to clipboard
Sets the routes that will be operated on.
Return
a state which contains the side effects to be applied to the map
Parameters
newRoutes
one or more routes. The first route in the collection will be considered the primary route and any additional routes will be alternate routes.
suspend fun MapboxRouteLineApi.setNavigationRoutes(newRoutes: List<NavigationRoute>, alternativeRoutesMetadata: List<AlternativeRouteMetadata>): Expected<RouteLineError, RouteSetValue>
Content copied to clipboard
Sets the routes that will be operated on.
Return
a state which contains the side effects to be applied to the map
Parameters
newRoutes
one or more routes. The first route in the collection will be considered the primary route and any additional routes will be alternate routes.
alternativeRoutesMetadata
if available, the update will hide the portions of the alternative routes until the deviation point with the primary route. See MapboxNavigation.getAlternativeMetadataFor.