NavController

KEY_DEEP_LINK_INTENT

public static final String KEY_DEEP_LINK_INTENT

The Intent that triggered a deep link to the current destination.

Constant Value: "android-support-nav:controller:deepLinkIntent"

NavController

public NavController (Context context)

Constructs a new controller for a given Context. Controllers should not be used outside of their context and retain a hard reference to the context supplied. If you need a global controller, pass Context.getApplicationContext().

Apps should generally not construct controllers, instead obtain a relevant controller directly from a navigation host via NavHost.getNavController() or by using one of the utility methods on the Navigation class.

Note that controllers that are not constructed with an Activity context (or a wrapped activity context) will only be able to navigate to new tasks or new document tasks when navigating to new activities.

addOnDestinationChangedListener

public void addOnDestinationChangedListener (NavController.OnDestinationChangedListener listener)

Adds an NavController.OnDestinationChangedListener to this controller to receive a callback whenever the getCurrentDestination() or its arguments change.

The current destination, if any, will be immediately sent to your listener.

createDeepLink

public NavDeepLinkBuilder createDeepLink ()

Create a deep link to a destination within this NavController.

getBackStackEntry

public NavBackStackEntry getBackStackEntry (int destinationId)

Gets the topmost NavBackStackEntry for a destination id.

This is always safe to use with the current destination or its parent or grandparent navigation graphs as these destinations are guaranteed to be on the back stack.

getCurrentBackStackEntry

public NavBackStackEntry getCurrentBackStackEntry ()

Gets the topmost NavBackStackEntry.

getCurrentDestination

public NavDestination getCurrentDestination ()

Gets the current destination.

getGraph

public NavGraph getGraph ()

Gets the topmost navigation graph associated with this NavController.

getNavInflater

public NavInflater getNavInflater ()

Returns the inflater for this controller.

getNavigatorProvider

public NavigatorProvider getNavigatorProvider ()

Retrieve the NavController's NavigatorProvider. All Navigators used to construct the navigation graph for this nav controller should be added to this navigator provider before the graph is constructed.

Generally, the Navigators are set for you by the NavHost hosting this NavController and you do not need to manually interact with the navigator provider.

getPreviousBackStackEntry

public NavBackStackEntry getPreviousBackStackEntry ()

Gets the previous visible NavBackStackEntry.

This skips over any NavBackStackEntry that is associated with a NavGraph.

getViewModelStoreOwner

public ViewModelStoreOwner getViewModelStoreOwner (int navGraphId)

Gets the ViewModelStoreOwner for a NavGraph. This can be passed to ViewModelProvider to retrieve a ViewModel that is scoped to the navigation graph - it will be cleared when the navigation graph is popped off the back stack.

handleDeepLink

public boolean handleDeepLink (Intent intent)

Checks the given Intent for a Navigation deep link and navigates to the deep link if present. This is called automatically for you the first time you set the graph if you've passed in an Activity as the context when constructing this NavController, but should be manually called if your Activity receives new Intents in Activity.onNewIntent(Intent).

The types of Intents that are supported include:

Intents created by NavDeepLinkBuilder or createDeepLink(). This assumes that the current graph shares the same hierarchy to get to the deep linked destination as when the deep link was constructed.
Intents that include a data Uri. This Uri will be checked against the Uri patterns in the NavDeepLinks added via NavDestination.addDeepLink(NavDeepLink).

The navigation graph should be set before calling this method.

navigate

public void navigate (Uri deepLink, 
                NavOptions navOptions, 
                Navigator.Extras navigatorExtras)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink(Uri) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigate

public void navigate (int resId, 
                Bundle args)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

navigate

public void navigate (Uri deepLink)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink(Uri) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigate

public void navigate (NavDirections directions)

Navigate via the given NavDirections

navigate

public void navigate (int resId, 
                Bundle args, 
                NavOptions navOptions, 
                Navigator.Extras navigatorExtras)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

navigate

public void navigate (NavDirections directions, 
                NavOptions navOptions)

Navigate via the given NavDirections

navigate

public void navigate (NavDeepLinkRequest request)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink(NavDeepLinkRequest) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigate

public void navigate (int resId)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

navigate

public void navigate (int resId, 
                Bundle args, 
                NavOptions navOptions)

Navigate to a destination from the current navigation graph. This supports both navigating via an action and directly navigating to a destination.

navigate

public void navigate (NavDeepLinkRequest request, 
                NavOptions navOptions)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink(NavDeepLinkRequest) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigate

public void navigate (NavDirections directions, 
                Navigator.Extras navigatorExtras)

Navigate via the given NavDirections

navigate

public void navigate (Uri deepLink, 
                NavOptions navOptions)

Navigate to a destination via the given deep link Uri. NavDestination.hasDeepLink(Uri) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigate

public void navigate (NavDeepLinkRequest request, 
                NavOptions navOptions, 
                Navigator.Extras navigatorExtras)

Navigate to a destination via the given NavDeepLinkRequest. NavDestination.hasDeepLink(NavDeepLinkRequest) should be called on the navigation graph prior to calling this method to check if the deep link is valid. If an invalid deep link is given, an IllegalArgumentException will be thrown.

navigateUp

public boolean navigateUp ()

Attempts to navigate up in the navigation hierarchy. Suitable for when the user presses the "Up" button marked with a left (or start)-facing arrow in the upper left (or starting) corner of the app UI.

The intended behavior of Up differs from Back when the user did not reach the current destination from the application's own task. e.g. if the user is viewing a document or link in the current app in an activity hosted on another app's task where the user clicked the link. In this case the current activity (determined by the context used to create this NavController) will be finished and the user will be taken to an appropriate destination in this app on its own task.

popBackStack

public boolean popBackStack ()

Attempts to pop the controller's back stack. Analogous to when the user presses the system Back button when the associated navigation host has focus.

popBackStack

public boolean popBackStack (int destinationId, 
                boolean inclusive)

Attempts to pop the controller's back stack back to a specific destination.

removeOnDestinationChangedListener

public void removeOnDestinationChangedListener (NavController.OnDestinationChangedListener listener)

Removes an NavController.OnDestinationChangedListener from this controller. It will no longer receive callbacks.

restoreState

public void restoreState (Bundle navState)

Restores all navigation controller state from a bundle. This should be called before any call to setGraph(NavGraph).

State may be saved to a bundle by calling saveState(). Restoring controller state is the responsibility of a NavHost.

saveState

public Bundle saveState ()

Saves all navigation controller state to a Bundle.

State may be restored from a bundle returned from this method by calling restoreState(Bundle). Saving controller state is the responsibility of a NavHost.

setGraph

public void setGraph (NavGraph graph, 
                Bundle startDestinationArgs)

Sets the navigation graph to the specified graph. Any current navigation graph data (including back stack) will be replaced.

The graph can be retrieved later via getGraph().

setGraph

public void setGraph (int graphResId, 
                Bundle startDestinationArgs)

Sets the navigation graph to the specified resource. Any current navigation graph data (including back stack) will be replaced.

The inflated graph can be retrieved via getGraph().

setGraph

public void setGraph (int graphResId)

Sets the navigation graph to the specified resource. Any current navigation graph data (including back stack) will be replaced.

The inflated graph can be retrieved via getGraph().

setGraph

public void setGraph (NavGraph graph)

Sets the navigation graph to the specified graph. Any current navigation graph data (including back stack) will be replaced.

The graph can be retrieved later via getGraph().