RoutePlanner
Entry point to perform a route planning action.
Important: This is a Public Preview API. It may be changed or removed at any time.
Functions
Link copied to clipboard
abstract fun incrementRouteContents(routeIncrementOptions: RouteIncrementOptions): Result<Route, RoutingFailure>
Calculates route contents (instructions, lane guidance) for the first sequence of instructions following the last successful increment.
Link copied to clipboard
abstract fun planRoute(routePlanningOptions: RoutePlanningOptions): Result<RoutePlanningResponse, RoutingFailure>
Synchronously plans a route and its alternative routes using the provided RoutePlanningOptions object. If the call succeeds, returns a RoutePlanningResponse. If it fails, returns a RoutingFailure.
abstract fun planRoute(routePlanningOptions: RoutePlanningOptions, callback: RoutePlanningCallback): Cancellable
Asynchronously plans a route and its alternative routes using the provided RoutePlanningOptions object and returns the planned route in the RoutePlanningCallback.