NavController

KEY_DEEP_LINK_INTENT

static val KEY_DEEP_LINK_INTENT: String

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

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

<init>

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.

onHandleDeepLink

open fun onHandleDeepLink(intent: Intent?): Boolean

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 added via NavDestination#addDeepLink(String).

The navigation graph should be set before calling this method.

getGraph

open fun getGraph(): NavGraph!

Gets the topmost navigation graph associated with this NavController.

addOnNavigatedListener

open fun addOnNavigatedListener(listener: NavController.OnNavigatedListener): Unit

Adds an OnNavigatedListener to this controller to receive events when the controller navigates to a new destination.

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

getNavInflater

open fun getNavInflater(): NavInflater

Returns the inflater for this controller.

createDeepLink

open fun createDeepLink(): NavDeepLinkBuilder

Create a deep link to a destination within this NavController.

navigateUp

open fun navigateUp(): Boolean

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.

navigate

fun navigate(resId: Int): Unit

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

navigate

fun navigate(resId: Int, args: Bundle?): Unit

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

navigate

open fun navigate(resId: Int, args: Bundle?, navOptions: NavOptions?): Unit

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

navigate

open fun navigate(directions: NavDirections): Unit

Navigate via the given NavDirections

navigate

open fun navigate(directions: NavDirections, navOptions: NavOptions?): Unit

Navigate via the given NavDirections

restoreState

open fun restoreState(navState: Bundle?): Unit

Restores all navigation controller state from a bundle.

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

saveState

open fun saveState(): Bundle?

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.

removeOnNavigatedListener

open fun removeOnNavigatedListener(listener: NavController.OnNavigatedListener): Unit

Removes an OnNavigatedListener from this controller. It will no longer receive navigation events.

popBackStack

open fun popBackStack(): Boolean

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

open fun popBackStack(destinationId: Int, inclusive: Boolean): Boolean

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

getCurrentDestination

open fun getCurrentDestination(): NavDestination!

Gets the current destination.

setMetadataGraph

open fun setMetadataGraph(): Unit

Sets the navigation graph as specified in the application manifest.

Applications may declare a graph resource in their manifest instead of declaring or passing this data to each host or controller:

The inflated graph can be retrieved via #getGraph().

setGraph

open fun setGraph(graphResId: Int): Unit

Sets the navigation graph to the specified resource. Any current navigation graph data will be replaced.

The inflated graph can be retrieved via #getGraph().

setGraph

open fun setGraph(graph: NavGraph): Unit

Sets the navigation graph to the specified graph. Any current navigation graph data will be replaced.

The graph can be retrieved later via #getGraph().

getNavigatorProvider

open fun getNavigatorProvider(): NavigatorProvider

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.