Navigation SDK is currently available only to select customers. Contact sales to learn more.

com.google.android.libraries.navigation

Stay organized with collections Save and categorize content based on your preferences.

Annotations

CustomRoutesOptions.TravelMode Specifies the type of transportation used to tailor the directions. 
ForceNightMode Values used for overriding the default night mode (AUTO, FORCE_DAY, FORCE_NIGHT). 
NavigationApi.ErrorCode An ErrorCode is a status code returned by NavigationApi.getNavigator(Activity, NavigatorListener) and NavigationApi.getNavigator(Application, NavigatorListener) when a Navigator could not be successfully obtained. 
NavigationMapStyle This @interface is deprecated. The high-detail map style will soon be automatically enabled in the base map, so there is no distinction between the different enum values.  
NavigationUpdatesOptions.GeneratedStepImagesType Represents the format in which StepInfo maneuver and lane guidance images will be generated. 
Navigator.AudioGuidance AudioGuidance is a set of flags used to specify what kinds of audio alerts and guidance are used during navigation. 
RoutingOptions.RoutingStrategy The routing strategy specifies how routes are ranked, which affects the route that is chosen initially, and during re-routing. 
RoutingOptions.TravelMode Specifies the type of transportation used to tailor the directions. 
TimeAndDistance.DelaySeverity Indicates how heavy traffic is. 

Interfaces

ListenableResultFuture<T> A Future that accepts an onResult listener that will be called on the UI thread. 
ListenableResultFuture.OnResultListener<T> Interface definition for a callback to be invoked when a result is available. 
NavigationApi.NavigatorListener Register a NavigatorListener with NavigationApi.getNavigator(Activity, NavigatorListener) to be notified about the status of said Navigator
NavigationApi.OnTermsResponseListener Register an OnTermsResponseListener with NavigationApi.showTermsAndConditionsDialog(Activity, String, OnTermsResponseListener) to be notified when the user accepts or declines the terms and conditions. 
NavigationView.OnNightModeChangedListener Interface for a listener which will be notified when the UI enters or exits "night mode". 
NavigationView.OnRecenterButtonClickedListener Interface for a listener which will be notified when the recenter button is clicked. 
Navigator A singleton which provides methods for controlling navigation. 
Navigator.ArrivalListener Defines signatures for methods that are called when the driver arrives at a waypoint. 
Navigator.NavigationSessionListener Defines signatures for methods that are called when a new navigation session starts. 
Navigator.RemainingTimeOrDistanceChangedListener Defines signatures for methods that are called when the remaining time or distance to the next destination changes. 
Navigator.ReroutingListener Defines signature for methods called when rerouting is requested in response to the vehicle going off the suggested route. 
Navigator.RouteChangedListener Defines signatures for methods that are called when the route changes. 
Navigator.TrafficUpdatedListener Defines signatures for methods that are called when the route's traffic data gets updated. 
NotificationContentProvider This interface is used by ForegroundServiceManager to provide the notification content when a persistent notification is shared. 
OfflineListener Callback interface that clients can register to be informed of Offline update state or progress percentage changes. 
OnNavigationUiChangedListener Listener interface which notifies when navigation UI changes. 
RoadSnappedLocationProvider Allows subscription to road-snapped user locations. 
RoadSnappedLocationProvider.GpsAvailabilityEnhancedLocationListener A location listener that also listens to the changes in GPS availability. 
RoadSnappedLocationProvider.LocationListener Defines signatures for methods that are called when road-snapped location updates become available. 
RouteInfo Provides the ETA and distance information for routes to a specific waypoint using each RoutingOptions.RoutingStrategy value. 
RouteSegment A RouteSegment is an immutable class which represents a single "leg" of a journey, either from the device's current position to the destination, or from one destination to a subsequent destination, along with NavigationTrafficData along the segment. 
Simulator An interface to send simulated locations to the Nav API, or run the Nav API along simulated routes. 
SpeedingListener Callback to notify you the percentage above the speed limit the driver is currently driving at, and the SpeedAlertSeverity

Classes

ArrivalEvent An immutable event fired upon arrival at a destination. 
CustomRoutesOptions Defines the options used by the Navigator for calculating routes to one or multiple destinations using a route token. 
CustomRoutesOptions.Builder A Builder class to construct instances of CustomRoutesOptions. 
DirectionsListView A View which displays a list of directions for navigation. 
DisplayOptions Defines the options used by the Navigator for displaying a route to a destination. 
ForegroundServiceManager This class allows clients to share a persistent notification by using a common notification id. 
LocationEvent An immutable event containing road-snapped location data. 
NavigationApi Entry point to the Navigation API. 
NavigationRoadStretchRenderingData Defines an individual road stretch within a route polyline, and its rendering style based on traffic conditions. 
NavigationRoadStretchRenderingData.Builder A Builder class for constructing instances of NavigationRoadStretchRenderingData
NavigationTrafficData Contains traffic data for a single "leg" of a journey (as represented by RouteSegment) relative to the current location of the vehicle. 
NavigationTransactionRecorder Contains methods for recording transactions. 
NavigationUpdatesOptions Defines the options used when reporting navigation updates to a service. 
NavigationUpdatesOptions.Builder A builder of NavigationUpdatesOptions
NavigationView A View which displays a map for navigation. 
NavigationViewForAuto A View which displays a map for navigation in Android Auto. 
NightModeChangedEvent An immutable event representing a change in state relating to night mode. 
NotificationContentProviderBase Clients should extend this class if they wish to control the content of the persistent notification. 
RoutingOptions Defines the options used by the Navigator for calculating a route to a destination. 
SimulationOptions Options to be used inside the Simulator. 
SpeedAlertOptions Encapsulates triggering thresholds for different severity levels of speed alerts, represented by SpeedAlertSeverity
SpeedAlertOptions.Builder Builder for building SpeedAlertOptions. 
SpeedometerUiOptions Encapsulates speedometer UI configuration for different severity levels of speed alerts, represented by SpeedAlertSeverity
SpeedometerUiOptions.Builder Builder for building SpeedometerUiOptions
StylingOptions Defines styling options for a NavigationView or NavigationFragment
SupportNavigationFragment A navigation component in an app. 
TermsAndConditionsUIParams An immutable class that represents the parameters used to customize the look and feel of a TermsAndConditionsDialog. 
TermsAndConditionsUIParams.Builder A builder that helps to configure an instance of TermsAndConditionsUIParams
TimeAndDistance A TimeAndDistance is an immutable class which represents both time and distance to a destination. 
Waypoint An immutable waypoint class, used to specify navigation destinations. 
Waypoint.Builder A Builder class to construct instances of Waypoint. 

Enums

AlternateRoutesStrategy Desired display strategy for showing alternate routes. 
CustomControlPosition A set of positions where custom UI controls can be placed on the map. 
NavigationCalloutDisplayMode Desired display strategy for showing route callouts. 
NavigationRoadStretchRenderingData.Style Names of the rendering styles that can be applied to a road stretch. 
NavigationTrafficData.Status The possible status values of the NavigationTrafficData  
Navigator.RouteStatus A RouteStatus is a status code that represents the result of a route calculation, accessed via the Future returned by Navigator.setDestination(Waypoint)
OfflineListener.OfflineState Possible states of the offlining of tiles process. 
RouteCalloutInfoFormat The format specifies whether to show distance or ETA information in route callouts. 
SpeedAlertSeverity A set of values used to specify the severity levels of speed alerts. 
TermsAndConditionsCheckOption An enum specifying options for checking terms and conditions. 

Exceptions

NavigationTransactionRecorder.TransactionException An exception thrown when trying to record a transaction with invalid input. 
Waypoint.InvalidSegmentHeadingException An exception thrown when trying to create a Waypoint with an invalid segment heading. 
Waypoint.UnsupportedPlaceIdException An exception thrown when trying to create a Waypoint from an unsupported Place ID.