NavigationManager (MapQuest Navigation SDK)

```
public interface NavigationManager
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class NavigationManager.Builder

Nested Classes
Modifier and Type	Interface and Description
`static class`	`NavigationManager.Builder`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`addAndNotifyNavigationStartStopListener(NavigationStartStopListener listener)`
`void`	`addAndNotifyProgressListener(NavigationProgressListener listener)`
`void`	`addAndNotifySpeedLimitSpanListener(SpeedLimitSpanListener listener)`
`void`	`addEtaResponseListener(EtaResponseListener etaResponseListener)`
`void`	`addNavigationStartStopListener(NavigationStartStopListener listener)`
`void`	`addProgressListener(NavigationProgressListener listener)`
`void`	`addPromptListener(PromptListener listener)`
`void`	`addRouteResponseListener(RouteResponseListener listener)`
`void`	`addSpeedLimitSpanListener(SpeedLimitSpanListener listener)`
`void`	`addTrafficResponseListener(TrafficResponseListener listener)`
`void`	`advanceRouteToNextLeg()` Advances navigation to the next route-leg of the current route.
`void`	`cancelNavigation()` Cancels the current navigation session.
`void`	`deinitialize()` Called to de-initialize the NavigationManager, to perform any internal shutdown steps needed.
`RouteLeg`	`getCurrentRouteLeg()` Gets the current route-leg of the route being navigated.
`LocationProviderAdapter`	`getLocationProviderAdapter()` Gets the current location-provider adapter that supplies location updates during navigation.
`Route`	`getRoute()` Gets the route being currently navigated.
`UserLocationTrackingConsentStatus`	`getUserLocationTrackingConsentStatus()`
`void`	`initialize()` Called to initialize the NavigationManager, to perform any internal initialization needed.
`boolean`	`isPaused()`
`boolean`	`isReroutingOn()`
`boolean`	`isStopped()`
`void`	`pauseNavigation()` Pauses the current navigation session.
`boolean`	`removeEtaResponseListener(EtaResponseListener etaResponseListener)`
`boolean`	`removeNavigationStartStopListener(NavigationStartStopListener listener)`
`boolean`	`removeProgressListener(NavigationProgressListener listener)`
`boolean`	`removePromptListener(PromptListener listener)`
`boolean`	`removeRouteResponseListener(RouteResponseListener listener)`
`boolean`	`removeSpeedLimitSpanListener(SpeedLimitSpanListener listener)`
`boolean`	`removeTrafficResponseListener(TrafficResponseListener listener)`
`void`	`resumeNavigation()` Resumes the current navigation session.
`void`	`setReroutePreferenceIndicator(ReroutePreferenceIndicator reroutePreferenceIndicator)` Sets a ReroutePreferenceIndicator that can be used to dynamically indicate whether the navigation should reroute.
`void`	`setUserLocationTrackingConsentStatus(UserLocationTrackingConsentStatus userLocationTrackingConsentStatus)` Users must be prompted to provide consent for location tracking.
`void`	`startNavigation(Route route)` Starts navigation along the supplied route.

- Method Detail
  - initialize
```
void initialize()
```
    Called to initialize the NavigationManager, to perform any internal initialization needed. This method should be called immediately after an instance of the NavigationManager is created; and before calling startNavigation(Route) or any other method.
  - deinitialize
```
void deinitialize()
```
    Called to de-initialize the NavigationManager, to perform any internal shutdown steps needed. This method should be called immediately before an instance of the NavigationManager is destroyed, so as to allow it to relinquish any resources that it owns.
  - startNavigation
```
void startNavigation(Route route)
```
    Starts navigation along the supplied route.
    Once navigation has started, the listener method NavigationStartStopListener.onNavigationStarted() is called.
    Note that if the Route started cannot be navigated directly, given the user's current location, the NavigationManager will automatically perform a "re-route" request using the the RouteService -- and as a result of this action, will notify any listeners of the new route received by calling RouteResponseListener.onRouteRetrieved(Route). The NavigationManager will then continue navigation using this new route.
    
    Parameters:
    
    route - the route to navigate.
    
    Throws:
    
    java.lang.IllegalStateException - if setUserLocationTrackingConsentStatus(UserLocationTrackingConsentStatus) is not set to either the GRANTED or DENIED state.
    
    java.lang.IllegalArgumentException - if route is null
  - pauseNavigation
```
void pauseNavigation()
```
    Pauses the current navigation session.
    To resume navigating, call resumeNavigation().
  - resumeNavigation
```
void resumeNavigation()
```
    Resumes the current navigation session.
    This method resumes navigation after a call to pauseNavigation().
  - cancelNavigation
```
void cancelNavigation()
```
    Cancels the current navigation session.
    Note that once the navigation session has been canceled, the listener method NavigationStartStopListener.onNavigationStopped(RouteStoppedReason) will be called with a reason of RouteStoppedReason.ROUTE_CANCELED.
  - isStopped
```
boolean isStopped()
```
    Returns:
    
    true if the current navigation has been stopped for any reason.
    Note that if a NavigationStartStopListener has been defined, when navigation stops the listener method NavigationStartStopListener.onNavigationStopped(RouteStoppedReason) is called with an argument specifying the RouteStoppedReason.
  - isPaused
```
boolean isPaused()
```
    Returns:
    
    true if the current navigation has been paused for any reason.
  - isReroutingOn
```
boolean isReroutingOn()
```
    Returns:
    
    true if reroutes are done when the user goes off the current route
  - getRoute
```
Route getRoute()
```
    Gets the route being currently navigated.
    
    Returns:
    
    the active Route being navigated, or null if no route is active.
  - getCurrentRouteLeg
```
RouteLeg getCurrentRouteLeg()
```
    Gets the current route-leg of the route being navigated.
    
    Returns:
    
    the current RouteLeg of the Route being navigated, or null if no route is active.
  - advanceRouteToNextLeg
```
void advanceRouteToNextLeg()
```
    Advances navigation to the next route-leg of the current route. Note if we are already navigating the final leg of the route, calling this method does nothing.
  - addNavigationStartStopListener
```
void addNavigationStartStopListener(NavigationStartStopListener listener)
```
  - addAndNotifyNavigationStartStopListener
```
void addAndNotifyNavigationStartStopListener(NavigationStartStopListener listener)
```
  - removeNavigationStartStopListener
```
boolean removeNavigationStartStopListener(NavigationStartStopListener listener)
```
  - addProgressListener
```
void addProgressListener(NavigationProgressListener listener)
```
  - addAndNotifyProgressListener
```
void addAndNotifyProgressListener(NavigationProgressListener listener)
```
  - removeProgressListener
```
boolean removeProgressListener(NavigationProgressListener listener)
```
  - addRouteResponseListener
```
void addRouteResponseListener(RouteResponseListener listener)
```
  - removeRouteResponseListener
```
boolean removeRouteResponseListener(RouteResponseListener listener)
```
  - addTrafficResponseListener
```
void addTrafficResponseListener(TrafficResponseListener listener)
```
  - removeTrafficResponseListener
```
boolean removeTrafficResponseListener(TrafficResponseListener listener)
```
  - addSpeedLimitSpanListener
```
void addSpeedLimitSpanListener(SpeedLimitSpanListener listener)
```
  - addAndNotifySpeedLimitSpanListener
```
void addAndNotifySpeedLimitSpanListener(SpeedLimitSpanListener listener)
```
  - removeSpeedLimitSpanListener
```
boolean removeSpeedLimitSpanListener(SpeedLimitSpanListener listener)
```
  - addPromptListener
```
void addPromptListener(PromptListener listener)
```
  - removePromptListener
```
boolean removePromptListener(PromptListener listener)
```
  - addEtaResponseListener
```
void addEtaResponseListener(EtaResponseListener etaResponseListener)
```
  - removeEtaResponseListener
```
boolean removeEtaResponseListener(EtaResponseListener etaResponseListener)
```
  - getLocationProviderAdapter
```
LocationProviderAdapter getLocationProviderAdapter()
```
    Gets the current location-provider adapter that supplies location updates during navigation.
    When navigating a Route using the NavigationManager, the user's location updates are provided to the SDK by a location provider. The abstract class LocationProviderAdapter in the SDK provides a generic "wrapper" for any location-provider of your choice -- for example, a native Google location service, a "mocked" location-provider (e.g. used during testing), or one of the commonly used 3rd-party location libraries such as Mapzen Lost.
    The Navigation SDK Reference Sample Application provides an example implementation using the Mapzen Lost location provider library, named MapzenLocationProviderAdapter -- please refer to the documentation for more details on the LocationProviderAdapter and the implementation of the example MapzenLocationProviderAdapter.
    
    Returns:
    
    the current LocationProviderAdapter being used.
  - getUserLocationTrackingConsentStatus
```
UserLocationTrackingConsentStatus getUserLocationTrackingConsentStatus()
```
  - setUserLocationTrackingConsentStatus
```
void setUserLocationTrackingConsentStatus(UserLocationTrackingConsentStatus userLocationTrackingConsentStatus)
```
    Users must be prompted to provide consent for location tracking. A UserLocationTrackingConsentStatus of either GRANTED or DENIED must be set before navigation can start otherwise startNavigation(Route) will throw an IllegalStateException.
  - setReroutePreferenceIndicator
```
void setReroutePreferenceIndicator(ReroutePreferenceIndicator reroutePreferenceIndicator)
```
    Sets a ReroutePreferenceIndicator that can be used to dynamically indicate whether the navigation should reroute. i.e. The host app could decide to stop reroutes when the user opts to go off route to a gas station or restaurant by having ReroutePreferenceIndicator.shouldReroute() return false. The host app could decide to toggle reroutes back on when it determines that its current off-route location is closer to the destination and a new route is warranted.
    
    Parameters:
    
    reroutePreferenceIndicator - - an implementation of ReroutePreferenceIndicator that indicates whether to reroute. Can pass in null to fall back to the default strategy of always rerouting.

Interface NavigationManager

Nested Class Summary

Method Summary

Method Detail

initialize

deinitialize

startNavigation

pauseNavigation

resumeNavigation

cancelNavigation

isStopped

isPaused

isReroutingOn

getRoute

getCurrentRouteLeg

advanceRouteToNextLeg

addNavigationStartStopListener

addAndNotifyNavigationStartStopListener

removeNavigationStartStopListener

addProgressListener

addAndNotifyProgressListener

removeProgressListener

addRouteResponseListener

removeRouteResponseListener

addTrafficResponseListener

removeTrafficResponseListener

addSpeedLimitSpanListener

addAndNotifySpeedLimitSpanListener

removeSpeedLimitSpanListener

addPromptListener

removePromptListener

addEtaResponseListener

removeEtaResponseListener

getLocationProviderAdapter

getUserLocationTrackingConsentStatus

setUserLocationTrackingConsentStatus

setReroutePreferenceIndicator