dispatch-android-lifecycle/dispatch.android.lifecycle

Package dispatch.android.lifecycle

Types

DispatchLifecycleScope

open class DispatchLifecycleScope(lifecycle: Lifecycle, coroutineContext: CoroutineContext) : MainImmediateCoroutineScope

MainImmediateCoroutineScope which is tied to a Lifecycle.

DispatchLifecycleScopeFactory

class DispatchLifecycleScopeFactory(coroutineContextFactory: () -> CoroutineContext)

Factory for DispatchLifecycleScopes. This may be injected into a lifecycle-aware class to provide custom CoroutineContexts.

LifecycleCoroutineScope

~~typealias~~ LifecycleCoroutineScope = DispatchLifecycleScope

Deprecated in favor of DispatchLifecycleScope in order to avoid name collisions with Androidx.

ViewLifecycleCoroutineScope

class ViewLifecycleCoroutineScope : DispatchLifecycleScope

DispatchLifecycleScope instance which is tied to a Fragment's View lifecycle.

Functions

MainImmediateContext

fun MainImmediateContext(): CoroutineContext

Default implementation of a CoroutineContext as seen in a MainImmediateCoroutineScope.

suspend fun <T> Lifecycle.onNextCreate(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

suspend fun <T> LifecycleOwner.onNextCreate(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

Executes block one time, the next time the Lifecycle's state is at least Lifecycle.State.CREATED.

suspend fun <T> Lifecycle.onNextResume(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

suspend fun <T> LifecycleOwner.onNextResume(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

Executes block one time, the next time the Lifecycle's state is at least Lifecycle.State.RESUMED.

suspend fun <T> Lifecycle.onNextStart(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

suspend fun <T> LifecycleOwner.onNextStart(context: CoroutineContext = EmptyCoroutineContext, block: suspend CoroutineScope.() -> T): T?

Executes block one time, the next time the Lifecycle's state is at least Lifecycle.State.STARTED.

withViewLifecycle

@ExperimentalCoroutinesApi

fun CoroutineScope.withViewLifecycle(fragment: Fragment, block: ViewLifecycleCoroutineScope.() -> Unit): Job

CoroutineScope helper for a Fragment's ViewLifecycleOwner.