LoadType
Type of load a PagingData can trigger a PagingSource to perform.
LoadState of any LoadType may be observed for UI purposes by registering a listener via androidx.paging.PagingDataAdapter.addLoadStateListener or androidx.paging.AsyncPagingDataDiffer.addLoadStateListener.
| See also | |
|---|---|
LoadState |
Summary
Enum Values |
|
|---|---|
APPEND |
Load at the end of a |
PREPEND |
Load at the start of a |
REFRESH |
|
Public functions |
||
|---|---|---|
LoadType |
Returns the enum constant of this type with the specified name. |
Cmn
|
Array<LoadType> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Cmn
|
Public properties |
||
|---|---|---|
EnumEntries<LoadType> |
Returns an immutable |
Cmn
|
Enum Values
REFRESH
val LoadType.REFRESH: LoadType
PagingData content being refreshed, which can be a result of PagingSource invalidation, refresh that may contain content updates, or the initial load.
Public functions
valueOf
fun valueOf(value: String): LoadType
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<LoadType>
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.
The function returns a new instance of the array on every call. The array could be mutated, so working with it may also require defensive copying. Consider using entries property as a more efficient alternative returning an immutable list of enum entries.
Public properties
entries
val entries: EnumEntries<LoadType>
Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.