NavGraphNavigator

Kotlin |Java

open class NavGraphNavigator : Navigator<NavGraph!>

kotlin.Any
↳	androidx.navigation.Navigator<androidx.navigation.NavGraph>
	↳	androidx.navigation.NavGraphNavigator

Known Direct Subclasses

DynamicGraphNavigator

Navigator for graphs in dynamic feature modules.

A Navigator built specifically for NavGraph elements. Handles navigating to the correct destination when the NavGraph is the target of navigation actions.

Summary

Public constructors
`<init>(@NonNull navigatorProvider: NavigatorProvider)` Construct a Navigator capable of routing incoming navigation requests to the proper destination within a `NavGraph`.

Public methods
open NavGraph	`createDestination()` Creates a new `NavGraph` associated with this navigator.
open NavDestination?	`navigate(@NonNull destination: NavGraph, @Nullable args: Bundle?, @Nullable navOptions: NavOptions?, @Nullable navigatorExtras: Navigator.Extras?)`
open Boolean	`popBackStack()`

Inherited functions

From class Navigator

Unit

onRestoreState(@NonNull savedState: Bundle)

Restore any state previously saved in onSaveState(). This will be called before any calls to navigate(NavDestination, Bundle, NavOptions, Navigator.Extras) or popBackStack().

Calls to createDestination() should not be dependent on any state restored here as createDestination() can be called before the state is restored.

Bundle?

onSaveState()

Called to ask for a Bundle representing the Navigator's state. This will be restored in onRestoreState(Bundle).

Public constructors

<init>

NavGraphNavigator(@NonNull navigatorProvider: NavigatorProvider)

Construct a Navigator capable of routing incoming navigation requests to the proper destination within a NavGraph.

Parameters
`navigatorProvider`	NavigatorProvider: NavigatorProvider used to retrieve the correct `Navigator` to navigate to the start destination

Public methods

createDestination

@NonNull open fun createDestination(): NavGraph

Creates a new NavGraph associated with this navigator.

Return
`NavGraph`	The created `NavGraph`.

navigate

@Nullable open fun navigate(
    @NonNull destination: NavGraph, 
    @Nullable args: Bundle?, 
    @Nullable navOptions: NavOptions?, 
    @Nullable navigatorExtras: Navigator.Extras?
): NavDestination?

popBackStack

open fun popBackStack(): Boolean