NavOptions

Artifact: androidx.navigation:navigation-common

View Source

Added in 1.0.0

---

Kotlin |Java

Common/AllAndroid/JVM

• Cmn

  class NavOptions

---

NavOptions stores special options for navigate actions

Summary

Nested types
class NavOptions.Builder Builder for constructing new instances of NavOptions.

Public constructors
NavOptions()	android

Public functions
Boolean	isPopUpToInclusive() Whether the destination set in popUpToRoute should be popped from the back stack.	Cmn android
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).	Cmn android
Boolean	shouldPopUpToSaveState() Whether the back stack and the state of all destinations between the current destination and popUpToRoute should be saved for later restoration via Builder.setRestoreState or the restoreState attribute using the same ID as popUpToRoute (note: this matching ID is true if isPopUpToInclusive is true.	Cmn android
Boolean	shouldRestoreState() Whether this navigation action should restore any state previously saved by Builder.setPopUpTo or the popUpToSaveState attribute.	Cmn android

Public properties
String?	popUpToRoute Route for the destination to pop up to before navigating.	Cmn android
KClass<*>?	popUpToRouteClass Route from a KClass for the destination to pop up to before navigating.	Cmn android
Any?	popUpToRouteObject Route from an Object for the destination to pop up to before navigating.	Cmn android

Public constructors

NavOptions

android

NavOptions()

Public functions

isPopUpToInclusive

Cmn android

Added in 1.0.0

fun isPopUpToInclusive(): Boolean

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

See also
setPopUpTo
popUpToRoute

shouldLaunchSingleTop

Cmn android

Added in 1.0.0

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

shouldPopUpToSaveState

Cmn android

Added in 2.4.0

fun shouldPopUpToSaveState(): Boolean

Whether the back stack and the state of all destinations between the current destination and popUpToRoute should be saved for later restoration via Builder.setRestoreState or the restoreState attribute using the same ID as popUpToRoute (note: this matching ID is true if isPopUpToInclusive is true. If isPopUpToInclusive is false, this matching ID is the id of the last destination that is popped).

shouldRestoreState

Cmn android

Added in 2.4.0

fun shouldRestoreState(): Boolean

Whether this navigation action should restore any state previously saved by Builder.setPopUpTo or the popUpToSaveState attribute.

Public properties

popUpToRoute

Cmn android

Added in 2.4.0

var popUpToRoute: String?

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

Returns
String?	the destination route to pop up to, clearing all intervening destinations

See also
setPopUpTo
isPopUpToInclusive
shouldPopUpToSaveState

popUpToRouteClass

Cmn android

Added in 2.8.0

var popUpToRouteClass: KClass<*>?

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

Returns
KClass<*>?	the destination route to pop up to, clearing all intervening destinations

See also
setPopUpTo
isPopUpToInclusive
shouldPopUpToSaveState

popUpToRouteObject

Cmn android

Added in 2.8.0

var popUpToRouteObject: Any?

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

Returns
Any?	the destination route to pop up to, clearing all intervening destinations

See also
setPopUpTo
isPopUpToInclusive
shouldPopUpToSaveState