planRouteAsFlow

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
fun RoutePlanner.planRouteAsFlow(routePlanningOptions: RoutePlanningOptions): Flow<Route>

Asynchronously plans a route and its alternative routes using the provided RoutePlanningOptions object and returns the planned route as a flow of Route.

Return

Flow of Route.

Parameters

routePlanningOptions

The object containing the routing options needed to plan a route.

Throws

in case of failure.