PagingSource.LoadParams.Refresh

Added in 3.0.0

Kotlin |Java

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

java.lang.Object
↳	androidx.paging.PagingSource.LoadParams
	↳	androidx.paging.PagingSource.LoadParams.Refresh

Params for an initial load request on a PagingSource from PagingSource.load or a refresh triggered by invalidate.

Summary

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

Public methods
`Key`	`getKey()` Key for the page to be loaded.

`final int`	`getLoadSize()` Requested number of items to load.
`final boolean`	`getPlaceholdersEnabled()` From `PagingConfig.enablePlaceholders`, true if placeholders are enabled and the load request for this `LoadParams` should populate `LoadResult.Page.itemsBefore` and `LoadResult.Page.itemsAfter` if possible.

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

Added in 3.3.1

public Key getKey()

Key for the page to be loaded.

key can be null only if this LoadParams is Refresh, and either no initialKey is provided to the Pager or PagingSource.getRefreshKey from the previous PagingSource returns null.

The value of key is dependent on the type of LoadParams:

On initial load, the nullable initialKey passed to the Pager.
On subsequent loads due to invalidation or refresh, the result of PagingSource.getRefreshKey.

Prepend - LoadResult.Page.prevKey of the loaded page at the front of the list.
Append - LoadResult.Page.nextKey of the loaded page at the end of the list.