routing:routing-client-api/com.tomtom.sdk.routing.api/RoutingApi/planRoute

planRoute

abstract fun planRoute(planRouteOptions: PlanRouteOptions): Result<PlanRouteResult, RoutingError>
Content copied to clipboard

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

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

If the call succeeds, returns a PlanRouteResult. If it fails, returns a RoutingError.

Parameters

options

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


abstract fun planRoute(planRouteOptions: PlanRouteOptions, callback: PlanRouteCallback): Cancellable
Content copied to clipboard

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

Important: This is a Public Preview API. It may be changed or removed at any time.

Return

cancellable operation.

Parameters

planRouteOptions

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

callback

The PlanRouteCallback invoked when the routing operation has finished, either successfully or with an error. The callback will be executed in the main thread.