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 both: standard callback calls and RxJava2 Observables.

Functions

findReachableRange

abstract fun findReachableRange(query: ReachableRangeQuery): Single<ReachableRangeResponse>

Performs reactive reachable range computing action based on provided ReachableRangeQuery object.

abstract fun findReachableRange(query: ReachableRangeQuery, listener: ReachableRangeResultListener): Unit

Performs reachable range computing action action based on provided ReachableRangeQuery object and returns the route in the callback.

planBatchRoute

abstract fun planBatchRoute(batchQuery: BatchRoutingQuery): Single<BatchRoutingResponse>

Performs reactive batch computing action based on provided BatchRoutingQuery object.

abstract fun planBatchRoute(batchQuery: BatchRoutingQuery, listener: BatchableRoutingResultListener): Unit

Performs batch computing action based on provided BatchRoutingQuery object and returns the routes in the callback.

planMatrixRoutes

abstract fun planMatrixRoutes(matrixQuery: MatrixRoutingQuery): Single<MatrixRoutingResponse>

Performs reactive matrix computing action based on provided MatrixRoutingQuery object.

abstract fun planMatrixRoutes(matrixQuery: MatrixRoutingQuery, listener: MatrixRoutingResultListener): Unit

Performs matrix computing action based on provided MatrixRoutingQuery object and returns the routes in the callback.

planRoute

abstract fun planRoute(routeQuery: RouteQuery): Single<RouteResponse>

Performs reactive route planning action based on provided RouteQuery object.

abstract fun planRoute(routeQuery: RouteQuery, callback: RouteCallback): Unit

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

abstract fun planRoute(evRouteSpecification: EvRouteSpecification): Result<EvRoutePlan>

Performs plan route computing action based on provided EvRouteSpecification object.

abstract fun planRoute(evRouteSpecification: EvRouteSpecification, callback: EvRouteCallback): Unit

Performs plan route computing action based on provided EvRouteSpecification object and returns the route plan 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.