LifecycleKt

Added in 2.6.0

---

Kotlin |Java

public final class LifecycleKt

---

Summary

Public methods
static final @NonNull LifecycleObserver	addObserver(     @NonNull Lifecycle receiver,     @NonNull Function3<@NonNull LifecycleObserver, @NonNull LifecycleOwner, @NonNull Lifecycle.Event, Unit> action ) Adds a LifecycleObserver to this Lifecycle using the provided action.
static final @NonNull LifecycleCoroutineScope	getCoroutineScope(@NonNull Lifecycle receiver) CoroutineScope tied to this Lifecycle.
static final @NonNull Flow<@NonNull Lifecycle.Event>	getEventFlow(@NonNull Lifecycle receiver) Creates a Flow of Lifecycle.Events dispatched by this Lifecycle.

Public methods

addObserver

Artifact: androidx.lifecycle:lifecycle-common

View Source

Added in 2.11.0

public static final @NonNull LifecycleObserver addObserver(
    @NonNull Lifecycle receiver,
    @NonNull Function3<@NonNull LifecycleObserver, @NonNull LifecycleOwner, @NonNull Lifecycle.Event, Unit> action
)

Adds a LifecycleObserver to this Lifecycle using the provided action.

Invokes action whenever a Lifecycle.Event occurs.

Parameters
@NonNull Function3<@NonNull LifecycleObserver, @NonNull LifecycleOwner, @NonNull Lifecycle.Event, Unit> action	The action invoked on each Lifecycle.Event, providing the LifecycleOwner and the specific Lifecycle.Event.

Returns
@NonNull LifecycleObserver	the added LifecycleObserver instance (can be used to later remove it).

getCoroutineScope

Artifact: androidx.lifecycle:lifecycle-common

View Source

Added in 2.6.0

public static final @NonNull LifecycleCoroutineScope getCoroutineScope(@NonNull Lifecycle receiver)

CoroutineScope tied to this Lifecycle.

Canceled when the Lifecycle is destroyed. Bound to Dispatchers.Main.immediate.

getEventFlow

Artifact: androidx.lifecycle:lifecycle-common

View Source

Added in 2.7.0

public static final @NonNull Flow<@NonNull Lifecycle.Event> getEventFlow(@NonNull Lifecycle receiver)

Creates a Flow of Lifecycle.Events dispatched by this Lifecycle.