NavHostController

Kotlin |Java

open class NavHostController : NavController

kotlin.Any
↳	androidx.navigation.NavController
	↳	androidx.navigation.NavHostController

Known Direct Subclasses

TestNavHostController

Subclass of NavHostController that offers additional APIs for testing Navigation.

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 NavController

String

KEY_DEEP_LINK_INTENT

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

Public constructors
`<init>(@NonNull context: Context)` Construct a new controller for a given `Context` suitable for use in a `NavHost`.

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

Inherited functions

From class NavController

`Unit`	`addOnDestinationChangedListener(@NonNull listener: NavController.OnDestinationChangedListener)` Adds an `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.
`NavDeepLinkBuilder`	`createDeepLink()` Create a deep link to a destination within this NavController.
`NavBackStackEntry`	`getBackStackEntry(@IdRes destinationId: Int)` 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.
`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`. 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.
`NavBackStackEntry?`	`getPreviousBackStackEntry()` Gets the previous visible `NavBackStackEntry`. This skips over any `NavBackStackEntry` that is associated with a `NavGraph`.
`ViewModelStoreOwner`	`getViewModelStoreOwner(@IdRes navGraphId: Int)` Gets the `ViewModelStoreOwner` for a NavGraph. This can be passed to `androidx.lifecycle.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.
`Boolean`	`handleDeepLink(@Nullable 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 `NavDeepLinkBuilde`