RoutingApi

interface RoutingApi : Disposable

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 dispose()
Link copied to clipboard
abstract fun planRoute(planRouteOptions: PlanRouteOptions): Result<PlanRouteResult, RoutingError>

Synchronously plans a route using the provided PlanRouteOptions object. If the call succeeds, returns a PlanRouteResult. If it fails, returns a RoutingError.

abstract fun planRoute(planRouteOptions: PlanRouteOptions, callback: PlanRouteCallback): Cancellable

Asynchronously plans a route using the provided PlanRouteOptions object and returns the planned route in the PlanRouteCallback.