RemoteMediator.InitializeAction
-
Cmn
enum RemoteMediator.InitializeAction : Enum
Return type of initialize, which signals the action to take after initialize completes.
Summary
Enum Values |
|
|---|---|
LAUNCH_INITIAL_REFRESH |
Immediately dispatch a |
SKIP_INITIAL_REFRESH |
Wait for a refresh request from the UI before dispatching |
Public functions |
||
|---|---|---|
RemoteMediator.InitializeAction |
Returns the enum constant of this type with the specified name. |
Cmn
|
Array<RemoteMediator.InitializeAction> |
values()Returns an array containing the constants of this enum type, in the order they're declared. |
Cmn
|
Public properties |
||
|---|---|---|
EnumEntries<RemoteMediator.InitializeAction> |
Returns an immutable |
Cmn
|
Enum Values
LAUNCH_INITIAL_REFRESH
val RemoteMediator.InitializeAction.LAUNCH_INITIAL_REFRESH: RemoteMediator.InitializeAction
Immediately dispatch a load asynchronously with load type REFRESH, to update paginated content when the stream is initialized.
Note: This also prevents RemoteMediator from triggering PREPEND or APPEND until REFRESH succeeds.
SKIP_INITIAL_REFRESH
val RemoteMediator.InitializeAction.SKIP_INITIAL_REFRESH: RemoteMediator.InitializeAction
Wait for a refresh request from the UI before dispatching load with load type REFRESH
Public functions
valueOf
fun valueOf(value: String): RemoteMediator.InitializeAction
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<RemoteMediator.InitializeAction>
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<RemoteMediator.InitializeAction>
Returns an immutable kotlin.enums.EnumEntries list containing the constants of this enum type, in the order they're declared.