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 )` Add 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.Event`s containing values 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
)

Add a LifecycleObserver to this Lifecycle using the provided action.

Parameters
`@NonNull Function3<@NonNull LifecycleObserver, @NonNull LifecycleOwner, @NonNull Lifecycle.Event, Unit> action`	The action that will be invoked whenever a `Lifecycle.Event` occurs. It provides the `LifecycleOwner` whose state has changed and the specific `Lifecycle.Event` that was triggered.

Returns
`@NonNull LifecycleObserver`	the `LifecycleObserver` added to the `Lifecycle`. This instance can be used to later remove the observer.

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.

This scope will be canceled when the Lifecycle is destroyed.

This scope is 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 containing values dispatched by this Lifecycle.