DynamicFragmentNavigatorDestinationBuilder

@NavDestinationDsl
public final class DynamicFragmentNavigatorDestinationBuilder extends NavDestinationBuilder

java.lang.Object
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.dynamicfeatures.fragment.DynamicFragmentNavigatorDestinationBuilder

DSL for constructing a new DynamicFragmentNavigator.Destination

Summary

Public constructors
DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @IdRes int id,
    @NonNull String fragmentClassName
)

This method is deprecated. Use routes to create your DynamicFragmentDestinationBuilder instead
DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @NonNull String route,
    @NonNull String fragmentClassName
)
DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @NonNull KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull String fragmentClassName
)

DSL for constructing a new DynamicFragmentNavigator.Destination

Public methods
@NonNull DynamicFragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.
final String
final void
setModuleName(String moduleName)

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

Add a NavArgument to this destination.
final void
<T extends Object> deepLinkSafeArgs(@NonNull String basePath)

Add a deep link to this destination.
final void

Add a deep link 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 void
<T extends Object> deepLink(
    @NonNull String basePath,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

Add a deep link to this destination.
final void
<T extends Object> deepLink(
    @NonNull KClass<@NonNull T> route,
    @NonNull String basePath,
    @ExtensionFunctionType @NonNull Function1<@NonNull NavDeepLinkDslBuilder, Unit> navDeepLink
)

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 FragmentNavigator.Destination>

The navigator the destination that will be used in instantiateDestination to create the destination.
final String

The destination's unique route.
@NonNull FragmentNavigator.Destination

Instantiate a new instance of D that will be passed to build.
final void

The descriptive label of the destination

Public constructors

DynamicFragmentNavigatorDestinationBuilder

Added in 2.3.0
Deprecated in 2.4.0
public DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @IdRes int id,
    @NonNull String fragmentClassName
)

DynamicFragmentNavigatorDestinationBuilder

Added in 2.4.0
public DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @NonNull String route,
    @NonNull String fragmentClassName
)

DynamicFragmentNavigatorDestinationBuilder

Added in 2.8.0
public DynamicFragmentNavigatorDestinationBuilder(
    @NonNull DynamicFragmentNavigator navigator,
    @NonNull KClass<@NonNull ?> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull String fragmentClassName
)

DSL for constructing a new DynamicFragmentNavigator.Destination

Parameters
@NonNull DynamicFragmentNavigator navigator

navigator used to create the destination
@NonNull KClass<@NonNull ?> route

the route from a KClass of the destination
@NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if route does not use custom NavTypes.
@NonNull String fragmentClassName

Fully qualified class name of destination Fragment.

Public methods

build

Added in 2.3.0
public @NonNull DynamicFragmentNavigator.Destination build()

Build the NavDestination by calling Navigator.createDestination.

getModuleName

Added in 2.3.0
public final String getModuleName()

setModuleName

Added in 2.3.0
public final void setModuleName(String moduleName)