lifecycletracker/com.multiplatform.lifecycle/State

State

Lifecycle states. You can consider the states as the nodes in a graph and LifecycleEvents as the edges between these nodes.

Possible transitions:

[INITIALIZED] ──┐
                ↓
        ┌── [CREATED] ──┐
        ↓       ↑       ↓
   [DESTROYED]  └── [STARTED] ──┐
                        ↑       ↓
                        └── [RESUMED]

Entries

DESTROYED

Destroyed state for a LifecycleOwner. After this event, this Lifecycle will not dispatch any more events. For instance, for an android.app.Activity, this state is reached right before Activity's android.app.Activity.onDestroy call.

INITIALIZED

Initialized state for a LifecycleOwner. For an android.app.Activity, this is the state when it is constructed but has not received android.app.Activity.onCreate yet.

CREATED

Created state for a LifecycleOwner. For an android.app.Activity, this state is reached in two cases:

STARTED

Started state for a LifecycleOwner. For an android.app.Activity, this state is reached in two cases:

RESUMED

Resumed state for a LifecycleOwner. For an android.app.Activity, this state is reached after android.app.Activity.onResume is called.

Properties

entries

val entries: EnumEntries<State>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name

val name: String

ordinal

val ordinal: Int

Functions

isAtLeast

fun isAtLeast(state: State): Boolean

Compares if this State is greater or equal to the given state.

valueOf

fun valueOf(value: String): State

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values

fun values(): Array<State>

Returns an array containing the constants of this enum type, in the order they're declared.