com.tomtom.sdk.routing:routing-common/com.tomtom.sdk.routing/RoutePlanner

RoutePlanner

interface RoutePlanner : AutoCloseable

Entry point to perform a route planning action.

Functions

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract fun advanceGuidanceProgress(routeIncrementOptions: RouteIncrementOptions): Result<Route, RoutingFailure>

Calculates route contents (instructions, lane guidance and junction views) for the first sequence of instructions following the last successful increment.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract fun backToRoute(backToRouteOptions: BackToRouteOptions): Result<BackToRouteResponse, RoutingFailure>

Synchronously plans a route to return to the original route using the provided BackToRouteOptions object.

@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
abstract fun backToRoute(backToRouteOptions: BackToRouteOptions, callback: BackToRouteCallback): Cancellable

Asynchronously plans a route to return to the original route using the provided BackToRouteOptions object.

Link copied to clipboard
@RestrictToExtendedFlavor(value = [ExternalScope.LIBRARY_GROUP])
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. If the operation succeeds, RoutePlanningCallback.onSuccess is called with a RoutePlanningResponse. If the operation fails, RoutePlanningCallback.onFailure is called with a RoutingFailure.

Inherited functions

Link copied to clipboard
abstract fun close()
Link copied to clipboard
@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.