OnlineRoutePlanner

Default TomTom implementation of the entry point to perform route planning action based on TomTom's Routing APIs.

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard
open override 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
open override fun close()

Implementation of AutoCloseable.close.

Link copied to clipboard
open override 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.

open override 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.

Link copied to clipboard
open override fun toString(): String

Returns a string representation of the online route planner.