Package es.situm.sdk.navigation

Interface NavigationManager

public interface NavigationManager

Central point to update the progress of a user when follows a route

Method Summary

Modifier and Type	Method	Description
void	addNavigationListener(NavigationListener listener)	Adds a NavigationListener that will receive the navigation events.
Route	getRoute()	Returns the initial route requested to navigate when calling requestNavigationUpdates(NavigationRequest) In case there is no on-going navigation, null will be returned.
boolean	isRunning()	Returns true if the navigation is running, false otherwise
void	removeAllNavigationListeners()	If any, removes all the NavigationListeners previously subscribed.
void	removeNavigationListener(NavigationListener listener)	Removes the given NavigationListener.
boolean	removeUpdates()	Removes all location updates.
void	requestNavigationUpdates(NavigationRequest request)	Request navigation updates using the given NavigationRequest.
void	requestNavigationUpdates(NavigationRequest navigationRequest, DirectionsRequest directionsRequest, Handler<Route> callback)	Request navigation updates.
void	requestNavigationUpdates(NavigationRequest request, NavigationListener listener)	Request navigation updates using the given NavigationRequest and sets the listener that receives the updated navigation progress.
void	updateNavigationState(ExternalNavigation externalNavigation)	For internal use only
boolean	updateWithLocation(Location location)	Informs NavigationManager object the change of the user's location

Method Details

requestNavigationUpdates

void requestNavigationUpdates(@NonNull
 NavigationRequest request)
                       throws IllegalArgumentException

Request navigation updates using the given NavigationRequest. Can only exist one navigation at a time. If this method was previously invoked and removeUpdates() wasn't, removeUpdates() will be called internally.

Parameters:

request - NavigationRequest with navigation params. NavigationRequest.getRoute() can't be null, and NavigationRequest.getDistanceToGoalThreshold() and NavigationRequest.getOutsideRouteThreshold() must be greater than 0.

Throws:

IllegalArgumentException - if request or NavigationRequest.getRoute() are null, or if NavigationRequest.getDistanceToGoalThreshold() or NavigationRequest.getOutsideRouteThreshold() have 0 or negative value.

addNavigationListener

void addNavigationListener(@NonNull
 NavigationListener listener)
                    throws IllegalArgumentException

Adds a NavigationListener that will receive the navigation events.

Parameters:

listener - The NavigationListener.

Throws:

IllegalArgumentException

removeNavigationListener

void removeNavigationListener(@NonNull
 NavigationListener listener)
                       throws IllegalArgumentException

Removes the given NavigationListener.

Parameters:

listener - The NavigationListener that will be removed.

Throws:

IllegalArgumentException - if listener is null.

removeAllNavigationListeners

void removeAllNavigationListeners()

If any, removes all the NavigationListeners previously subscribed.

requestNavigationUpdates

void requestNavigationUpdates(@NonNull
 NavigationRequest request,
 @NonNull
 NavigationListener listener)
                       throws IllegalArgumentException

Request navigation updates using the given NavigationRequest and sets the listener that receives the updated navigation progress.

Removes all the LocationListeners previously provided.

Can only exist one navigation with one listener at a time. If this method was previously invoked and removeUpdates() wasn't, removeUpdates() will be called internally.

Parameters:

request - NavigationRequest with navigation params. NavigationRequest.getRoute() can't be null, and NavigationRequest.getDistanceToGoalThreshold() and NavigationRequest.getOutsideRouteThreshold() must be greater than 0.

listener - NavigationListener that receives updates of navigation progress.

Throws:

IllegalArgumentException - if listener, request or NavigationRequest.getRoute() are null, or if NavigationRequest.getDistanceToGoalThreshold() or NavigationRequest.getOutsideRouteThreshold() have 0 or negative value.

requestNavigationUpdates

void requestNavigationUpdates(@NonNull
 NavigationRequest navigationRequest,
 @NonNull
 DirectionsRequest directionsRequest,
 @NonNull
 Handler<Route> callback)
                       throws IllegalArgumentException

Request navigation updates. This is an overload of requestNavigationUpdates(NavigationRequest) that calculates the route for you and automatically starts navigation when the route is obtained. To calculate the route you will need to provide the DirectionsRequest. As it is evident, you don't need to pass a Route into the given NavigationRequest. Using this method the SDK will automatically call updateWithLocation(Location) every time the location is updated, so you don't need to do it by your side.

Parameters:

navigationRequest - NavigationRequest with navigation params.

directionsRequest - DirectionsRequest with directions params.

callback - Handler that will receive the success or failure callbacks on the route calculation.

Throws:

IllegalArgumentException - if navigationRequest, directionsRequest or callback are null, or if NavigationRequest.getDistanceToGoalThreshold() or NavigationRequest.getOutsideRouteThreshold() have 0 or negative value.

updateWithLocation

boolean updateWithLocation(@NonNull
 Location location)

Informs NavigationManager object the change of the user's location

Parameters:

location - new Location of the user. If null, nothing is done

Returns:

true if there is a listener to which notify progress update. False if there isn't, so this method do nothing.

removeUpdates

boolean removeUpdates()

Removes all location updates. This removes the internal state of the manager, including the listener provided in requestNavigationUpdates(NavigationRequest, NavigationListener), so it won't receive more progress updates.

Returns:

true if a listener was removed. False if there was no listener.

isRunning

boolean isRunning()

Returns true if the navigation is running, false otherwise

updateNavigationState

void updateNavigationState(ExternalNavigation externalNavigation)

For internal use only

getRoute

@Nullable
Route getRoute()

Returns the initial route requested to navigate when calling requestNavigationUpdates(NavigationRequest) In case there is no on-going navigation, null will be returned.