com.tomtom.online.sdk.routing

Interface RoutingApi

All Known Implementing Classes:

OnlineRoutingApi

public interface RoutingApi

TomTom Routing API main object. It contains methods to use Tomtom's online routing engine and it provides support for both: standard callback calls and RxJava2 Observables.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_ONLINE_ROUTING_ENDPOINT Default TomTom's OnlineRouting endpoint
static java.lang.String	DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION Default TomTom's OnlineRouting service version

Method Summary

Modifier and Type	Method and Description
Single<ReachableRangeResponse>	findReachableRange(ReachableRangeQuery query) Performs reactive reachable range computing action based on provided ReachableRangeQuery object.
void	findReachableRange(ReachableRangeQuery query, ReachableRangeResultListener listener) Performs reachable range computing action action based on provided ReachableRangeQuery object and returns the route in the callback.
Single<BatchRoutingResponse>	planBatchRoute(BatchRoutingQuery batchQuery) Performs reactive batch computing action based on provided BatchRoutingQuery object.
void	planBatchRoute(BatchRoutingQuery batchQuery, BatchableRoutingResultListener listener) Performs batch computing action based on provided BatchRoutingQuery object and returns the routes in the callback.
Single<RouteResult>	planRoute(RouteQuery routeQuery) Performs reactive route planning action based on provided RouteQuery object.
void	planRoute(RouteQuery routeQuery, RouteCallback callback) Performs route planning action based on provided RouteQuery object and returns the route in the callback.

Field Detail

DEFAULT_ONLINE_ROUTING_ENDPOINT

static final java.lang.String DEFAULT_ONLINE_ROUTING_ENDPOINT

Default TomTom's OnlineRouting endpoint

See Also:

Constant Field Values

DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION

static final java.lang.String DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION

Default TomTom's OnlineRouting service version

See Also:

Constant Field Values

Method Detail

planRoute

Single<RouteResult> planRoute(RouteQuery routeQuery)

Performs reactive route planning action based on provided RouteQuery object.

Parameters:

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

Returns:

RouteResult's Single object.

planRoute

void planRoute(RouteQuery routeQuery,
               RouteCallback callback)

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

Parameters:

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

callback - The RouteCallbackwhich contains data about planned route.

findReachableRange

Single<ReachableRangeResponse> findReachableRange(ReachableRangeQuery query)

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

Parameters:

query - The object which contains data necessary to execute reachable range computing action.

Returns:

ReachableRangeResponse's Single object

findReachableRange

void findReachableRange(ReachableRangeQuery query,
                        ReachableRangeResultListener listener)

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

Parameters:

query - The object which contains data necessary to execute reachable range computing action.

listener - The ReachableRangeResultListener which contains data about reachable range.

planBatchRoute

Single<BatchRoutingResponse> planBatchRoute(BatchRoutingQuery batchQuery)

Performs reactive batch computing action based on provided BatchRoutingQuery object.

Parameters:

batchQuery - The object which contains data necessary to execute batch computing action.

Returns:

BatchRoutingResponse's Single object

planBatchRoute

void planBatchRoute(BatchRoutingQuery batchQuery,
                    BatchableRoutingResultListener listener)

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

Parameters:

batchQuery - The object which contains data necessary to execute batch computing action.

listener - The BatchableRoutingResultListener which contains data about batch.