Navigator

Registers a listener for arrival events.

Note: In order to avoid memory leaks, use removeArrivalListener(ArrivalListener) to remove the listener that is no longer required.

Registers a listener for new navigation sessions.

Note: In order to avoid memory leaks, use removeNavigationSessionListener(NavigationSessionListener) to remove the listener that is no longer required.

Registers a listener for when the remaining time or distance to the destination changes by more than a specified threshold.

The listener could be called as a result of (for example) user movement, a change in traffic conditions OR a change in route OR a change in destination, or when the remaining time and distance first become known.

Note: In order to avoid memory leaks, use removeRemainingTimeOrDistanceChangedListener(RemainingTimeOrDistanceChangedListener) to remove the listener that is no longer required.

Note: Same listener instance can be added with different threshold values however, calling removeRemainingTimeOrDistanceChangedListener(RemainingTimeOrDistanceChangedListener) using that particular instance will remove it altogether.

Registers a listener for route changed events.

Note: In order to avoid memory leaks, use removeRouteChangedListener(RouteChangedListener) to remove the listener that is no longer required.

Cleans up internal state of the Navigator.

Note: calling this method will cancel any pending requests to setDestinations(List).

Clears all previously set destinations and removes any calculated routes from the map. If navigation is running, this will automatically stop it.

Clears license plate information about the current driver. This will only apply to setDestination calls made after this value is set.

Clears the listener for changes in remaining time or distance.

Removes the current destination. Following this call, guidance will be toward the next destination, and information about the old destination is not available.

Returns route information for routes based on each value of RoutingOptions.RoutingStrategy. RoutingOptions.RoutingStrategy is ignored since this method returns the route information for all routing strategies.

Note: This is recalculated on every call and may not match the routes currently being used by navigation since traffic and other factors may have been updated in the interim.

Returns the current segment of the journey. This RouteSegment will have its starting position as the most recent known (road-snapped) position of the device.

Returns the estimated time and distance from the current position to the current destination.

Returns a list of route segments. The destination of each returned segment will correspond to a destination set by setDestination(s).

Returns a Simulator object, for use during testing.

Returns a list of times and distances corresponding to each destination in the current route, representing the estimated time and distance from the current position to each destination.

Returns the route traveled so far during this guidance session (since the last call to startGuidance()). The route recorded consists of the road-snapped locations as would be returned by the RoadSnappedLocationProvider, and simplified to remove redundant points, for example turning consecutive colinear points into a single line segment.

Returns true if guidance is currently running. Note that guidance will only run once a route to a destination has been computed and startGuidance() has been called.

Removes a listener added via addArrivalListener(ArrivalListener).

Removes the listener added via addNavigationSessionListener(NavigationSessionListener).

Removes the listener added via addRemainingTimeOrDistanceChangedListener(int, int, RemainingTimeOrDistanceChangedListener).

Removes the listener added via addRouteChangedListener(RouteChangedListener).

Registers a listener for arrival events. Overrides any previously registered listeners.

Note: In order to avoid memory leaks, setNavArrivalListener(null) should be called when the listener is no longer required.

Sets which types of audio guidance (including vibration) are enabled. By default, vibration, voice, and voice over Bluetooth (if available) are enabled.

This method must be called on the UI thread.

Sets a single destination for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

Sets a single destination for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination. The default DisplayOptions will be used to display the route.

Sets a single destination for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination. The default RoutingOptions will be used to find the route, and the default DisplayOptions will be used to display it.

Sets multiple destinations for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination. The default DisplayOptions will be used to display the route.

Sets destinations for navigation using a route token to navigate on a precomputed route, overriding any previously set destinations. Routes will be the same, modulo changes to the driver starting location and to road/traffic conditions.

The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

The default DisplayOptions will be used to display the route.

Sets destinations for navigation using a route token to navigate on a precomputed route using CustomRoutesOptions, overriding any previously set destinations. Routes will be the same, modulo changes to the driver starting location and to road/traffic conditions.

The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

Sets multiple destinations for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

Sets multiple destinations for navigation, overriding any previously set destinations. The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination. The default RoutingOptions will be used to find the route, and the default DisplayOptions will be used to display it.

Sets destinations for navigation using a route token to navigate on a precomputed route, overriding any previously set destinations. Routes will be the same, modulo changes to the driver starting location and to road/traffic conditions.

The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

Sets destinations for navigation using a route token to navigate on a precomputed route using CustomRoutesOptions, overriding any previously set destinations. Routes will be the same, modulo changes to the driver starting location and to road/traffic conditions.

The returned future will be set to Navigator.RouteStatus.OK if a route is found from the user's location to the given destination.

The default DisplayOptions will be used to display the route.

Sets whether heads-up notifications should be shown. By default, the notification is enabled. Heads-up events are guidance events such as turns, etc, that are displayed when there is no map visible.

This method must be called on the UI thread.

Sets license plate information about the current driver. This allows us to route around certain types of road restrictions which are based on license plate number. This will only apply to setDestination calls made after this value is set. Ideally you'd call this immediately after getting the navigator.

Registers a listener for when the remaining time or distance to the destination changes by more than a specified threshold. Overrides any previously registered listeners.

The listener could be called as a result of (for example) user movement, a change in traffic conditions, a change in route, a change in destination, or when the remaining time and distance first become known.

Note: In order to avoid memory leaks, clearNavProgressionListener() should be called when the listener is no longer required.

Registers a listener for route changed events. Overrides any previously registered listeners.

Note: In order to avoid memory leaks, setNavRouteChangeListener(null) should be called when the listener is no longer required.

Sets SpeedAlertOptions for customizing the triggering thresholds for SpeedAlertSeveritys.

You can use this method to customize the speed alert triggering thresholds in percentage for both SpeedAlertSeverity.MINOR and SpeedAlertSeverity.MAJOR alerts. You can also use this method to configure the time in seconds needed to upgrade speed alerts from SpeedAlertSeverity.MINOR to SpeedAlertSeverity.MAJOR.

By setting a null SpeedAlertOptions or not setting any, you won't receive any speeding feed data, and the NavSDK’s default speed alert will display: speed alert shows red text in white/dark background for day/night mode respectively when the speed is less than 5 mph or 10 kph over the speed limit, and shows white text in red background when speeding more than 5 mph or 10 kph.

The triggering thresholds configured in SpeedAlertOptions are used to decide whether to display minor or major alerts.

Registers a SpeedingListener for the percentage above the speed limit the driver is currently driving at.

By setting a null SpeedingListener or not setting any, you won't receive any speeding feed data.

Sets the ongoing transaction IDs. This API should be used when a new navigation session starts (in the Navigator.NavigationSessionListener.onNewNavigationSession()) and when the transaction IDs change in an ongoing navigation session (e.g. when the list of journey segments is updated).

The transactionIds parameter should be populated with unique string identifiers for one or more transactions that apply to the following events during the current navigation.

This will overwrite any transaction IDs set before.

Transaction IDs will be cleared at the end of the navigation session.

Each transaction ID must be at least 1 and at most 64 characters long, and there is a maximum of 100 transaction IDs per call.

Currently this API will only be used by DriverSDK, and should be ignored by other clients.

The same as startGuidance(), but specifying an intent that can be used to resume the application from the navigator's status bar notification. Without this intent it is not possible to resume the application from the status bar.

If a destination has been set and a route computed for it, starts turn-by-turn navigation guidance for the route. If a route has not yet been computed, turn-by-turn guidance will start once it has.

You must explicitly call stopGuidance() to stop the navigation service. The navigation service will not automatically stop upon arrival. If you want to stop the navigation service upon arrival, you need to call stopGuidance() in the NavArrivalListener.

Note: this method does not change the position of the Camera.

Stops turn-by-turn navigation guidance.