# RemoteMediator.InitializeAction

Artifact: [androidx.paging:paging-common](https://developer.android.com/jetpack/androidx/releases/paging) [View Source](https://cs.android.com/search?q=file:androidx/paging/RemoteMediator.kt+class:androidx.paging.RemoteMediator.InitializeAction) Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/paging#3.0.0)

*** ** * ** ***

Common/AllAndroid/JVMNative/C/iOSJavaScript
- Cmn

  ```
  enum RemoteMediator.InitializeAction : Enum<RemoteMediator.InitializeAction>
  ```

|---|---|---|
| [kotlin.Any](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html) |||
| ↳ | [kotlin.Enum](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-enum/index.html)\<[RemoteMediator.InitializeAction](https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction)\> ||
|   | ↳ | [androidx.paging.RemoteMediator.InitializeAction](https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction) |

*** ** * ** ***

Return type of `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#initialize()`, which signals the action to take after `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#initialize()` completes.

## Summary

| ### Enum Values |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction#LAUNCH_INITIAL_REFRESH` | Immediately dispatch a `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#load(androidx.paging.LoadType,androidx.paging.PagingState)` asynchronously with load type `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#REFRESH`, to update paginated content when the stream is initialized. |
| `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction#SKIP_INITIAL_REFRESH` | Wait for a refresh request from the UI before dispatching `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#load(androidx.paging.LoadType,androidx.paging.PagingState)` with load type `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#REFRESH` |

| ### Public functions |
|---|---|---|
| `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction` | `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction#valueOf(kotlin.String)(value: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)` Returns the enum constant of this type with the specified name. | Cmn |
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction>` | `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction#values()()` Returns an array containing the constants of this enum type, in the order they're declared. | Cmn |

| ### Public properties |
|---|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html<https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction>` | `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator.InitializeAction#entries()` Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared. | Cmn |

## Enum Values

### LAUNCH_INITIAL_REFRESH

```
val RemoteMediator.InitializeAction.LAUNCH_INITIAL_REFRESH: RemoteMediator.InitializeAction
```

Immediately dispatch a `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#load(androidx.paging.LoadType,androidx.paging.PagingState)` asynchronously with load type `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#REFRESH`, to update paginated content when the stream is initialized.

Note: This also prevents `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator` from triggering `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#PREPEND` or `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#APPEND` until `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#REFRESH` succeeds.

### SKIP_INITIAL_REFRESH

```
val RemoteMediator.InitializeAction.SKIP_INITIAL_REFRESH: RemoteMediator.InitializeAction
```

Wait for a refresh request from the UI before dispatching `https://developer.android.com/reference/kotlin/androidx/paging/RemoteMediator#load(androidx.paging.LoadType,androidx.paging.PagingState)` with load type `https://developer.android.com/reference/kotlin/androidx/paging/LoadType#REFRESH`

## Public functions

### valueOf

Cmn Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/paging#3.0.0)

```
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 |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-illegal-argument-exception/index.html` | if this enum type has no constant with the specified name |

### values

Cmn Added in [3.0.0](https://developer.android.com/jetpack/androidx/releases/paging#3.0.0)

```
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

Cmn

```
val entries: EnumEntries<RemoteMediator.InitializeAction>
```

Returns an immutable `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.enums/-enum-entries/index.html` list containing the constants of this enum type, in the order they're declared.