com.tomtom.online.sdk.routing

Class OnlineRoutingApi

java.lang.Object

com.tomtom.online.sdk.routing.OnlineRoutingApi

All Implemented Interfaces:

RoutingApi

public class OnlineRoutingApi
extends java.lang.Object
implements RoutingApi

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

Field Summary

Fields inherited from interface com.tomtom.online.sdk.routing.RoutingApi

DEFAULT_ONLINE_ROUTING_ENDPOINT, DEFAULT_ONLINE_ROUTING_SERVICE_API_VERSION

Method Summary

Modifier and Type	Method and Description
static RoutingApi	create(android.content.Context context) Creates new RoutingApi object which will use provided online routing service api key.
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<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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

public static RoutingApi create(@NonNull
                                android.content.Context context)

Creates new RoutingApi object which will use provided online routing service api key. It uses default values for online routing service endpoint and online routing service api version.

Returns:

Newly created RoutingApi object for further processing.

planRoute

public Single<RouteResult> planRoute(RouteQuery routeQuery)

Description copied from interface: RoutingApi

Performs reactive route planning action based on provided RouteQuery object.

Specified by:

planRoute in interface RoutingApi

Parameters:

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

Returns:

RouteResult's Single object.

planRoute

public void planRoute(RouteQuery routeQuery,
                      RouteCallback callback)

Description copied from interface: RoutingApi

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

Specified by:

planRoute in interface RoutingApi

Parameters:

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

callback - The RouteCallback which contains data about planned route.

findReachableRange

public Single<ReachableRangeResponse> findReachableRange(ReachableRangeQuery query)

Description copied from interface: RoutingApi

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

Specified by:

findReachableRange in interface RoutingApi

Parameters:

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

Returns:

ReachableRangeResponse's Single object

findReachableRange

public void findReachableRange(ReachableRangeQuery query,
                               ReachableRangeResultListener listener)

Description copied from interface: RoutingApi

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

Specified by:

findReachableRange in interface RoutingApi

Parameters:

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

listener - The ReachableRangeResultListener which contains data about reachable range.