TestNavigatorState

Artifact: androidx.navigation:navigation-testing

View Source

Added in 2.4.0

---

Kotlin |Java

public final class TestNavigatorState

---

An implementation of NavigatorState that allows testing a androidx.navigation.Navigator in isolation (i.e., without requiring a androidx.navigation.NavController).

An optional context can be provided to allow for the usages of androidx.lifecycle.AndroidViewModel within the created NavBackStackEntry instances.

The Lifecycle of all NavBackStackEntry instances added to this TestNavigatorState will be updated as they are added and removed from the state. This work is kicked off on the coroutineDispatcher.

Summary

Public constructors
TestNavigatorState(     Context context,     @NonNull CoroutineDispatcher coroutineDispatcher )

Public methods
@NonNull <Error class: unknown class>	createBackStackEntry(     @NonNull <Error class: unknown class> destination,     Bundle arguments )
void	markTransitionComplete(@NonNull <Error class: unknown class> entry)
void	pop(@NonNull <Error class: unknown class> popUpTo, boolean saveState)
void	popWithTransition(     @NonNull <Error class: unknown class> popUpTo,     boolean saveState )
void	prepareForTransition(@NonNull <Error class: unknown class> entry)
void	push(@NonNull <Error class: unknown class> backStackEntry)
final @NonNull <Error class: unknown class>	restoreBackStackEntry(     @NonNull <Error class: unknown class> previouslySavedEntry ) Restore a previously saved NavBackStackEntry.

Public constructors

TestNavigatorState

Added in 2.4.0

public TestNavigatorState(
    Context context,
    @NonNull CoroutineDispatcher coroutineDispatcher
)

Public methods

createBackStackEntry

public @NonNull <Error class: unknown class> createBackStackEntry(
    @NonNull <Error class: unknown class> destination,
    Bundle arguments
)

markTransitionComplete

public void markTransitionComplete(@NonNull <Error class: unknown class> entry)

pop

public void pop(@NonNull <Error class: unknown class> popUpTo, boolean saveState)

popWithTransition

public void popWithTransition(
    @NonNull <Error class: unknown class> popUpTo,
    boolean saveState
)

prepareForTransition

public void prepareForTransition(@NonNull <Error class: unknown class> entry)

push

public void push(@NonNull <Error class: unknown class> backStackEntry)

restoreBackStackEntry

public final @NonNull <Error class: unknown class> restoreBackStackEntry(
    @NonNull <Error class: unknown class> previouslySavedEntry
)

Restore a previously saved NavBackStackEntry. You must have previously called pop with previouslySavedEntry and true.