Summary: Inherited Constants | Ctors | Methods | Inherited Methods

NavHostController

Kotlin |Java

public class NavHostController
extends NavController

java.lang.Object
↳	androidx.navigation.NavController
	↳	androidx.navigation.NavHostController

Subclass of NavController that offers additional APIs for use by a NavHost to connect the NavController to external dependencies.

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.

Summary

Inherited constants

From class androidx.navigation.NavController

String

KEY_DEEP_LINK_INTENT

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

Public constructors
`NavHostController(Context context)` Construct a new controller for a given `Context` suitable for use in a `NavHost`.

Public methods
`final void`	`enableOnBackPressed(boolean enabled)` Set whether the NavController should handle the system Back button events via the registered `OnBackPressedDispatcher`.
`final void`	`setLifecycleOwner(LifecycleOwner owner)` Sets the host's `LifecycleOwner`.
`final void`	`setOnBackPressedDispatcher(OnBackPressedDispatcher dispatcher)` Sets the host's `OnBackPressedDispatcher`.
`final void`	`setViewModelStore(ViewModelStore viewModelStore)` Sets the host's ViewModelStore used by the NavController to store ViewModels at the navigation graph level.

Inherited methods

From class


        
          androidx.navigation.NavController

`void`	`addOnDestinationChangedListener(NavController.OnDestinationChangedListener listener)` Adds an `NavController.OnDestinationChangedListener` to this controller to receive a callback whenever the `getCurrentDestination()` or its arguments change.
`NavDeepLinkBuilder`	`createDeepLink()` Create a deep link to a destination within this NavController.
`NavBackStackEntry`	`getBackStackEntry(int destinationId)` Gets the topmost `NavBackStackEntry` for a destination id.
`NavBackStackEntry`	`getCurrentBackStackEntry()` Gets the topmost `NavBackStackEntry`.
`NavDestination`	`getCurrentDestination()` Gets the current destination.
`NavGraph`	`getGraph()` Gets the topmost navigation graph associated with this NavController.
`NavInflater`	`getNavInflater()` Returns the `inflater` for this controller.
`NavigatorProvider`	`getNavigatorProvider()` Retrieve the NavController's `NavigatorProvider`.
`NavBackStackEntry`	`getPreviousBackStackEntry()` Gets the previous visible `NavBackStackEntry`.
`ViewModelStoreOwner`	`getViewModelStoreOwner(int navGraphId)` Gets the `ViewModelStoreOwner` for a NavGraph.
`boolean`	`handleDeepLink(Intent intent)` Checks the given Intent for a Navigation deep link and navigates to the deep link if present.
`void`	`navigate(Uri deepLink, NavOptions navOptions, Navigator.Extras navigatorExtras)` Navigate to a destination via the given deep link `Uri`.
`void`	`navigate(int resId, Bundle args)` Navigate to a destination from the current navigation graph.
`void`	`navigate(Uri deepLink)` Navigate to a destination via the given deep link `Uri`.
`void`	`navigate(NavDirections directions)` Navigate via the given `NavDirections`
`void`	`navigate(int resId, Bundle args, NavOptions navOptions, Navigator.Extras navigatorExtras)` Navigate to a destination from the current navigation graph.
`void`	`navigate(NavDirections directions, NavOptions navOptions)` Navigate via the given `NavDirections`
`void`	`navigate(int resId)` Navigate to a destination from the current navigation graph.
`void`	`navigate(int resId, Bundle args, NavOptions navOptions)` Navigate to a destination from the current navigation graph.
`void`	`navigate(NavDirections directions, Navigator.Extras navigatorExtras)` Navigate via the given `NavDirections`
`void`	`navigate(Uri deepLink, NavOptions navOptions)` Navigate to a destination via the given deep link `Uri`.
`boolean`	`navigateUp()` Attempts to navigate up in the navigation hierarchy.
`boolean`	`popBackStack()` Attempts to pop the controller's back stack.
`boolean`	`popBackStack(int destinationId, boolean inclusive)` Attempts to pop the controller's back stack back to a specific destination.
`void`	`removeOnDestinationChangedListener(NavController.OnDestinationChangedListener listener)` Removes an `NavController.OnDestinationChangedListener` from this controller.
`void`	`restoreState(Bundle navState)` Restores all navigation controller state from a bundle.
`Bundle`	`saveState()` Saves all navigation controller state to a Bundle.
`void`	`setGraph(NavGraph graph, Bundle startDestinationArgs)` Sets the `navigation graph` to the specified graph.
`void`	`setGraph(int graphResId, Bundle startDestinationArgs)` Sets the `navigation graph` to the specified resource.
`void`	`setGraph(int graphResId)` Sets the `navigation graph` to the specified resource.
`void`	`setGraph(NavGraph graph)` Sets the `navigation graph` to the specified graph.

From class


        
          java.lang.Object

`Object`	`clone()`
`boolean`	`equals(Object arg0)`
`void`	`finalize()`
`final Class<?>`	`getClass()`
`int`	`hashCode()`
`final void`	`notify()`
`final void`	`notifyAll()`
`String`	`toString()`
`final void`	`wait(long arg0, int arg1)`
`final void`	`wait(long arg0)`
`final void`	`wait()`

Public constructors

NavHostController

public NavHostController (Context context)

Construct a new controller for a given Context suitable for use in a NavHost. 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().

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.

Parameters
`context`	`Context`: context for this controller

Public methods

enableOnBackPressed

public final void enableOnBackPressed (boolean enabled)

Set whether the NavController should handle the system Back button events via the registered OnBackPressedDispatcher.

Parameters
`enabled`	`boolean`: True if the NavController should handle system Back button events.

setLifecycleOwner

public final void setLifecycleOwner (LifecycleOwner owner)

Sets the host's LifecycleOwner.

Parameters
`owner`	`LifecycleOwner`: The `LifecycleOwner` associated with the containing `NavHost`.

See also:

setOnBackPressedDispatcher(OnBackPressedDispatcher)

setOnBackPressedDispatcher

public final void setOnBackPressedDispatcher (OnBackPressedDispatcher dispatcher)

Sets the host's OnBackPressedDispatcher. If set, NavController will register a OnBackPressedCallback to handle system Back button events.

You must explicitly called setLifecycleOwner(LifecycleOwner) before calling this method as the owner set there will be used as the LifecycleOwner for registering the OnBackPressedCallback.

You can dynamically enable and disable whether the NavController should handle the system Back button events by calling enableOnBackPressed(boolean).

Parameters
`dispatcher`	`OnBackPressedDispatcher`: The `OnBackPressedDispatcher` associated with the containing `NavHost`.

Throws
`IllegalStateException`	if you have not called `setLifecycleOwner(LifecycleOwner)` before calling this method.

See also:

setLifecycleOwner(LifecycleOwner)

setViewModelStore

public final void setViewModelStore (ViewModelStore viewModelStore)

Sets the host's ViewModelStore used by the NavController to store ViewModels at the navigation graph level. This is required to call NavController.getViewModelStoreOwner(int) and should generally be called for you by your NavHost.

You must call this method before NavController.setGraph(int) or similar methods, because the ViewModelStore set here will be used by the created NavBackStackEntry items.

Parameters
`viewModelStore`	`ViewModelStore`: ViewModelStore used to store ViewModels at the navigation graph level

Throws
`IllegalStateException`	if this method is called when graph was already set via `NavController.setGraph(int)` or similar methods.