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

hasBackStack

open override fun hasBackStack(): Boolean

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

markTransitionStatus

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

pop

open override fun pop(ignoreTransitionLock: Boolean, popFunc: RoutePopFunc)

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

push

open override fun push(route: IRoute, transition: IRouteTransition?, ignoreTransitionLock: Boolean)

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

replace

open override fun replace(route: IRoute, transition: IRouteTransition?, ignoreTransitionLock: Boolean)

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

tearDown

open override fun tearDown()

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

transaction

open override fun transaction(ignoreTransitionLock: Boolean, 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.

transactionWithResult

open suspend override fun <T : Any> transactionWithResult(resultType: KClass<T>, ignoreTransitionLock: Boolean, 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