DynamicIncludeNavGraphBuilder

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

Added in 2.3.0

Kotlin |Java

@NavDestinationDsl
public final class DynamicIncludeNavGraphBuilder extends NavDestinationBuilder

java.lang.Object
↳	androidx.navigation.NavDestinationBuilder
	↳	androidx.navigation.dynamicfeatures.DynamicIncludeNavGraphBuilder

DSL for constructing a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

Summary

Public constructors
`DynamicIncludeNavGraphBuilder( @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator, @IdRes int id, @NonNull String moduleName, @NonNull String graphResourceName )` This method is deprecated. Use routes to create your DynamicIncludeNavGraphBuilder instead
`DynamicIncludeNavGraphBuilder( @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator, @NonNull String route, @NonNull String moduleName, @NonNull String graphResourceName )`
`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 `DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`

Public methods
`@NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`	`build()`
`final String`	`getGraphPackage()` Destination NavGraph's resource package as defined in the module's `AndroidManifest`.
`final void`	`setGraphPackage(String graphPackage)` Destination NavGraph's resource package as defined in the module's `AndroidManifest`.

Inherited methods

From androidx.navigation.NavDestinationBuilder

`final void`	`action( int actionId, @ExtensionFunctionType @NonNull Function1<@NonNull NavActionBuilder, Unit> actionBuilder )` This method is deprecated. Building NavDestinations using IDs with the Kotlin DSL has been deprecated in favor of using routes.
`final void`	`argument( @NonNull String name, @ExtensionFunctionType @NonNull Function1<@NonNull NavArgumentBuilder, Unit> argumentBuilder )` Add a `NavArgument` to this destination.
`final void`	`argument(@NonNull String name, @NonNull NavArgument argument)` Add a `NavArgument` to this destination.
`final void`	`<T extends Object> deepLinkSafeArgs(@NonNull String basePath)` Add a deep link to this destination.
`final void`	`deepLink( @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink )` Add a deep link to this destination.
`final void`	`deepLink(@NonNull NavDeepLink navDeepLink)` Add a deep link to this destination.
`final void`	`deepLink(@NonNull String uriPattern)` Add a deep link to this destination.
`final void`	`<T extends Object> deepLink( @NonNull String basePath, @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink )` Add a deep link to this destination.
`final int`	`getId()` The destination's unique ID.
`final CharSequence`	`getLabel()` The descriptive label of the destination
`final @NonNull Navigator<@NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph>`	`getNavigator()` The navigator the destination that will be used in `instantiateDestination` to create the destination.
`final String`	`getRoute()` The destination's unique route.
`@NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph`	`instantiateDestination()` Instantiate a new instance of `D` that will be passed to `build`.
`final void`	`setLabel(CharSequence label)` The descriptive label of the destination

Public constructors

Added in 2.3.0

Deprecated in 2.4.0

public DynamicIncludeNavGraphBuilder(
    @NonNull DynamicIncludeGraphNavigator dynamicIncludeGraphNavigator,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Added in 2.4.0

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

Added in 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 DynamicIncludeGraphNavigator.DynamicIncludeNavGraph

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

Returns
`DynamicIncludeNavGraphBuilder`	the newly created NavGraph

Public methods

build

Added in 2.3.0

public @NonNull DynamicIncludeGraphNavigator.DynamicIncludeNavGraph build()

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

getGraphPackage

Added in 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

public final void setGraphPackage(String graphPackage)

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.