NavOptions

Kotlin |Java

class NavOptions

kotlin.Any
↳	androidx.navigation.NavOptions

NavOptions stores special options for navigate actions

Summary

Nested classes
	Builder Builder for constructing new instances of NavOptions.

Public methods
Boolean	equals(other: Any?)
Int	getEnterAnim() The custom enter Animation/Animator that should be run.
Int	getExitAnim() The custom exit Animation/Animator that should be run.
Int	getPopEnterAnim() The custom enter Animation/Animator that should be run when this destination is popped from the back stack.
Int	getPopExitAnim() The custom exit Animation/Animator that should be run when this destination is popped from the back stack.
Int	getPopUpTo() The destination to pop up to before navigating.
Int	hashCode()
Boolean	isPopUpToInclusive() Whether the destination set in getPopUpTo should be popped from the back stack.
Boolean	shouldLaunchSingleTop() 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).

Public methods

equals

fun equals(other: Any?): Boolean

getEnterAnim

@AnimRes @AnimatorRes fun getEnterAnim(): Int

The custom enter Animation/Animator that should be run.

Return
Int	the resource id of a Animation or Animator or -1 if none.

getExitAnim

@AnimRes @AnimatorRes fun getExitAnim(): Int

The custom exit Animation/Animator that should be run.

Return
Int	the resource id of a Animation or Animator or -1 if none.

getPopEnterAnim

@AnimRes @AnimatorRes fun getPopEnterAnim(): Int

The custom enter Animation/Animator that should be run when this destination is popped from the back stack.

Return
Int	the resource id of a Animation or Animator or -1 if none.

getPopExitAnim

@AnimRes @AnimatorRes fun getPopExitAnim(): Int

The custom exit Animation/Animator that should be run when this destination is popped from the back stack.

Return
Int	the resource id of a Animation or Animator or -1 if none.

getPopUpTo

@IdRes fun getPopUpTo(): Int

The destination to pop up to before navigating. When set, all non-matching destinations should be popped from the back stack.

Return
Int	the destinationId to pop up to, clearing all intervening destinations

See Also

• Builder#setPopUpTo
• #isPopUpToInclusive

hashCode

fun hashCode(): Int

isPopUpToInclusive

fun isPopUpToInclusive(): Boolean

Whether the destination set in getPopUpTo should be popped from the back stack.

See Also

• Builder#setPopUpTo
• #getPopUpTo

shouldLaunchSingleTop

fun shouldLaunchSingleTop(): Boolean

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 activites.