WorkQuery
class WorkQuery
| kotlin.Any | |
| ↳ | androidx.work.WorkQuery |
A specification for querying WorkRequests. This is comprised of 4 components; namely ids, unique work names, tags & work states.
A List of WorkRequest ids, or a List of unique work names, or a List of WorkRequest tags, or a List of WorkInfo.State can be specified.
Each component in a WorkQuery is AND-ed with the others. Each value in a component is OR-ed.
Example: (id1 OR id2 OR ...) AND (name1 OR name2 OR ...) AND (tag1 OR tag2 OR ...) AND (state1 OR state2 OR ...)
Summary
| Nested classes | |
|---|---|
|
A builder for |
|
| Public methods | |
|---|---|
| MutableList<UUID!> |
getIds() |
| MutableList<WorkInfo.State!> | |
| MutableList<String!> |
getTags() |
| MutableList<String!> | |
Public methods
getIds
@NonNull fun getIds(): MutableList<UUID!>
| Return | |
|---|---|
MutableList<UUID!> |
The List of WorkRequest ids being queried. |
getStates
@NonNull fun getStates(): MutableList<WorkInfo.State!>
| Return | |
|---|---|
MutableList<WorkInfo.State!> |
the List of WorkInfo.States being queried |
getTags
@NonNull fun getTags(): MutableList<String!>
| Return | |
|---|---|
MutableList<String!> |
the List of tags being queried |
getUniqueWorkNames
@NonNull fun getUniqueWorkNames(): MutableList<String!>
| Return | |
|---|---|
MutableList<String!> |
the List of unique works name being queried |