navigation/com.freeletics.khonshu.navigation/DestinationNavigator

DestinationNavigator

abstract class DestinationNavigator(val hostNavigator: HostNavigator) : Navigator, ActivityNavigator

A combination of Navigator and com.freeletics.khonshu.navigation.activity.ActivityNavigator that can be used as base class for navigators of individual screens.

Constructors

DestinationNavigator

constructor(hostNavigator: HostNavigator)

Properties

val activityEvents: Flow<ActivityEvent>

activityResultRequests

val activityResultRequests: List<ActivityResultContractRequest<*, *, *>>

val hostNavigator: HostNavigator

Functions

deliverNavigationResult

inline fun <O> Navigator.deliverNavigationResult(key: NavigationResultRequest.Key<O>, result: O)

Delivers the result to the destination that created key.

open override fun getEntryFor(id: StackEntry.Id): StackEntry<*>

open override fun getTopEntryFor(destinationId: DestinationId<*>): StackEntry<*>

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

See HostNavigator.navigate.

open override fun navigateBack()

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

open override fun <T : BaseRoute> navigateBackTo(popUpTo: KClass<T>, inclusive: Boolean)

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

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.

navigateForResult

fun navigateForResult(request: ActivityResultRequest<Void?, *>)

Launches the given request.

fun <I> navigateForResult(request: ActivityResultRequest<I, *>, input: I)

Launches the given request with the given input.

open override fun navigateTo(route: NavRoute)

Triggers navigation to the given route.

fun navigateTo(route: ActivityRoute, fallbackRoute: NavRoute? = null)

Triggers navigation to the given route.

open override fun navigateUp()

Triggers up navigation.

registerForActivityResult

fun <I, O> registerForActivityResult(contract: ActivityResultContract<I, O>): ActivityResultRequest<I, O>

Register for receiving activity results for the given contract.

registerForNavigationResult

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

Register for receiving navigation results.

registerForPermissionsResult

fun registerForPermissionsResult(): PermissionsResultRequest

Register for receiving permission results.

replaceAllBackStacks

open override fun replaceAllBackStacks(root: NavRoot)

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

requestPermissions

fun requestPermissions(request: PermissionsResultRequest, vararg permissions: String)

fun requestPermissions(request: PermissionsResultRequest, permissions: List<String>)

Launches the request for the given permissions.

open override 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

open override 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.