DynamicIncludeNavGraphBuilder

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

Added in 2.3.0

Kotlin |Java

@NavDestinationDsl
class DynamicIncludeNavGraphBuilder : NavDestinationBuilder

kotlin.Any
↳	androidx.navigation.NavDestinationBuilder
	↳	androidx.navigation.dynamicfeatures.DynamicIncludeNavGraphBuilder

DSL for constructing a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

Summary

Public constructors
`DynamicIncludeNavGraphBuilder( dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator, id: @IdRes Int, moduleName: String, graphResourceName: String )` This function is deprecated. Use routes to create your DynamicIncludeNavGraphBuilder instead
`DynamicIncludeNavGraphBuilder( dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator, route: String, moduleName: String, graphResourceName: String )`
`DynamicIncludeNavGraphBuilder( dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator, route: KClass<>, typeMap: Map<KType, NavType<>>, moduleName: String, graphResourceName: String )` DSL for constructing a new `DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

Public functions
`open DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`	`build()`

Public properties
`String?`	`graphPackage` Destination NavGraph's resource package as defined in the module's `AndroidManifest`.

Inherited functions

From androidx.navigation.NavDestinationBuilder

`Unit`	`action(actionId: Int, actionBuilder: NavActionBuilder.() -> Unit)` This function is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
`Unit`	`argument(name: String, argumentBuilder: NavArgumentBuilder.() -> Unit)` Add a `NavArgument` to this destination.
`Unit`	`argument(name: String, argument: NavArgument)` Add a `NavArgument` to this destination.
`inline Unit`	`<T : Any> deepLink(basePath: String)` Add a deep link to this destination.
`Unit`	`deepLink(navDeepLink: NavDeepLinkDslBuilder.() -> Unit)` Add a deep link to this destination.
`Unit`	`deepLink(navDeepLink: NavDeepLink)` Add a deep link to this destination.
`Unit`	`deepLink(uriPattern: String)` Add a deep link to this destination.
`inline Unit`	`<T : Any> deepLink(basePath: String, noinline navDeepLink: NavDeepLinkDslBuilder.() -> Unit)` Add a deep link to this destination.
`Unit`	`<T : Any> deepLink(route: KClass<T>, basePath: String, navDeepLink: NavDeepLinkDslBuilder.() -> Unit)` Add a deep link to this destination.
`open DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`	`instantiateDestination()` Instantiate a new instance of `D` that will be passed to `build`.

Inherited properties

From androidx.navigation.NavDestinationBuilder

`Int`	`id` The destination's unique ID.
`CharSequence?`	`label` The descriptive label of the destination
`Navigator<DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>`	`navigator` The navigator the destination that will be used in `instantiateDestination` to create the destination.
`String?`	`route` The destination's unique route.

Public constructors

Added in 2.3.0

Deprecated in 2.4.0

DynamicIncludeNavGraphBuilder(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    id: @IdRes Int,
    moduleName: String,
    graphResourceName: String
)

Added in 2.4.0

DynamicIncludeNavGraphBuilder(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    route: String,
    moduleName: String,
    graphResourceName: String
)

Added in 2.8.0

DynamicIncludeNavGraphBuilder(
    dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator,
    route: KClass<*>,
    typeMap: Map<KType, NavType<*>>,
    moduleName: String,
    graphResourceName: String
)

DSL for constructing a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

Parameters
`dynamicIncludeGraphNavigator: DynamicIncludeGraphNavigator`	navigator used to create the destination
`route: KClass<*>`	the graph's unique route as a `KClass`
`typeMap: Map<KType, NavType<*>>`	A mapping of KType to custom NavType<*> in the `route`. May be empty if `route` does not use custom NavTypes.
`moduleName: String`	Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string.
`graphResourceName: String`	Graph's resource name without the `navigation` qualifier. This must not be an empty string.

Returns
`DynamicIncludeNavGraphBuilder`	the newly created NavGraph

Public functions

build

Added in 2.3.0

open fun build(): DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

Returns
`DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`	The `DynamicGraphNavigator.DynamicNavGraph`

Public properties

graphPackage

Added in 2.3.0

var graphPackage: String?

Destination NavGraph's resource package as defined in the module's AndroidManifest. This generally does not need to be manually set and will be set applicationId.moduleName if left null.

This cannot be an empty string.