DynamicGraphNavigator.DynamicNavGraph

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

Added in 2.3.0

Kotlin |Java

class DynamicGraphNavigator.DynamicNavGraph : NavGraph

kotlin.Any
↳	androidx.navigation.NavDestination
	↳	androidx.navigation.NavGraph
		↳	androidx.navigation.dynamicfeatures.DynamicGraphNavigator.DynamicNavGraph

The NavGraph for dynamic features.

Summary

Public constructors
`DynamicNavGraph( navGraphNavigator: DynamicGraphNavigator, navigatorProvider: NavigatorProvider )`

Public functions
`open operator Boolean`	`equals(other: Any?)`
`open Int`	`hashCode()`
`open Unit`	`onInflate(context: Context, attrs: AttributeSet)` Called when inflating a destination from a resource.

Public properties
`String?`	`moduleName` The dynamic feature's module name.
`Int`	`progressDestination` Resource id of progress destination.

Inherited functions

From kotlin.collections.Iterable

`open Unit`	`forEach(@RecentlyNonNull p0: Consumer<NavDestination>)`
`open Spliterator<NavDestination>`	`@RecentlyNonNull spliterator()`

From androidx.navigation.NavDestination

`Unit`	`addArgument(argumentName: String, argument: NavArgument)` Sets an argument type for an argument name
`Unit`	`addDeepLink(navDeepLink: NavDeepLink)` Add a deep link to this destination.
`Unit`	`addDeepLink(uriPattern: String)` Add a deep link to this destination.
`String?`	`fillInLabel(context: Context, bundle: SavedState?)` Parses a dynamic label containing arguments into a String.
`NavAction?`	`getAction(id: @IdRes Int)` Returns the `NavAction` for the given action ID.
`open Boolean`	`hasDeepLink(deepLinkRequest: NavDeepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink`.
`open Boolean`	`hasDeepLink(deepLink: Uri)` Checks the given deep link `Uri`, and determines whether it matches a Uri pattern added to the destination by a call to `addDeepLink` .
`Unit`	`putAction(actionId: @IdRes Int, action: NavAction)` Sets the `NavAction` destination for an action ID.
`Unit`	`putAction(actionId: @IdRes Int, destId: @IdRes Int)` Creates a `NavAction` for the given `destId` and associates it with the `actionId`.
`Unit`	`removeAction(actionId: @IdRes Int)` Unsets the `NavAction` for an action ID.
`Unit`	`removeArgument(argumentName: String)` Unsets the argument type for an argument name.

From androidx.navigation.NavGraph

`Unit`	`addAll(other: NavGraph)` Add all destinations from another collection to this one.
`Unit`	`addDestination(node: NavDestination)` Adds a destination to this NavGraph.
`Unit`	`addDestinations(nodes: Collection<NavDestination?>)` Adds multiple destinations to this NavGraph.
`Unit`	`addDestinations(vararg nodes: NavDestination)` Adds multiple destinations to this NavGraph.
`Unit`	`clear()` Clear all destinations from this navigation graph.
`inline NavDestination?`	`<T : Any?> findNode()` Finds a destination in the collection by route from `KClass`.
`NavDestination?`	`findNode(resId: @IdRes Int)` Finds a destination in the collection by ID.
`NavDestination?`	`findNode(route: KClass<*>)` Finds a destination in the collection by route from `KClass`.
`NavDestination?`	`<T : Any?> findNode(route: T?)` Finds a destination in the collection by route from Object.
`NavDestination?`	`findNode(route: String?)` Finds a destination in the collection by route.
`@IdRes Int`	`getStartDestination()` This function is deprecated. Use getStartDestinationId instead.
`final operator MutableIterator<NavDestination>`	`iterator()`
`Unit`	`remove(node: NavDestination)` Remove a given destination from this NavGraph
`inline Unit`	`<T : Any> setStartDestination()` Sets the starting destination for this NavGraph.
`Unit`	`setStartDestination(startDestId: Int)` Sets the starting destination for this NavGraph.
`Unit`	`<T : Any> setStartDestination(startDestRoute: KClass<T>)` Sets the starting destination for this NavGraph.
`Unit`	`<T : Any> setStartDestination(startDestRoute: T)` Sets the starting destination for this NavGraph.
`Unit`	`setStartDestination(startDestRoute: String)` Sets the starting destination for this NavGraph.
`open String`	`toString()`

Inherited properties

From androidx.navigation.NavDestination

`Map<String, NavArgument>`	`arguments` The arguments supported by this destination.
`Int`	`id` The destination's unique ID.
`CharSequence?`	`label` The descriptive label of this destination.
`String`	`navigatorName` The name associated with this destination's `Navigator`.
`NavGraph?`	`parent` Gets the `NavGraph` that contains this destination.
`String?`	`route` The destination's unique route.

From androidx.navigation.NavGraph

`Int`	`startDestinationId` The starting destination id for this NavGraph.
`String?`	`startDestinationRoute` The route for the starting destination for this NavGraph.

Public constructors

Added in 2.3.0

DynamicNavGraph(
    navGraphNavigator: DynamicGraphNavigator,
    navigatorProvider: NavigatorProvider
)

Public functions

equals

open operator fun equals(other: Any?): Boolean

hashCode

open fun hashCode(): Int

onInflate

open fun onInflate(context: Context, attrs: AttributeSet): Unit

Called when inflating a destination from a resource.

Parameters
`context: Context`	local context performing inflation
`attrs: AttributeSet`	attrs to parse during inflation

Public properties

moduleName

Added in 2.3.0

var moduleName: String?

The dynamic feature's module name.

progressDestination

Added in 2.3.0

var progressDestination: Int

Resource id of progress destination. This will be preferred over any default progress destination set by installDefaultProgressDestination.