@<Error class: unknown class>
class DynamicGraphNavigator

Navigator for graphs in dynamic feature modules.

This class handles navigating to a progress destination when the installation of a dynamic feature module is required. By default, the progress destination set by installDefaultProgressDestination will be used, but this can be overridden by setting the app:progressDestinationId attribute in your navigation XML file.

Summary

Nested types

The NavGraph for dynamic features.

Public constructors
DynamicGraphNavigator(
    navigatorProvider: <Error class: unknown class>,
    installManager: DynamicInstallManager
)

Public functions
open DynamicGraphNavigator.DynamicNavGraph

Create a destination for the DynamicNavGraph.
Unit
installDefaultProgressDestination(
    progressDestinationSupplier: () -> <Error class: unknown class>
)

Installs the default progress destination to this graph via a lambda.
open Unit
navigate(
    entries: List<<Error class: unknown class>>,
    navOptions: <Error class: unknown class>?,
    navigatorExtras: <Error class: unknown class>?
)

Navigate to a destination.
open Unit
onRestoreState(savedState: Bundle)
open Bundle?

Public constructors

DynamicGraphNavigator(
    navigatorProvider: <Error class: unknown class>,
    installManager: DynamicInstallManager
)

Public functions

createDestination

Added in 2.3.0
open fun createDestination(): DynamicGraphNavigator.DynamicNavGraph

Create a destination for the DynamicNavGraph.

Returns
DynamicGraphNavigator.DynamicNavGraph

The created graph.

installDefaultProgressDestination

fun installDefaultProgressDestination(
    progressDestinationSupplier: () -> <Error class: unknown class>
): Unit

Installs the default progress destination to this graph via a lambda. This supplies a NavDestination to use when the actual destination is not installed at navigation time.

This must be called before you call androidx.navigation.NavController.setGraph to ensure that all DynamicNavGraph instances have the correct progress destination installed in onRestoreState.

Parameters
progressDestinationSupplier: () -> <Error class: unknown class>

The default progress destination supplier.

 
open fun navigate(
    entries: List<<Error class: unknown class>>,
    navOptions: <Error class: unknown class>?,
    navigatorExtras: <Error class: unknown class>?
): Unit

Navigate to a destination.

In case the destination module is installed the navigation will trigger directly. Otherwise the dynamic feature module is requested and navigation is postponed until the module has successfully been installed.

onRestoreState

open fun onRestoreState(savedState: Bundle): Unit

onSaveState

open fun onSaveState(): Bundle?