TestNavHostController

Artifact: androidx.navigation:navigation-testing

View Source

Added in 2.3.0

---

Kotlin |Java

class TestNavHostController : NavHostController

kotlin.Any
↳	androidx.navigation.NavController
	↳	androidx.navigation.NavHostController
		↳	androidx.navigation.testing.TestNavHostController

---

Subclass of NavHostController that offers additional APIs for testing Navigation.

Summary

Public constructors
TestNavHostController(context: Context)

Public functions
Unit	setCurrentDestination(destId: @IdRes Int, args: Bundle) Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.
Unit	setCurrentDestination(destRoute: String, args: Bundle) Navigate directly to any destination on the current androidx.navigation.NavGraph via an explicit deep link.

Public properties
List<NavBackStackEntry>	backStack Gets an immutable copy of the elements currently on the back stack.

Inherited functions
From androidx.navigation.NavController open Unit addOnDestinationChangedListener(     listener: NavController.OnDestinationChangedListener ) inline Boolean @MainThread <T : Any> clearBackStack() Boolean @MainThread <T : Any> clearBackStack(route: KClass<T>) Boolean @MainThread <T : Any> clearBackStack(route: T) Boolean @MainThread clearBackStack(route: String) inline NavBackStackEntry <T : Any> getBackStackEntry() NavBackStackEntry <T : Any> getBackStackEntry(route: KClass<T>) NavBackStackEntry <T : Any> getBackStackEntry(route: T) NavBackStackEntry getBackStackEntry(route: String) Boolean @MainThread handleDeepLink(request: NavDeepLinkRequest) open Unit @MainThread navigate(deepLink: NavUri) open Unit @MainThread navigate(request: NavDeepLinkRequest) open Unit @MainThread navigate(deepLink: NavUri, navOptions: NavOptions?) open Unit @MainThread navigate(request: NavDeepLinkRequest, navOptions: NavOptions?) Unit @MainThread <T : Any> navigate(route: T, builder: NavOptionsBuilder.() -> Unit) Unit @MainThread navigate(route: String, builder: NavOptionsBuilder.() -> Unit) open Unit @MainThread navigate(     deepLink: NavUri,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) open Unit @MainThread navigate(     request: NavDeepLinkRequest,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Unit @MainThread <T : Any> navigate(     route: T,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) Unit @MainThread navigate(     route: String,     navOptions: NavOptions?,     navigatorExtras: Navigator.Extras? ) open Boolean @MainThread navigateUp() open Boolean @MainThread popBackStack() inline Boolean @MainThread <T : Any> popBackStack(inclusive: Boolean, saveState: Boolean) Boolean @MainThread <T : Any> popBackStack(     route: KClass<T>,     inclusive: Boolean,     saveState: Boolean ) Boolean @MainThread <T : Any> popBackStack(route: T, inclusive: Boolean, saveState: Boolean) Boolean @MainThread popBackStack(route: String, inclusive: Boolean, saveState: Boolean) open Unit removeOnDestinationChangedListener(     listener: NavController.OnDestinationChangedListener ) open Unit @CallSuper restoreState(navState: SavedState?) open SavedState? @CallSuper saveState() open Unit @MainThread @CallSuper setGraph(graph: NavGraph, startDestinationArgs: SavedState?)
From androidx.navigation.NavHostController final Unit setLifecycleOwner(owner: LifecycleOwner) final Unit setViewModelStore(viewModelStore: ViewModelStore)

Inherited properties
From androidx.navigation.NavController open NavBackStackEntry? currentBackStackEntry Flow<NavBackStackEntry> currentBackStackEntryFlow open NavDestination? currentDestination open NavGraph graph open NavigatorProvider navigatorProvider open NavBackStackEntry? previousBackStackEntry StateFlow<List<NavBackStackEntry>> visibleEntries

Public constructors

TestNavHostController

Added in 2.3.0

TestNavHostController(context: Context)

Public functions

setCurrentDestination

Added in 2.3.0

fun setCurrentDestination(destId: @IdRes Int, args: Bundle = Bundle()): Unit

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
destId: @IdRes Int	The destination id to navigate to.
args: Bundle = Bundle()	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

fun setCurrentDestination(destRoute: String, args: Bundle = Bundle()): Unit

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
destRoute: String	The destination route to navigate to.
args: Bundle = Bundle()	The arguments to pass to the destination.

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

Public properties

backStack

Added in 2.3.0

val backStack: List<NavBackStackEntry>

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