@NavDestinationDsl
public final class DynamicNavGraphBuilder extends NavGraphBuilder


DSL for constructing a new DynamicGraphNavigator.DynamicNavGraph

Summary

Public constructors

DynamicNavGraphBuilder(
    @NonNull NavigatorProvider provider,
    @IdRes int id,
    @IdRes int startDestination
)

This method is deprecated. Use routes to create your DynamicNavGraphBuilder instead

DynamicNavGraphBuilder(
    @NonNull NavigatorProvider provider,
    @NonNull String startDestination,
    String route
)

Public methods

@NonNull NavGraph
final String

The module name of this Destination's dynamic feature module.

final int

ID of the destination displayed during module installation.

final String

Route of the destination displayed during module installation.

final void
setModuleName(String moduleName)

The module name of this Destination's dynamic feature module.

final void
setProgressDestination(int progressDestination)

ID of the destination displayed during module installation.

final void
setProgressDestinationRoute(String progressDestinationRoute)

Route of the destination displayed during module installation.

Extension functions

final void

This method is deprecated. Use routes to build your DynamicActivityDestination instead

final void

Construct a new DynamicActivityNavigator.Destination

final void

This method is deprecated. Use routes to create your DynamicFragmentDestination instead

final void

Construct a new DynamicFragmentNavigator.Destination

final void

This method is deprecated. Use routes to create your DynamicFragmentDestination instead

final void

Construct a new DynamicFragmentNavigator.Destination

final void

This method is deprecated. Use routes to create your DynamicFragmentDestination instead

final void

Construct a new DynamicFragmentNavigator.Destination

final void
DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

This method is deprecated. Use routes to include your DynamicNavGraph instead

final void
DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

final void
DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

This method is deprecated. Use routes to include your DynamicNavGraph instead

final void
DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

final void
DynamicNavGraphBuilderKt.navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder
)

This method is deprecated. Use routes to create your DynamicNavGraph instead

final void
DynamicNavGraphBuilderKt.navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String startDestination,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Inherited methods

From androidx.navigation.NavDestinationBuilder
final void
action(
    int actionId,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavActionBuilderUnit> 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 NavArgumentBuilderUnit> argumentBuilder
)

Add a NavArgument to this destination.

final void

Add a deep link to this destination.

final void
deepLink(@NonNull String uriPattern)

Add a deep link to this destination.

final int

The destination's unique ID.

final CharSequence

The descriptive label of the destination

final @NonNull Navigator<@NonNull NavGraph>

The navigator the destination was created from

final String

The destination's unique route.

final void

The descriptive label of the destination

From androidx.navigation.NavGraphBuilder
final void

Add the destination to the NavGraphBuilder

final void
<D extends NavDestination> destination(
    @NonNull NavDestinationBuilder<@NonNull D> navDestination
)

Build and add a new destination to the NavGraphBuilder

final @NonNull NavigatorProvider

The NavGraphBuilder's NavigatorProvider.

final void

Adds this destination to the NavGraphBuilder

Public constructors

DynamicNavGraphBuilder

Added in 2.3.0
Deprecated in 2.4.0
public DynamicNavGraphBuilder(
    @NonNull NavigatorProvider provider,
    @IdRes int id,
    @IdRes int startDestination
)

DynamicNavGraphBuilder

Added in 2.4.0
public DynamicNavGraphBuilder(
    @NonNull NavigatorProvider provider,
    @NonNull String startDestination,
    String route
)

Public methods

getModuleName

Added in 2.3.0
public final String getModuleName()

The module name of this Destination's dynamic feature module. This has to be the same as defined in the dynamic feature module's AndroidManifest.xml file.

getProgressDestination

Added in 2.3.0
public final int getProgressDestination()

ID of the destination displayed during module installation. This generally does not need to be set, but is instead filled in by the NavHost via DynamicGraphNavigator.installDefaultProgressDestination.

Setting this clears any previously set progressDestinationRoute.

getProgressDestinationRoute

Added in 2.4.0
public final String getProgressDestinationRoute()

Route of the destination displayed during module installation. This generally does not need to be set, but is instead filled in by the NavHost via DynamicGraphNavigator.installDefaultProgressDestination.

Setting this overrides any previously set progressDestination.

setModuleName

Added in 2.3.0
public final void setModuleName(String moduleName)

The module name of this Destination's dynamic feature module. This has to be the same as defined in the dynamic feature module's AndroidManifest.xml file.

setProgressDestination

Added in 2.3.0
public final void setProgressDestination(int progressDestination)

ID of the destination displayed during module installation. This generally does not need to be set, but is instead filled in by the NavHost via DynamicGraphNavigator.installDefaultProgressDestination.

Setting this clears any previously set progressDestinationRoute.

setProgressDestinationRoute

Added in 2.4.0
public final void setProgressDestinationRoute(String progressDestinationRoute)

Route of the destination displayed during module installation. This generally does not need to be set, but is instead filled in by the NavHost via DynamicGraphNavigator.installDefaultProgressDestination.

Setting this overrides any previously set progressDestination.

Extension functions

DynamicActivityNavigatorDestinationBuilderKt.activity

public final void DynamicActivityNavigatorDestinationBuilderKt.activity(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicActivityNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicActivityNavigator.Destination

Parameters
@IdRes int id

Destination id.

DynamicActivityNavigatorDestinationBuilderKt.activity

public final void DynamicActivityNavigatorDestinationBuilderKt.activity(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicActivityNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicActivityNavigator.Destination

Parameters
@NonNull String route

Destination route.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void <F extends Fragment> DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@IdRes int id

Destination id.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void <F extends Fragment> DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@NonNull String route

Destination route.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void <F extends Fragment> DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicFragmentNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@IdRes int id

Destination id.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void <F extends Fragment> DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicFragmentNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@NonNull String route

Destination route.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String fragmentClassName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicFragmentNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@IdRes int id

Destination id.

@NonNull String fragmentClassName

Fully qualified class name of destination Fragment.

DynamicFragmentNavigatorDestinationBuilderKt.fragment

public final void DynamicFragmentNavigatorDestinationBuilderKt.fragment(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String fragmentClassName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicFragmentNavigatorDestinationBuilderUnit> builder
)

Construct a new DynamicFragmentNavigator.Destination

Parameters
@NonNull String route

Destination route.

@NonNull String fragmentClassName

Fully qualified class name of destination Fragment.

DynamicIncludeNavGraphBuilderKt.includeDynamic

public final void DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@IdRes int id

NavGraph id.

@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.

DynamicIncludeNavGraphBuilderKt.includeDynamic

public final void DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@NonNull String route

NavGraph route.

@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.

DynamicIncludeNavGraphBuilderKt.includeDynamic

public final void DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@IdRes int id

NavGraph id.

@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.

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder

Another builder for chaining.

DynamicIncludeNavGraphBuilderKt.includeDynamic

public final void DynamicIncludeNavGraphBuilderKt.includeDynamic(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String route,
    @NonNull String moduleName,
    @NonNull String graphResourceName,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder
)

Construct a new DynamicIncludeGraphNavigator.DynamicIncludeNavGraph.

Parameters
@NonNull String route

NavGraph route.

@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.

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicIncludeNavGraphBuilderUnit> builder

Another builder for chaining.

DynamicNavGraphBuilderKt.navigation

public final void DynamicNavGraphBuilderKt.navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @IdRes int id,
    @IdRes int startDestination,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
@IdRes int id

NavGraph id.

@IdRes int startDestination

Id start destination in the graph

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder

Another builder for chaining.

DynamicNavGraphBuilderKt.navigation

public final void DynamicNavGraphBuilderKt.navigation(
    @NonNull DynamicNavGraphBuilder receiver,
    @NonNull String startDestination,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder
)

Construct a nested DynamicGraphNavigator.DynamicNavGraph

Parameters
@NonNull String startDestination

route start destination in the graph

@NonNull String route

NavGraph route.

@ExtensionFunctionType @NonNull Function1<@NonNull DynamicNavGraphBuilderUnit> builder

Another builder for chaining.