NavController

Kotlin |Java

open class NavController

kotlin.Any
↳	androidx.navigation.NavController

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

Known Indirect Subclasses TestNavHostController TestNavHostController Subclass of NavHostController that offers additional APIs for testing Navigation.

NavController manages app navigation within a NavHost.

Apps will generally obtain a controller directly from a host, or by using one of the utility methods on the Navigation class rather than create a controller directly.

Navigation flows and destinations are determined by the navigation graph owned by the controller. These graphs are typically inflated from an Android resource, but, like views, they can also be constructed or combined programmatically or for the case of dynamic navigation structure. (For example, if the navigation structure of the application is determined by live data obtained' from a remote server.)

Summary

Nested classes
abstract	OnDestinationChangedListener OnDestinationChangedListener receives a callback when the getCurrentDestination() or its arguments change.

Constants
static String	KEY_DEEP_LINK_INTENT The Intent that triggered a deep link to the current destination.

Public constructors
<init>(@NonNull context: Context) Constructs a new controller for a given Context.

Public methods
open Unit	addOnDestinationChangedListener(@NonNull listener: NavController.OnDestinationChangedListener) Adds an OnDestinationChangedListener to this controller to receive a callback whenever the getCurrentDestination() or its arguments change.
open NavDeepLinkBuilder	createDeepLink() Create a deep link to a destination within this NavController.
open NavBackStackEntry	getBackStackEntry(@IdRes destinationId: Int) Gets the topmost NavBackStackEntry for a destination id.
open NavBackStackEntry?	getCurrentBackStackEntry() Gets the topmost NavBackStackEntry.
open NavDestination?	getCurrentDestination() Gets the current destination.
open NavGraph	getGraph() Gets the topmost navigation graph associated with this NavController.
open NavInflater	getNavInflater() Returns the inflater for this controller.
open NavigatorProvider	getNavigatorProvider() Retrieve the NavController's NavigatorProvider.
open NavBackStackEntry?	getPreviousBackStackEntry() Gets the previous visible NavBackStackEntry.
open ViewModelStoreOwner	getViewModelStoreOwner(@IdRes navGraphId: Int) Gets the ViewModelStoreOwner for a NavGraph.
open Boolean	handleDeepLink(@Nullable intent: Intent?) Checks the given Intent for a Navigation deep link and navigates to the deep link if present.
open Unit	navigate(@IdRes resId: Int) Navigate to a destination from the current navigation graph.
open Unit	navigate(@IdRes resId: Int, @Nullable args: Bundle?) Navigate to a destination from the current navigation graph.
open Unit	navigate(@IdRes resId: Int, @Nullable args: Bundle?, @Nullable navOptions: NavOptions?) Navigate to a destination from the current navigation graph.
open Unit	navigate(@IdRes resId: Int, @Nullable args: Bundle?, @Nullable navOptions: NavOptions?, @Nullable navigatorExtras: Navigator.Extras?) Navigate to a destination from the current navigation graph.
open Unit	navigate(@NonNull deepLink: Uri) Navigate to a destination via the given deep link Uri.
open Unit	navigate(@NonNull deepLink: