TestNavHostController

Artifact: androidx.navigation:navigation-testing

View Source

Added in 2.3.0

---

Kotlin |Java

public final class TestNavHostController extends NavHostController

java.lang.Object
↳	androidx.navigation.NavController
	↳	androidx.navigation.NavHostController
		↳	androidx.navigation.testing.TestNavHostController

---

Subclass of NavHostController that offers additional APIs for testing Navigation.

Summary

Public constructors
TestNavHostController(@NonNull Context context)

Public methods
final @NonNull List<@NonNull NavBackStackEntry>	getBackStack() Gets an immutable copy of the elements currently on the back stack.
final void	setCurrentDestination(@IdRes int destId, @NonNull Bundle args) Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.
final void	setCurrentDestination(@NonNull String destRoute, @NonNull Bundle args) Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.

Inherited methods
From androidx.navigation.NavController void addOnDestinationChangedListener(     @NonNull NavController.OnDestinationChangedListener listener ) final boolean @MainThread <T extends Object> clearBackStack() final boolean @MainThread <T extends Object> clearBackStack(@NonNull KClass<@NonNull T> route) final boolean @MainThread <T extends Object> clearBackStack(@NonNull T route) final boolean @MainThread clearBackStack(@NonNull String route) final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry() final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry(@NonNull KClass<@NonNull T> route) final @NonNull NavBackStackEntry <T extends Object> getBackStackEntry(@NonNull T route) final @NonNull NavBackStackEntry getBackStackEntry(@NonNull String route) NavBackStackEntry getCurrentBackStackEntry() final @NonNull Flow<@NonNull NavBackStackEntry> getCurrentBackStackEntryFlow() NavDestination getCurrentDestination() @NonNull NavGraph @MainThread getGraph() @NonNull NavigatorProvider getNavigatorProvider() NavBackStackEntry getPreviousBackStackEntry() final @NonNull StateFlow<@NonNull List<@NonNull NavBackStackEntry>> getVisibleEntries() final boolean @MainThread handleDeepLink(@NonNull NavDeepLinkRequest request) void @MainThread navigate(@NonNull NavUri deepLink) void @MainThread navigate(@NonNull NavDeepLinkRequest request) void @MainThread navigate(@NonNull NavUri deepLink, NavOptions navOptions) void @MainThread navigate(@NonNull NavDeepLinkRequest request, NavOptions navOptions) final void @MainThread <T extends Object> navigate(     @NonNull T route,     @ExtensionFunctionType @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder ) final void @MainThread navigate(     @NonNull String route,     @ExtensionFunctionType @NonNull Function1<@NonNull NavOptionsBuilder, Unit> builder ) void @MainThread navigate(     @NonNull NavUri deepLink,     NavOptions navOptions,     Navigator.Extras navigatorExtras ) void @MainThread navigate(     @NonNull NavDeepLinkRequest request,     NavOptions navOptions,     Navigator.Extras navigatorExtras ) final void @MainThread <T extends Object> navigate(     @NonNull T route,     NavOptions navOptions,     Navigator.Extras navigatorExtras ) final void @MainThread navigate(     @NonNull String route,     NavOptions navOptions,     Navigator.Extras navigatorExtras ) boolean @MainThread navigateUp() boolean @MainThread popBackStack() final boolean @MainThread <T extends Object> popBackStack(boolean inclusive, boolean saveState) final boolean @MainThread <T extends Object> popBackStack(     @NonNull KClass<@NonNull T> route,     boolean inclusive,     boolean saveState ) final boolean @MainThread <T extends Object> popBackStack(     @NonNull T route,     boolean inclusive,     boolean saveState ) final boolean @MainThread popBackStack(@NonNull String route, boolean inclusive, boolean saveState) void removeOnDestinationChangedListener(     @NonNull NavController.OnDestinationChangedListener listener ) void @CallSuper restoreState(SavedState navState) SavedState @CallSuper saveState() void @MainThread @CallSuper setGraph(@NonNull NavGraph graph) void @MainThread @CallSuper setGraph(@NonNull NavGraph graph, SavedState startDestinationArgs)
From androidx.navigation.NavHostController final void setLifecycleOwner(@NonNull LifecycleOwner owner) final void setViewModelStore(@NonNull ViewModelStore viewModelStore)

Public constructors

TestNavHostController

Added in 2.3.0

public TestNavHostController(@NonNull Context context)

Public methods

getBackStack

Added in 2.3.0

public final @NonNull List<@NonNull NavBackStackEntry> getBackStack()

Gets an immutable copy of the elements currently on the back stack.

setCurrentDestination

Added in 2.3.0

public final void setCurrentDestination(@IdRes int destId, @NonNull Bundle args)

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link. If an implicit deep link exists for this destination use #navigate(Uri) instead.

Parameters
@IdRes int destId	The destination id to navigate to.
@NonNull Bundle args	The arguments to pass to the destination.

Throws
java.lang.IllegalArgumentException	If the destination does not exist on the NavGraph.

setCurrentDestination

Added in 2.4.0

public final void setCurrentDestination(@NonNull String destRoute, @NonNull Bundle args)

Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link. If an implicit deep link exists for this destination use #navigate(Uri) instead.

Parameters
@NonNull String destRoute	The destination route to navigate to.
@NonNull Bundle args	The arguments to pass to the destination.

Throws
java.lang.IllegalArgumentException	If the destination does not exist on the NavGraph.