LifecycleResumePauseEffectScope

Receiver scope for LifecycleResumeEffect that offers the onPauseOrDispose clause to couple the ON_RESUME effect. This should be the last statement in any call to LifecycleResumeEffect.

This scope is also a LifecycleOwner to allow access to the (lifecycle)LifecycleResumePauseEffectScope.lifecycle within the onPauseOrDispose clause.

Summary

Public constructors
Cmn

Public functions
inline LifecyclePauseOrDisposeEffectResult
onPauseOrDispose(crossinline onPauseOrDisposeEffect: LifecycleOwner.() -> Unit)

Provide the onPauseOrDisposeEffect to the LifecycleResumeEffect to run when the observer receives an (ON_PAUSE)Lifecycle.Event.ON_PAUSE event or must undergo cleanup.
Cmn

Public properties
open Lifecycle

The lifecycle being observed by this receiver scope
Cmn

Public constructors

LifecycleResumePauseEffectScope

Cmn
Added in 2.7.0
LifecycleResumePauseEffectScope(lifecycle: Lifecycle)
Parameters
lifecycle: Lifecycle

The lifecycle being observed by this receiver scope

Public functions

onPauseOrDispose

Cmn
Added in 2.7.0
inline fun onPauseOrDispose(crossinline onPauseOrDisposeEffect: LifecycleOwner.() -> Unit): LifecyclePauseOrDisposeEffectResult

Provide the onPauseOrDisposeEffect to the LifecycleResumeEffect to run when the observer receives an (ON_PAUSE)Lifecycle.Event.ON_PAUSE event or must undergo cleanup.

Public properties

lifecycle

Cmn
Added in 2.7.0
open val lifecycle: Lifecycle

The lifecycle being observed by this receiver scope