DynamicActivityNavigator

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

kotlin.Any
   ↳ androidx.navigation.Navigator
     ↳ androidx.navigation.ActivityNavigator
       ↳ androidx.navigation.dynamicfeatures.DynamicActivityNavigator

Dynamic feature navigator for Activity destinations.

Summary

Nested types

Destination for DynamicActivityNavigator.

Public constructors
DynamicActivityNavigator(
    context: Context,
    installManager: DynamicInstallManager
)

Public functions
open DynamicActivityNavigator.Destination

Construct a new NavDestination associated with this Navigator.
open Unit
navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
)

Navigate to a destination.

Inherited functions
From androidx.navigation.ActivityNavigator
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.
From androidx.navigation.Navigator
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 constructors

DynamicActivityNavigator

Added in 2.3.0
DynamicActivityNavigator(
    context: Context,
    installManager: DynamicInstallManager
)

Public functions

createDestination

Added in 2.3.0
open fun createDestination(): DynamicActivityNavigator.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
DynamicActivityNavigator.Destination

a new NavDestination

 
open fun navigate(
    entries: List<NavBackStackEntry>,
    navOptions: NavOptions?,
    navigatorExtras: Navigator.Extras?
): Unit

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
entries: List<NavBackStackEntry>

destination(s) to navigate to
navOptions: NavOptions?

additional options for navigation
navigatorExtras: Navigator.Extras?

extras unique to your Navigator.