sdk-routing / com.tomtom.online.sdk.routing / RoutingApi / planRoute

planRoute

@DeprecatedSince(2020, 7) abstract fun planRoute(routeQuery: RouteQuery): Single<RouteResponse>
Deprecated: This method is replaced by appropriate method in sdk-routing-rxjava2 module. Please visit https://developer.tomtom.com/maps-android-sdk/routing for more details.

Performs a reactive route planning action based on the provided RouteQuery object.

Parameters

routeQuery - The object which contains the data necessary to execute the route planning action.

Return
RouteResponse's Single object.

@DeprecatedSince(2020, 6) abstract fun planRoute(routeQuery: RouteQuery, callback: RouteCallback): Unit
Deprecated: This method is going to be replaced by appropriate planRoute() method

Performs a route planning action based on the provided RouteQuery object and returns the route in the callback.

Parameters

routeQuery - The object which contains the data necessary to execute the route planning action.

callback - The RouteCallback which contains data about the planned route.

@Beta(2020, 12) abstract fun planRoute(routeSpecification: RouteSpecification): Result<RoutePlan>

Performs a synchronous plan route computing action based on the provided RouteSpecification object.

Parameters

routeSpecification - The object which contains the data necessary to execute the plan route computing action.

Return
RoutePlan's Result object.

@Beta(2020, 12) abstract fun planRoute(routeSpecification: RouteSpecification, routeCallback: RouteCallback): Unit

Performs an asynchronous plan route computing action based on the provided RouteSpecification object and returns the planned route in the callback.

Parameters

routeSpecification - The object which contains the data necessary to execute the plan route computing action.

@Beta(2020, 12) abstract fun planRoute(evRouteSpecification: EvRouteSpecification): Result<EvRoutePlan>

Performs a synchronous plan route computing action based on the provided EvRouteSpecification object.

Parameters

evRouteSpecification - The object which contains the data necessary to execute the plan route computing action.

Return
EvRoutePlan's Result object.

@Beta(2020, 12) abstract fun planRoute(evRouteSpecification: EvRouteSpecification, callback: EvRouteCallback): Unit

Performs an asynchronous plan route computing action based on the provided EvRouteSpecification object and returns the route plan in the callback.

Parameters

evRouteSpecification - The object which contains the data necessary to execute the plan route computing action.