DialogFragmentNavigatorDestinationBuilder

@NavDestinationDsl
public final class DialogFragmentNavigatorDestinationBuilder extends NavDestinationBuilder

java.lang.Object
   ↳ androidx.navigation.NavDestinationBuilder
     ↳ androidx.navigation.fragment.DialogFragmentNavigatorDestinationBuilder

DSL for constructing a new DialogFragmentNavigator.Destination

Summary

Public constructors

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

DSL for constructing a new DialogFragmentNavigator.Destination

DSL for constructing a new DialogFragmentNavigator.Destination

Public methods
@NonNull DialogFragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

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

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

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

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

The descriptive label of the destination

Public constructors

DialogFragmentNavigatorDestinationBuilder

Added in 2.1.0
public DialogFragmentNavigatorDestinationBuilder(
    @NonNull DialogFragmentNavigator navigator,
    @IdRes int id,
    @NonNull KClass<@NonNull DialogFragment> fragmentClass
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
@NonNull DialogFragmentNavigator navigator

navigator used to create the destination
@IdRes int id

the destination's unique id
@NonNull KClass<@NonNull DialogFragment> fragmentClass

the class name of the DialogFragment to show when you navigate to this destination

DialogFragmentNavigatorDestinationBuilder

public DialogFragmentNavigatorDestinationBuilder(
    @NonNull DialogFragmentNavigator navigator,
    @NonNull String route,
    @NonNull KClass<@NonNull DialogFragment> fragmentClass
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
@NonNull DialogFragmentNavigator navigator

navigator used to create the destination
@NonNull String route

the destination's unique route. This sets the route on the newly constructed NavDestination. This can be any valid non-empty String.
@NonNull KClass<@NonNull DialogFragment> fragmentClass

the class name of the DialogFragment to show when you navigate to this destination

DialogFragmentNavigatorDestinationBuilder

public DialogFragmentNavigatorDestinationBuilder(
    @NonNull DialogFragmentNavigator navigator,
    @NonNull KClass<@NonNull Object> route,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @NonNull KClass<@NonNull DialogFragment> fragmentClass
)

DSL for constructing a new DialogFragmentNavigator.Destination

Parameters
@NonNull DialogFragmentNavigator navigator

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

the destination's unique route from a KClass. This sets the route on the newly constructed NavDestination.
@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 KClass<@NonNull DialogFragment> fragmentClass

the class name of the DialogFragment to show when you navigate to this destination

Public methods

build

Added in 2.1.0
public @NonNull DialogFragmentNavigator.Destination build()

Build the NavDestination by calling Navigator.createDestination.