# PagingSource.LoadParams.Refresh

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

*** ** * ** ***


```
public final class PagingSource.LoadParams.Refresh<Key extends Object> extends PagingSource.LoadParams<@NonNull Key>
```

<br />

|---|---|---|
| [java.lang.Object](https://developer.android.com/reference/java/lang/Object.html) |||
| ↳ | [androidx.paging.PagingSource.LoadParams](https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams)\<@[NonNull](https://developer.android.com/reference/androidx/annotation/NonNull) Key\> ||
|   | ↳ | [androidx.paging.PagingSource.LoadParams.Refresh](https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh) |

*** ** * ** ***

Params for an initial load request on a `https://developer.android.com/reference/androidx/paging/PagingSource` from `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)` or a refresh triggered by `https://developer.android.com/reference/androidx/paging/PagingSource#invalidate()`.

## Summary

| ### Public constructors |
|---|
| `<Key extends https://developer.android.com/reference/java/lang/Object.html> https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh#Refresh(kotlin.Any,kotlin.Int,kotlin.Boolean)(Key key, int loadSize, boolean placeholdersEnabled)` |

| ### Public methods |
|---|---|
| `Key` | `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh#getKey()()` Key for the page to be loaded. |

### Inherited methods

From [androidx.paging.PagingSource.LoadParams](https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams) `final int` `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams#getLoadSize()()`

Requested number of items to load.
`final boolean` `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams#getPlaceholdersEnabled()()`

From `https://developer.android.com/reference/androidx/paging/PagingConfig#enablePlaceholders()`, true if placeholders are enabled and the load request for this `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams` should populate `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Page#itemsBefore()` and `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Page#itemsAfter()` if possible.

## Public constructors

### Refresh

```
public <Key extends Object> Refresh(Key key, int loadSize, boolean placeholdersEnabled)
```

## Public methods

### getKey

```
public Key getKey()
```

Key for the page to be loaded.

`https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams#key()` can be `null` only if this `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams` is `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh`, and either no `initialKey` is provided to the `https://developer.android.com/reference/androidx/paging/Pager` or `https://developer.android.com/reference/androidx/paging/PagingSource#getRefreshKey(androidx.paging.PagingState)` from the previous `https://developer.android.com/reference/androidx/paging/PagingSource` returns `null`.

The value of `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams#key()` is dependent on the type of `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams`:

- `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh`

  - On initial load, the nullable `initialKey` passed to the `https://developer.android.com/reference/androidx/paging/Pager`.

  - On subsequent loads due to invalidation or refresh, the result of `https://developer.android.com/reference/androidx/paging/PagingSource#getRefreshKey(androidx.paging.PagingState)`.

- `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Prepend` - `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Page#prevKey()` of the loaded page at the front of the list.

- `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Append` - `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Page#nextKey()` of the loaded page at the end of the list.