DialogFragmentNavigatorDestinationBuilderKt

Added in 2.1.0

public final class DialogFragmentNavigatorDestinationBuilderKt

Summary

Public methods
static final void
<F extends DialogFragment> dialog(@NonNull NavGraphBuilder receiver, @IdRes int id)

This method is deprecated. Use routes to create your DialogFragmentDestination instead
static final void
<F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull String route
)

Construct a new DialogFragmentNavigator.Destination
static final void
<F extends DialogFragment, T extends Object> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

Construct a new DialogFragmentNavigator.Destination
static final void
<F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @IdRes int id,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

This method is deprecated. Use routes to create your DialogFragmentDestination instead
static final void
<F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

Construct a new DialogFragmentNavigator.Destination
static final void
<F extends DialogFragment, T extends Object> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

Construct a new DialogFragmentNavigator.Destination

Public methods

dialog

public static final void <F extends DialogFragment> dialog(@NonNull NavGraphBuilder receiver, @IdRes int id)

Construct a new DialogFragmentNavigator.Destination

Parameters
@IdRes int id

the destination's unique id

dialog

public static final void <F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull String route
)

Construct a new DialogFragmentNavigator.Destination

Parameters
@NonNull String route

the destination's unique route

dialog

public static final void <F extends DialogFragment, T extends Object> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap
)

Construct a new DialogFragmentNavigator.Destination

Parameters
<T extends Object>

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

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.

dialog

public static final void <F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @IdRes int id,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

Construct a new DialogFragmentNavigator.Destination

Parameters
@IdRes int id

the destination's unique id
@ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder

the builder used to construct the fragment destination

dialog

public static final void <F extends DialogFragment> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

Construct a new DialogFragmentNavigator.Destination

Parameters
@NonNull String route

the destination's unique route
@ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder

the builder used to construct the fragment destination

dialog

public static final void <F extends DialogFragment, T extends Object> dialog(
    @NonNull NavGraphBuilder receiver,
    @NonNull Map<@NonNull KType, @NonNull NavType<@NonNull ?>> typeMap,
    @ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder
)

Construct a new DialogFragmentNavigator.Destination

Parameters
<T extends Object>

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

map of destination arguments' kotlin type KType to its respective custom NavType. May be empty if T does not use custom NavTypes.
@ExtensionFunctionType @NonNull Function1<@NonNull DialogFragmentNavigatorDestinationBuilder, Unit> builder

the builder used to construct the fragment destination