oskit-kmp/com.outsidesource.oskitkmp.router/IRouter

IRouter

interface IRouter

A Router is stack of RouteStackEntry that allows pushing and popping of routes.

Inheritors

Properties

Link copied to clipboard
abstract val current: RouteStackEntry
Link copied to clipboard
abstract val routeFlow: StateFlow<RouteStackEntry>
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun addRouteLifecycleListener(listener: IRouteLifecycleListener)

Adds a lifecycle listener to the current route. onRouteStarted() is called immediately. The listener is automatically removed when the route is destroyed.

Link copied to clipboard
abstract fun hasBackStack(): Boolean

Returns true if there is a route to pop off of the route stack

Link copied to clipboard
abstract fun markTransitionStatus(status: RouteTransitionStatus)

Allows the router to block spamming of push/pop operations if a transition is ongoing. Implementers of Router should call this at the start and end of any Route transition.

Link copied to clipboard
abstract fun pop(ignoreTransitionLock: Boolean = false, popFunc: RoutePopFunc = { once() })

Pops the current active route off of the backstack using the provided popFunc

Link copied to clipboard
abstract fun push(route: IRoute, transition: IRouteTransition? = null, ignoreTransitionLock: Boolean = false)

Navigates to the given route and moves the current active route to an inactive state

Link copied to clipboard
abstract fun replace(route: IRoute, transition: IRouteTransition? = null, ignoreTransitionLock: Boolean = false)

Navigates to the given route and moves the current active route to an inactive state

Link copied to clipboard
abstract fun tearDown()

Allows the router to tear down anything that was initialized when the router was constructed

Link copied to clipboard
abstract fun transaction(ignoreTransitionLock: Boolean = false, transaction: IRouterTransactionScope.() -> Unit)

Allows performing several routing operations in a single transaction. routeFlow collectors will only be notified at the end of the transaction a single time.

Link copied to clipboard
abstract suspend fun <T : Any> transactionWithResult(resultType: KClass<T>, ignoreTransitionLock: Boolean = false, transaction: IRouterTransactionScope.() -> Unit): Outcome<T, RouteResultError>

Does everything IRouter.transaction does but suspends until a result is set by IRoutePopScope.withResult or until the top route is popped off the stack. The last statement in transactionWithResult should be a push or replace