ActivityNavigator

@Navigator.Name(value = "activity")
open class ActivityNavigator : Navigator

kotlin.Any
   ↳ androidx.navigation.Navigator
     ↳ androidx.navigation.ActivityNavigator
Known direct subclasses
DynamicActivityNavigator

Dynamic feature navigator for Activity destinations.

ActivityNavigator implements cross-activity navigation.

Summary

Nested types

NavDestination for activity navigation

Extras that can be passed to ActivityNavigator to customize what ActivityOptionsCompat and flags are passed through to the call to ActivityCompat.startActivity.

Builder for constructing new Extras instances.

Public companion functions
Unit

Apply any pop animations in the Intent of the given Activity to a pending transition.

Public constructors

Public functions
open ActivityNavigator.Destination

Construct a new NavDestination associated with this Navigator.
open NavDestination?
navigate(
    destination: ActivityNavigator.Destination,
    args: Bundle?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.
open Boolean

Attempt to pop this navigator's back stack, performing the appropriate navigation.

Inherited functions
From androidx.navigation.Navigator
open Unit
navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.
open NavDestination?
navigate(
    destination: ActivityNavigator.Destination,
    args: SavedState?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.
open Unit

Indicator that this Navigator is actively being used by a NavController.
open Unit

Informational callback indicating that the given backStackEntry has been affected by a NavOptions.shouldLaunchSingleTop operation.
open Unit

Restore any state previously saved in onSaveState.
open SavedState?

Called to ask for a SavedState representing the Navigator's state.
open Unit
popBackStack(popUpTo: NavBackStackEntry, savedState: Boolean)

Attempt to pop this navigator's back stack, performing the appropriate navigation.

Inherited properties
From androidx.navigation.Navigator
Boolean

Whether this Navigator is actively being used by a NavController.
NavigatorState

The state of the Navigator is the communication conduit between the Navigator and the NavController that has called onAttach.

Public companion functions

applyPopAnimationsToPendingTransition

Added in 2.4.0
fun applyPopAnimationsToPendingTransition(activity: Activity): Unit

Apply any pop animations in the Intent of the given Activity to a pending transition. This should be used in place of Activity.overridePendingTransition to get the appropriate pop animations.

Parameters
activity: Activity

An activity started from the ActivityNavigator.
See also
popEnterAnim
popExitAnim

Public constructors

ActivityNavigator

Added in 1.0.0
ActivityNavigator(context: Context)

Public functions

createDestination

Added in 1.0.0
open fun createDestination(): ActivityNavigator.Destination

Construct a new NavDestination associated with this Navigator.

Any initialization of the destination should be done in the destination's constructor as it is not guaranteed that every destination will be created through this method.

Returns
ActivityNavigator.Destination

a new NavDestination
Added in 1.0.0
open fun navigate(
    destination: ActivityNavigator.Destination,
    args: Bundle?,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): NavDestination?

Navigate to a destination.

Requests navigation to a given destination associated with this navigator in the navigation graph. This method generally should not be called directly; NavController will delegate to it when appropriate.

Parameters
destination: ActivityNavigator.Destination

destination node to navigate to
args: Bundle?

arguments to use for navigation
navOptions: NavOptions?

additional options for navigation
navigatorExtras: Navigator.Extras?

extras unique to your Navigator.
Returns
NavDestination?

The NavDestination that should be added to the back stack or null if no change was made to the back stack (i.e., in cases of single top operations where the destination is already on top of the back stack).
Throws
kotlin.IllegalArgumentException

if the given destination has no Intent

popBackStack

Added in 1.0.0
open fun popBackStack(): Boolean

Attempt to pop this navigator's back stack, performing the appropriate navigation.

Implementations should return true if navigation was successful. Implementations should return false if navigation could not be performed, for example if the navigator's back stack was empty.

Returns
Boolean

true if pop was successful