FragmentNavigatorDestinationBuilder

public final class FragmentNavigatorDestinationBuilder extends NavDestinationBuilder


DSL for constructing a new FragmentNavigator.Destination

Summary

Public fields

final int

The destination's unique ID.

final @Nullable CharSequence

The descriptive label of the destination

final @Nullable String

The destination's unique route.

Public constructors

FragmentNavigatorDestinationBuilder(
    @NonNull FragmentNavigator navigator,
    @IdRes int id,
    @NonNull KClass<@NonNull Fragment> fragmentClass
)

DSL for constructing a new FragmentNavigator.Destination

FragmentNavigatorDestinationBuilder(
    @NonNull FragmentNavigator navigator,
    @NonNull String route,
    @NonNull KClass<@NonNull Fragment> fragmentClass
)

DSL for constructing a new FragmentNavigator.Destination

Public methods

@NonNull FragmentNavigator.Destination

Build the NavDestination by calling Navigator.createDestination.

Inherited methods

From class NavDestinationBuilder
final void
action(
    int actionId,
    @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,
    @NonNull Function1<@NonNull NavArgumentBuilderUnit> argumentBuilder
)

Add a NavArgument to this destination.

final void
deepLink(
    @NonNull Function1<@NonNull NavDeepLinkDslBuilderUnit> navDeepLink
)

Add a deep link to this destination.

final void
deepLink(@NonNull String uriPattern)

Add a deep link to this destination.

Public fields

id

@NonNull
public final int id

The destination's unique ID.

label

@Nullable
public final @Nullable CharSequence label

The descriptive label of the destination

route

@Nullable
public final @Nullable String route

The destination's unique route.

Public constructors

FragmentNavigatorDestinationBuilder

public final FragmentNavigatorDestinationBuilder(
    @NonNull FragmentNavigator navigator,
    @IdRes int id,
    @NonNull KClass<@NonNull Fragment> fragmentClass
)

DSL for constructing a new FragmentNavigator.Destination

Parameters
@NonNull FragmentNavigator navigator

navigator used to create the destination

@IdRes int id

the destination's unique id

@NonNull KClass<@NonNull Fragment> fragmentClass

The class name of the Fragment to show when you navigate to this destination

FragmentNavigatorDestinationBuilder

public final FragmentNavigatorDestinationBuilder(
    @NonNull FragmentNavigator navigator,
    @NonNull String route,
    @NonNull KClass<@NonNull Fragment> fragmentClass
)

DSL for constructing a new FragmentNavigator.Destination

Parameters
@NonNull FragmentNavigator navigator

navigator used to create the destination

@NonNull String route

the destination's unique route

@NonNull KClass<@NonNull Fragment> fragmentClass

The class name of the Fragment to show when you navigate to this destination

Public methods

build

@NonNull
public FragmentNavigator.Destination build()

Build the NavDestination by calling Navigator.createDestination.