Package es.situm.sdk.directions

Interface DirectionsManager

public interface DirectionsManager

Allows route calculation between two points, usually from current user's location.

Codes of all Errors returned by this manager are declared in CommonErrorConstant.Code and DirectionsManager.Code

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DirectionsManager.Code	The error codes received in Handler.onFailure(Error) on the DirectionsManager
static interface	DirectionsManager.PropertyKey

Method Summary

Modifier and Type	Method	Description
boolean	requestDirections(DirectionsRequest request, Handler<Route> callback)	Calculates a route between two points.

Method Details

requestDirections

boolean requestDirections(@NonNull
 DirectionsRequest request,
 @NonNull
 Handler<Route> callback)
                   throws IllegalArgumentException

Calculates a route between two points. The result is provided asynchronously using the callback.

Parameters:

request - non-null search parameters. 'from' and 'to' can't be null, and points have to be inside the same building. If the origin bearing is unknown 'bearingFrom' should be null.

callback - object used to provide the result. Errors are declared in CommonErrorConstant.Code and DirectionsManager.Code

Returns:

true if the async calculus has started correctly. False otherwise.

Throws:

IllegalArgumentException - some required argument is null, or request's points (DirectionsRequest.getTo(), DirectionsRequest.getFrom()) are not in the same building.