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

RoutingApi

interface RoutingApi

TomTom Routing API main object.

It contains methods to use Tomtom's routing engine and it provides support for standard callback calls and RxJava2 Observables.

Functions

findReachableRange	`abstract fun findReachableRange(query: ReachableRangeQuery): Single<ReachableRangeResponse>` Performs a reactive reachable range computing action based on the provided ReachableRangeQuery object. `abstract fun findReachableRange(query: ReachableRangeQuery, listener: ReachableRangeResultListener): Unit` Performs a reachable range computing action action based on the provided ReachableRangeQuery object and returns the route in the callback.
planBatchRoute	`abstract fun planBatchRoute(batchQuery: BatchRoutingQuery): Single<BatchRoutingResponse>` Performs a reactive batch computing action based on the provided BatchRoutingQuery object. `abstract fun planBatchRoute(batchQuery: BatchRoutingQuery, listener: BatchableRoutingResultListener): Unit` Performs a batch computing action based on the provided BatchRoutingQuery object and returns the routes in the callback.
planMatrixRoutes	`abstract fun planMatrixRoutes(matrixQuery: MatrixRoutingQuery): Single<MatrixRoutingResponse>` Performs a reactive matrix computing action based on the provided MatrixRoutingQuery object. `abstract fun planMatrixRoutes(matrixQuery: MatrixRoutingQuery, listener: MatrixRoutingResultListener): Unit` Performs a matrix computing action based on the provided MatrixRoutingQuery object and returns the routes in the callback.
planReachableRange	`abstract fun planReachableRange(reachableRangeSpecification: ReachableRangeSpecification): Result<ReachableRangeArea>` Performs a synchronous plan route computing action based on the provided ReachableRangeSpecification object. `abstract fun planReachableRange(reachableRangeSpecification: ReachableRangeSpecification, reachableAreaCallback: ReachableAreaCallback): Unit` Performs an asynchronous plan route computing action based on the provided ReachableRangeSpecification object and returns the reachable area in the callback.
planRoute	`abstract fun planRoute(routeQuery: RouteQuery): Single<RouteResponse>` Performs a reactive route planning action based on the provided RouteQuery object. `abstract fun planRoute(routeQuery: RouteQuery, callback: RouteCallback): Unit` Performs a route planning action based on the provided RouteQuery object and returns the route in the callback. `abstract fun planRoute(routeSpecification: RouteSpecification): Result<RoutePlan>` Performs a synchronous plan route computing action based on the provided RouteSpecification object. `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. `abstract fun planRoute(evRouteSpecification: EvRouteSpecification): Result<EvRoutePlan>` Performs a synchronous plan route computing action based on the provided EvRouteSpecification object. `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.
planRoutes	`abstract fun planRoutes(batchRoutesSpecification: BatchRoutesSpecification): Result<BatchRoutesPlan>` Performs a synchronous plan route computing action based on the provided BatchRoutesSpecification object. `abstract fun planRoutes(batchRoutesSpecification: BatchRoutesSpecification, batchRoutesCallback: BatchRoutesCallback): Unit` Performs an asynchronous plan route computing action based on the provided BatchRoutesSpecification object and returns the batch routes in the callback. `abstract fun planRoutes(matrixRoutesSpecification: MatrixRoutesSpecification): Result<MatrixRoutesPlan>` Performs a synchronous plan route computing action based on the provided MatrixRoutesSpecification object. `abstract fun planRoutes(matrixRoutesSpecification: MatrixRoutesSpecification, matrixRoutesCallback: MatrixRoutesCallback): Unit` Performs an asynchronous plan route computing action based on the provided MatrixRoutesSpecification object and returns the matrix of routes in the callback.

Companion Object Properties

DEFAULT_ONLINE_ROUTING_ENDPOINT	`const val DEFAULT_ONLINE_ROUTING_ENDPOINT: String` Default TomTom's Routing API endpoint.
DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION	`const val DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION: String` Default TomTom's Routing API service version.

Inheritors

OnlineRoutingApi

open class OnlineRoutingApi : RoutingApi

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