architecture/com.splendo.kaluga.architecture.navigation/Navigator

Navigator

actual interface Navigator<Action : NavigationAction<*>> : LifecycleSubscribable

Class that can trigger a given NavigationAction

Type Parameters

Action

the type of NavigationAction this navigator should respond to.

Inheritors

ActivityNavigator

expect interface Navigator<Action : NavigationAction<*>> : LifecycleSubscribable

Class that can trigger a given NavigationAction

Type Parameters

Action

the type of NavigationAction this navigator should respond to.

actual interface Navigator<Action : NavigationAction<*>> : LifecycleSubscribable

Class that can trigger a given NavigationAction

Type Parameters

Action

the type of NavigationAction this navigator should respond to.

Inheritors

DefaultNavigator

ViewControllerNavigator

Functions

actual abstract fun navigate(action: Action)

Triggers a given NavigationAction

expect abstract fun navigate(action: Action)

Triggers a given NavigationAction

actual abstract fun navigate(action: Action)

Triggers a given NavigationAction

fun <Action : NavigationAction<*>> Navigator<Action>.navigateOrElse(action: Action, onFailure: () -> Unit)

Triggers a given NavigationAction or executes a closure if the navigation failed to complete.

navigateWithSuccess

fun <Action : NavigationAction<*>> Navigator<Action>.navigateWithSuccess(action: Action): Boolean

Triggers a given NavigationAction and returns true if it succeeded.