# DynamicIncludeNavGraphBuilder

Artifact: [androidx.navigation:navigation-dynamic-features-runtime](https://developer.android.com/jetpack/androidx/releases/navigation) [View Source](https://cs.android.com/search?q=file:androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder.kt+class:androidx.navigation.dynamicfeatures.DynamicIncludeNavGraphBuilder) Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

*** ** * ** ***


```
@NavDestinationDsl
public final class DynamicIncludeNavGraphBuilder extends NavDestinationBuilder<@NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.navigation.NavDestinationBuilder](https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) [DynamicIncludeGraphNavigator.DynamicIncludeNavGraph](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph)\> ||
|   | ↳ | [androidx.navigation.dynamicfeatures.DynamicIncludeNavGraphBuilder](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder) |

*** ** * ** ***

DSL for constructing a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

## Summary

| ### Public constructors |
|---|
| `[DynamicIncludeNavGraphBuilder](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.Int,kotlin.String,kotlin.String))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator, @https://developer.android.com/reference/androidx/annotation/IdRes int id, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName )` **This method is deprecated.** Use routes to create your DynamicIncludeNavGraphBuilder instead |
| `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.String,kotlin.String,kotlin.String)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html route, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName )` |
| `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator, @https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull ?> route, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName )` DSL for constructing a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` |

| ### Public methods |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#build()()` |
| `final https://developer.android.com/reference/java/lang/String.html` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#getGraphPackage()()` Destination NavGraph's resource package as defined in the module's `AndroidManifest`. |
| `final void` | `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#setGraphPackage(kotlin.String)(https://developer.android.com/reference/java/lang/String.html value)` Destination NavGraph's resource package as defined in the module's `AndroidManifest`. |

### Inherited methods

From [androidx.navigation.NavDestinationBuilder](https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder) `final void` `[action](https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#action(kotlin.Int,kotlin.Function1))(
int actionId,
@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavActionBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> actionBuilder
)`

**This method is deprecated.** Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
`final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#argument(kotlin.String,kotlin.Function1)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html name,
@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavArgumentBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> argumentBuilder
)` `final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#argument(kotlin.String,androidx.navigation.NavArgument)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html name, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavArgument argument)` `final void` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLinkSafeArgs(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html basePath)` `final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.Function1)(
@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkDslBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> navDeepLink
)` `final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLink(androidx.navigation.NavDeepLink)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLink navDeepLink)` `final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.String)(@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html uriPattern)` `final void` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.String,kotlin.Function1)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html basePath,
@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkDslBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> navDeepLink
)` `final void` `<T extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#deepLink(kotlin.reflect.KClass,kotlin.String,kotlin.Function1)(
@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull T> route,
@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html basePath,
@https://developer.android.com/reference/androidx/annotation/NonNull Function1<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavDeepLinkDslBuilder, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html> navDeepLink
)` `final int` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#getId()()` `final https://developer.android.com/reference/java/lang/CharSequence.html` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#getLabel()()` `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/Navigator<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#getNavigator()()`

DSL for constructing a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`
`final https://developer.android.com/reference/java/lang/String.html` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#getRoute()()` `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#instantiateDestination()()` `final void` `https://developer.android.com/reference/androidx/navigation/NavDestinationBuilder#setLabel(kotlin.CharSequence)(https://developer.android.com/reference/java/lang/CharSequence.html value)`

## Public constructors

### DynamicIncludeNavGraphBuilder

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0) Deprecated in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public [DynamicIncludeNavGraphBuilder](https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#DynamicIncludeNavGraphBuilder(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.Int,kotlin.String,kotlin.String))(
    @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)
```

> [!CAUTION]
> **This method is deprecated.**   
> Use routes to create your DynamicIncludeNavGraphBuilder instead, use this instead:
>
> ```
> DynamicIncludeNavGraphBuilder(dynamicIncludeGraphNavigator, route = id.toString(), moduleName, graphResourceName)
> ```

### DynamicIncludeNavGraphBuilder

Added in [2.4.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.4.0)

```
public DynamicIncludeNavGraphBuilder(
    @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)
```

### DynamicIncludeNavGraphBuilder

Added in [2.8.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.8.0)

```
public DynamicIncludeNavGraphBuilder(
    @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator,
    @NonNull KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)
```

DSL for constructing a new `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator` | navigator used to create the destination |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html<@https://developer.android.com/reference/androidx/annotation/NonNull ?> route` | the graph's unique route as a `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-class/index.html` |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/util/Map.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.reflect/-k-type/index.html, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/NavType<@https://developer.android.com/reference/androidx/annotation/NonNull ?>> typeMap` | A mapping of KType to custom NavType\<\*\> in the `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)`. May be empty if `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder#(androidx.navigation.dynamicfeatures.DynamicIncludeGraphNavigator,kotlin.reflect.KClass,kotlin.collections.Map,kotlin.String,kotlin.String)` does not use custom NavTypes. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html moduleName` | Dynamic feature module name as defined in the module's `AndroidManifest`. This must not be an empty string. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/java/lang/String.html graphResourceName` | Graph's resource name without the `navigation` qualifier. This must not be an empty string. |

| Returns |
|---|---|
| `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeNavGraphBuilder` | the newly created NavGraph |

## Public methods

### build

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public @NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph build()
```

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicIncludeGraphNavigator.DynamicIncludeNavGraph` | The `https://developer.android.com/reference/androidx/navigation/dynamicfeatures/DynamicGraphNavigator.DynamicNavGraph` |

### getGraphPackage

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public final String getGraphPackage()
```

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.

### setGraphPackage

Added in [2.3.0](https://developer.android.com/jetpack/androidx/releases/navigation#2.3.0)

```
public final void setGraphPackage(String value)
```

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.