NavOptionsBuilder

public final void anim(
    @ExtensionFunctionType @NonNull Function1<@NonNull AnimBuilder, Unit> animBuilder
)

Sets any custom Animation or Animator resources that should be used.

Note: Animator resources are not supported for navigating to a new Activity

public final boolean getLaunchSingleTop()

Whether this navigation action should launch as single-top (i.e., there will be at most one copy of a given destination on the top of the back stack).

This functions similarly to how android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP works with activities.

public final int getPopUpTo()

The destination to pop up to before navigating. All non-matching destinations from the back stack up until this destination will also be popped.

public final int getPopUpToId()

Returns the current destination that the builder will pop up to.

public final String getPopUpToRoute()

The destination to pop up to before navigating. All non-matching destinations from the back stack up until this destination will also be popped.

public final KClass<@NonNull ?> getPopUpToRouteClass()

The destination to pop up to before navigating. All non-matching destinations from the back stack up until this destination will also be popped.

public final Object getPopUpToRouteObject()

The destination to pop up to before navigating. All non-matching destinations from the back stack up until this destination will also be popped.

public final boolean getRestoreState()

Whether this navigation action should restore any state previously saved by PopUpToBuilder.saveState or the popUpToSaveState attribute. If no state was previously saved with the destination ID being navigated to, this has no effect.

public final void <T extends Object> popUpTo(
    @ExtensionFunctionType @NonNull Function1<@NonNull PopUpToBuilder, Unit> popUpToBuilder
)

Pop up to a given destination before navigating. This pops all non-matching destination routes from the back stack until the destination with a matching route is found.

public final void popUpTo(
    @IdRes int id,
    @ExtensionFunctionType @NonNull Function1<@NonNull PopUpToBuilder, Unit> popUpToBuilder
)

Pop up to a given destination before navigating. This pops all non-matching destinations from the back stack until this destination is found.

public final void <T extends Object> popUpTo(
    @NonNull KClass<@NonNull T> route,
    @ExtensionFunctionType @NonNull Function1<@NonNull PopUpToBuilder, Unit> popUpToBuilder
)

Pop up to a given destination before navigating. This pops all non-matching destination routes from the back stack until the destination with a matching route is found.

public final void <T extends Object> popUpTo(
    @NonNull T route,
    @ExtensionFunctionType @NonNull Function1<@NonNull PopUpToBuilder, Unit> popUpToBuilder
)

Pop up to a given destination before navigating. This pops all non-matching destination routes from the back stack until the destination with a matching route is found.

public final void popUpTo(
    @NonNull String route,
    @ExtensionFunctionType @NonNull Function1<@NonNull PopUpToBuilder, Unit> popUpToBuilder
)

Pop up to a given destination before navigating. This pops all non-matching destination routes from the back stack until the destination with a matching route is found.

public final void setLaunchSingleTop(boolean launchSingleTop)

Whether this navigation action should launch as single-top (i.e., there will be at most one copy of a given destination on the top of the back stack).

This functions similarly to how android.content.Intent.FLAG_ACTIVITY_SINGLE_TOP works with activities.

public final void setPopUpTo(int popUpTo)

The destination to pop up to before navigating. All non-matching destinations from the back stack up until this destination will also be popped.

public final void setRestoreState(boolean restoreState)

Whether this navigation action should restore any state previously saved by PopUpToBuilder.saveState or the popUpToSaveState attribute. If no state was previously saved with the destination ID being navigated to, this has no effect.