DynamicNavGraph

Kotlin |Java

class DynamicNavGraph : NavGraph

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

The NavGraph for dynamic features.

Summary

Public constructors
`<init>(navGraphNavigator: DynamicGraphNavigator, navigatorProvider: NavigatorProvider)` The NavGraph for dynamic features.

Public methods
Unit	`onInflate(context: Context, attrs: AttributeSet)`

Inherited functions

From class NavGraph

`Unit`	`addAll(@NonNull other: NavGraph)` Add all destinations from another collection to this one. As each destination has at most one parent, the destinations will be removed from the given NavGraph.
`Unit`	`addDestination(@NonNull node: NavDestination)` Adds a destination to this NavGraph. The destination must have an `NavDestination#getId()` id} set. The destination must not have a `parent` set. If the destination is already part of a `navigation graph`, call `remove(NavDestination)` before calling this method.
`Unit`	`addDestinations(@NonNull nodes: MutableCollection<NavDestination!>)` Adds multiple destinations to this NavGraph. Each destination must have an `NavDestination#getId()` id} set. Each destination must not have a `parent` set. If any destination is already part of a `navigation graph`, call `remove(NavDestination)` before calling this method.
`Unit`	`addDestinations(@NonNull vararg nodes: NavDestination!)` Adds multiple destinations to this NavGraph. Each destination must have an `NavDestination#getId()` id} set. Each destination must not have a `parent` set. If any destination is already part of a `navigation graph`, call `remove(NavDestination)` before calling this method.
`Unit`	`clear()` Clear all destinations from this navigation graph.
`NavDestination?`	`findNode(@IdRes resid: Int)` Finds a destination in the collection by ID. This will recursively check the `parent` of this navigation graph if node is not found in this navigation graph.
`Int`	`getStartDestination()` Returns the starting destination for this NavGraph. When navigating to the NavGraph, this destination is the one the user will initially see.
`MutableIterator<NavDestination!>`	`iterator()`
`Unit`	`remove(@NonNull node: NavDestination)` Remove a given destination from this NavGraph
`Unit`	`setStartDestination(@IdRes startDestId: Int)` Sets the starting destination for this NavGraph.
`String`	`toString()`

From class NavDestination

`Unit`	`addArgument(@NonNull argumentName: String, @NonNull argument: NavArgument)` Sets an argument type for an argument name
`Unit`	`addDeepLink(@NonNull uriPattern: String)` Add a deep link to this destination. Matching Uris sent to `NavController#handleDeepLink(Intent)` or `NavController#navigate(Uri)` will trigger navigating to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments `Bundle` with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.*` wildcard can be used to match 0 or more characters. These Uris can be declared in your navigation XML files by adding one or more `<deepLink app:uri="uriPattern" />` elements as a child to your destination. Deep links added in navigation XML files will automatically replace instances of `${applicationId}` with the applicationId of your app. Programmatically added deep links should use `Context#getPackageName()` directly when constructing the uriPattern.
`Unit`	`addDeepLink(@NonNull navDeepLink: NavDeepLink)` Add a deep link to this destination. Uris that match the given `NavDeepLink` uri sent to `NavController#handleDeepLink(Intent)` or `NavController#navigate(NavDeepLinkRequest)` will trigger navigating to this destination. In addition to a direct Uri match, the following features are supported: Uris without a scheme are assumed as http and https. For example, `www.example.com` will match `http://www.example.com` and `https://www.example.com`. Placeholders in the form of `{placeholder_name}` matches 1 or more characters. The String value of the placeholder will be available in the arguments `Bundle` with a key of the same name. For example, `http://www.example.com/users/{id}` will match `http://www.example.com/users/4`. The `.` wildcard can be used to match 0 or more characters. These Uris can be declared in your navigation XML files by adding one or more `<deepLink app:uri="uriPattern" />` elements as a child to your destination. Custom actions and mimetypes are also supported by `NavDeepLink` and can be declared in your navigation XML files by adding `<app:action="android.intent.action.SOME_ACTION" />` or `<app:mimetype="type/subtype" />` as part of your deepLink declaration. Deep link Uris, actions, and mimetypes added in navigation XML files will automatically replace instances of `${applicationId}` with the applicationId of your app. Programmatically added deep links should use `Context#getPackageName()` directly when constructing the uriPattern. When matching deep links for calls to `NavController#handleDeepLink(Intent)` or `NavController#navigate(NavDeepLinkRequest)` the order of precedence is as follows: the deep link with the most matching arguments will be chosen, followed by the deep link with a matching action, followed by the best matching mimeType (e.i. when matching mimeType image/jpg: image/ > \/jpg > \/*).
`NavAction?`	`getAction(@IdRes id: Int)` Returns the destination ID for a given action. This will recursively check the `parent` of this destination if the action destination is not found in this destination.
`MutableMap<String!, NavArgument!>`	`getArguments()` Get the arguments supported by this destination. Returns a read-only map of argument names to `NavArgument` objects that can be used to check the type, default value and nullability of the argument. To add and remove arguments for this NavDestination use `addArgument(String, NavArgument)` and `removeArgument(String)`.
`Int`	`getId()` Returns the destination's unique ID. This should be an ID resource generated by the Android resource system.
`CharSequence?`	`getLabel()` Gets the descriptive label of this destination.
`String`	`getNavigatorName()` Returns the name associated with this destination's `Navigator`.
`NavGraph?`	`getParent()` Gets the `NavGraph` that contains this destination. This will be set when a destination is added to a NavGraph via `NavGraph#addDestination`.
`Boolean`	`hasDeepLink(@NonNull 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(String)` . It returns `true` if the deep link is a valid match, and `false` otherwise. This should be called prior to `NavController#navigate(Uri)` to ensure the deep link can be navigated to.
`Boolean`	`hasDeepLink(@NonNull deepLinkRequest: NavDeepLinkRequest)` Checks the given `NavDeepLinkRequest`, and determines whether it matches a `NavDeepLink` added to the destination by a call to `addDeepLink(NavDeepLink)`. It returns `true` if the request is a valid match, and `false` otherwise. This should be called prior to `NavController#navigate(NavDeepLinkRequest)` to ensure the deep link can be navigated to.
`Class<out C>`	`parseClassFromName(@NonNull context: Context, @NonNull name: String, @NonNull expectedClassType: Class<out C>)` Parse the class associated with this destination from a raw name, generally extracted from the `android:name` attribute added to the destination's XML. This should be the class providing the visual representation of the destination that the user sees after navigating to this destination. This method does name -> Class caching and should be strongly preferred over doing your own parsing if your `Navigator` supports the `android:name` attribute to give consistent behavior across all Navigators.
`Unit`	`putAction(@IdRes actionId: Int, @IdRes destId: Int)` Sets a destination ID for an action ID.
`Unit`	`putAction(@IdRes actionId: Int, @NonNull action: NavAction)` Sets a destination ID for an action ID.
`Unit`	`removeAction(@IdRes actionId: Int)` Unsets the destination ID for an action ID.
`Unit`	`removeArgument(@NonNull argumentName: String)` Unsets the argument type for an argument name.
`Unit`	`setId(@IdRes id: Int)` Sets the destination's unique ID. This should be an ID resource generated by the Android resource system.
`Unit`	`setLabel(@Nullable label: CharSequence?)` Sets the descriptive label of this destination.

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

Public constructors

<init>

DynamicNavGraph(
    navGraphNavigator: DynamicGraphNavigator, 
    navigatorProvider: NavigatorProvider)

The NavGraph for dynamic features.

Public methods

onInflate

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

Properties

moduleName

var moduleName: String?

The dynamic feature's module name.

progressDestination

var progressDestination: Int

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