DynamicIncludeGraphNavigator

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

Added in 2.3.0

---

Kotlin |Java

@<Error class: unknown class>
class DynamicIncludeGraphNavigator : Navigator

kotlin.Any
↳	androidx.navigation.Navigator
	↳	androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator

---

Navigator for include-dynamic.

Use it for navigating to NavGraphs contained within a dynamic feature module.

Summary

Nested types
class DynamicIncludeGraphNavigator.DynamicIncludeNavGraph : NavDestination The graph for dynamic-include.

Public constructors
DynamicIncludeGraphNavigator(     context: Context,     navigatorProvider: NavigatorProvider,     navInflater: <Error class: unknown class>,     installManager: DynamicInstallManager )

Public functions
open DynamicIncludeGraphNavigator.DynamicIncludeNavGraph	createDestination()
open Unit	navigate(     entries: List<NavBackStackEntry>,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Navigates to a dynamically included graph from a com.android.dynamic-feature module.
open Unit	onRestoreState(savedState: Bundle)
open Bundle?	onSaveState()

Inherited functions

From androidx.navigation.Navigator open NavDestination? navigate(     destination: DynamicIncludeGraphNavigator.DynamicIncludeNavGraph,     args: SavedState?,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) open Unit @CallSuper onAttach(state: NavigatorState) open Unit onLaunchSingleTop(backStackEntry: NavBackStackEntry) open Unit onRestoreState(savedState: SavedState) open Boolean popBackStack() open Unit popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

Inherited properties
From androidx.navigation.Navigator Boolean isAttached NavigatorState state

Public constructors

DynamicIncludeGraphNavigator

DynamicIncludeGraphNavigator(
    context: Context,
    navigatorProvider: NavigatorProvider,
    navInflater: <Error class: unknown class>,
    installManager: DynamicInstallManager
)

Public functions

createDestination

Added in 2.3.0

open fun createDestination(): DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

navigate

open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

Navigates to a dynamically included graph from a com.android.dynamic-feature module.

Parameters
entries: List<NavBackStackEntry>	destination(s) to navigate to
navOptions: NavOptions?	additional options for navigation
navigatorExtras: Navigator.Extras?	extras unique to your Navigator.

Throws
android.content.res.Resources.NotFoundException	if one of the entries does not have a valid graphResourceName and graphPackage.
kotlin.IllegalStateException	if one of the entries does not have a parent.

See also
navigate

onRestoreState

open fun onRestoreState(savedState: Bundle): Unit

onSaveState

open fun onSaveState(): Bundle?