WorkMetricsInfo.State

Kotlin |Java

public enum WorkMetricsInfo.State extends Enum

java.lang.Object
↳	kotlin.Enum
	↳	androidx.work.analytics.WorkMetricsInfo.State

Summary

Enum Values
`CANCELLED`	Used to indicate that the `androidx.work.WorkRequest` period has been cancelled.
`ENQUEUED_BLOCKED`	Used to indicate that the `androidx.work.WorkRequest` period is enqueued and still active but blocked by pre-requisite work.
`ENQUEUED_PENDING`	Used to indicate that the `androidx.work.WorkRequest` period is enqueued and still active and will run when its constraints are met and resources are available.
`FAILED`	Used to indicate that this `androidx.work.WorkRequest` period completed in a failed state.
`OBSOLETE_UPDATED`	Used to indicate that the `androidx.work.WorkRequest` period is obsolete because the `androidx.work.WorkRequest` was updated.
`RUNNING`	Used to indicate that this `androidx.work.WorkRequest` period is currently running.
`SUCCEEDED`	Used to indicate that this `androidx.work.WorkRequest` period completed in a successful state.

Public methods
`final @NonNull EnumEntries<@NonNull WorkMetricsInfo.State>`	`getEntries()` Returns a representation of an immutable list of all enum entries, in the order they're declared.
`final @NonNull WorkMetricsInfo.State`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`final @NonNull WorkMetricsInfo.State[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

CANCELLED

WorkMetricsInfo.State WorkMetricsInfo.State.CANCELLED

Used to indicate that the androidx.work.WorkRequest period has been cancelled.

ENQUEUED_BLOCKED

WorkMetricsInfo.State WorkMetricsInfo.State.ENQUEUED_BLOCKED

Used to indicate that the androidx.work.WorkRequest period is enqueued and still active but blocked by pre-requisite work.

ENQUEUED_PENDING

WorkMetricsInfo.State WorkMetricsInfo.State.ENQUEUED_PENDING

Used to indicate that the androidx.work.WorkRequest period is enqueued and still active and will run when its constraints are met and resources are available.

FAILED

WorkMetricsInfo.State WorkMetricsInfo.State.FAILED

Used to indicate that this androidx.work.WorkRequest period completed in a failed state.

OBSOLETE_UPDATED

WorkMetricsInfo.State WorkMetricsInfo.State.OBSOLETE_UPDATED

Used to indicate that the androidx.work.WorkRequest period is obsolete because the androidx.work.WorkRequest was updated.

RUNNING

WorkMetricsInfo.State WorkMetricsInfo.State.RUNNING

Used to indicate that this androidx.work.WorkRequest period is currently running.

SUCCEEDED

WorkMetricsInfo.State WorkMetricsInfo.State.SUCCEEDED

Used to indicate that this androidx.work.WorkRequest period completed in a successful state.

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull WorkMetricsInfo.State> getEntries()

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

This method may be used to iterate over the enum entries.

valueOf

Added in 2.12.0-alpha01

public final @NonNull WorkMetricsInfo.State valueOf(@NonNull String value)

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.)

Throws
`kotlin.IllegalArgumentException`	if this enum type has no constant with the specified name

values

Added in 2.12.0-alpha01

public final @NonNull WorkMetricsInfo.State[] values()

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

This method may be used to iterate over the constants.