DynamicGraphNavigator

Artifact: androidx.navigation:navigation-dynamic-features-runtime

View Source

Added in 2.3.0

---

Kotlin |Java

@<Error class: unknown class>
public final 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
public final class DynamicGraphNavigator.DynamicNavGraph The NavGraph for dynamic features.

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

Public methods
@NonNull DynamicGraphNavigator.DynamicNavGraph	createDestination() Create a destination for the DynamicNavGraph.
final void	installDefaultProgressDestination(     @NonNull Function0<@NonNull <Error class: unknown class>> progressDestinationSupplier ) Installs the default progress destination to this graph via a lambda.
void	navigate(     @NonNull List<@NonNull <Error class: unknown class>> entries,     <Error class: unknown class> navOptions,     <Error class: unknown class> navigatorExtras ) Navigate to a destination.
void	onRestoreState(@NonNull Bundle savedState)
Bundle	onSaveState()

Public constructors

DynamicGraphNavigator

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

Public methods

createDestination

Added in 2.3.0

public @NonNull DynamicGraphNavigator.DynamicNavGraph createDestination()

Create a destination for the DynamicNavGraph.

Returns
@NonNull DynamicGraphNavigator.DynamicNavGraph	The created graph.

installDefaultProgressDestination

public final void installDefaultProgressDestination(
    @NonNull Function0<@NonNull <Error class: unknown class>> progressDestinationSupplier
)

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
@NonNull Function0<@NonNull <Error class: unknown class>> progressDestinationSupplier	The default progress destination supplier.

navigate

public void navigate(
    @NonNull List<@NonNull <Error class: unknown class>> entries,
    <Error class: unknown class> navOptions,
    <Error class: unknown class> navigatorExtras
)

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

public void onRestoreState(@NonNull Bundle savedState)

onSaveState

public Bundle onSaveState()