If the given launchInfo can be handled using deepLinkHandlers and deepLinkPrefixes then the navigator will clear the current back stack and navigate to the required destinations.

fun HostNavigator.handleDeepLink(intent: Intent, destinations: ImmutableSet<NavDestination<*>>, deepLinkHandlers: ImmutableSet<DeepLinkHandler>, deepLinkPrefixes: ImmutableSet<DeepLinkHandler.Prefix>): Boolean

If the given Intent was created from a DeepLink or the Uri returned by Intent.getData can be handled using deepLinkHandlers and deepLinkPrefixes then the navigator will clear the current back stack and navigate to the required destinations.

navigate

abstract fun navigate(block: Navigator.() -> Unit)

Allows to group multiple navigation actions and execute them atomically. The state of this HostNavigator will only be updated after running all actions. This should be used when navigating multiple times, for example calling navigateBackTo followed by navigateTo.

navigateBack

abstract fun navigateBack()

Removes the top entry from the backstack to show the previous destination.

navigateBackTo

abstract fun <T : BaseRoute> navigateBackTo(popUpTo: KClass<T>, inclusive: Boolean = false)

Removes all entries from the backstack until T. If inclusive is true T itself will also be removed.

navigateBackTo

inline fun <T : NavRoute> Navigator.navigateBackTo(inclusive: Boolean = false)

Removes all entries from the backstack until T. If inclusive is true T itself will also be removed.

navigateTo

abstract fun navigateTo(route: NavRoute)

Triggers navigation to the given route.

navigateUp

abstract fun navigateUp()

Triggers up navigation.

registerForNavigationResult

inline fun <T : BaseRoute, O : Any> Navigator.registerForNavigationResult(): NavigationResultRequest<O>

replaceAllBackStacks

abstract fun replaceAllBackStacks(root: NavRoot)

Remove all back stacks and create a new back stack with the given root.

showRoot

abstract fun showRoot(root: NavRoot)

Show root as the current destination. If there already is a back stack for root, regardless of whether it is the current back stack or not, the stack will be cleared.

switchBackStack

abstract fun switchBackStack(root: NavRoot)

Show the existing back stack for root or create a new back stack if none exists. If an existing back stack is shown it will be shown in it's previous state. If root is the root of the current back stack this is a no-op.