WorkMetricsInfo.State
enum WorkMetricsInfo.State : Enum
Summary
Enum Values |
|
|---|---|
CANCELLED |
Used to indicate that the |
ENQUEUED_BLOCKED |
Used to indicate that the |
ENQUEUED_PENDING |
Used to indicate that the |
FAILED |
Used to indicate that this |
OBSOLETE_UPDATED |
Used to indicate that the |
RUNNING |
Used to indicate that this |
SUCCEEDED |
Used to indicate that this |
Public functions |
|
|---|---|
WorkMetricsInfo.State |
Returns the enum constant of this type with the specified name. |
Array<WorkMetricsInfo.State> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Public properties |
|
|---|---|
EnumEntries<WorkMetricsInfo.State> |
Returns a representation of an immutable list of all enum entries, in the order they're declared. |
Enum Values
CANCELLED
val WorkMetricsInfo.State.CANCELLED: WorkMetricsInfo.State
Used to indicate that the androidx.work.WorkRequest period has been cancelled.
ENQUEUED_BLOCKED
val WorkMetricsInfo.State.ENQUEUED_BLOCKED: WorkMetricsInfo.State
Used to indicate that the androidx.work.WorkRequest period is enqueued and still active but blocked by pre-requisite work.
ENQUEUED_PENDING
val WorkMetricsInfo.State.ENQUEUED_PENDING: WorkMetricsInfo.State
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
val WorkMetricsInfo.State.FAILED: WorkMetricsInfo.State
Used to indicate that this androidx.work.WorkRequest period completed in a failed state.
OBSOLETE_UPDATED
val WorkMetricsInfo.State.OBSOLETE_UPDATED: WorkMetricsInfo.State
Used to indicate that the androidx.work.WorkRequest period is obsolete because the androidx.work.WorkRequest was updated.
RUNNING
val WorkMetricsInfo.State.RUNNING: WorkMetricsInfo.State
Used to indicate that this androidx.work.WorkRequest period is currently running.
SUCCEEDED
val WorkMetricsInfo.State.SUCCEEDED: WorkMetricsInfo.State
Used to indicate that this androidx.work.WorkRequest period completed in a successful state.
Public functions
valueOf
fun valueOf(value: String): WorkMetricsInfo.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.)
| Throws | |
|---|---|
kotlin.IllegalArgumentException |
if this enum type has no constant with the specified name |
values
fun values(): Array<WorkMetricsInfo.State>
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.
Public properties
entries
val entries: EnumEntries<WorkMetricsInfo.State>
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.