RemoteMediator.InitializeAction

Added in 3.0.0

Kotlin |Java

public enum RemoteMediator.InitializeAction extends Enum

java.lang.Object
↳	kotlin.Enum
	↳	androidx.paging.RemoteMediator.InitializeAction

Return type of initialize, which signals the action to take after initialize completes.

Summary

Enum Values
`LAUNCH_INITIAL_REFRESH`	Immediately dispatch a `load` asynchronously with load type `REFRESH`, to update paginated content when the stream is initialized.
`SKIP_INITIAL_REFRESH`	Wait for a refresh request from the UI before dispatching `load` with load type `REFRESH`

Public methods
`final @NonNull EnumEntries<@NonNull RemoteMediator.InitializeAction>`	`getEntries()` Return type of `initialize`, which signals the action to take after `initialize` completes.
`final @NonNull RemoteMediator.InitializeAction`	`valueOf(@NonNull String value)` Returns the enum constant of this type with the specified name.
`final @NonNull RemoteMediator.InitializeAction[]`	`values()` Returns an array containing the constants of this enum type, in the order they're declared.

Enum Values

LAUNCH_INITIAL_REFRESH

RemoteMediator.InitializeAction RemoteMediator.InitializeAction.LAUNCH_INITIAL_REFRESH

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

RemoteMediator.InitializeAction RemoteMediator.InitializeAction.SKIP_INITIAL_REFRESH

Wait for a refresh request from the UI before dispatching load with load type REFRESH

Public methods

getEntries

public final @NonNull EnumEntries<@NonNull RemoteMediator.InitializeAction> getEntries()

Return type of initialize, which signals the action to take after initialize completes.

valueOf

Added in 3.0.0

public final @NonNull RemoteMediator.InitializeAction 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 3.0.0

public final @NonNull RemoteMediator.InitializeAction[] 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.