PagingSource.LoadParams.Refresh

Added in 3.0.0

Kotlin |Java

Cmn

class PagingSource.LoadParams.Refresh<Key : Any> : PagingSource.LoadParams

kotlin.Any
↳	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 : Any> Refresh(key: Key?, loadSize: Int, placeholdersEnabled: Boolean)`	Cmn

Public properties
`open Key?`	`key` Key for the page to be loaded.	Cmn

`Int`	`loadSize` Requested number of items to load.	Cmn
`Boolean`	`placeholdersEnabled` 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.	Cmn

Cmn

<Key : Any> Refresh(key: Key?, loadSize: Int, placeholdersEnabled: Boolean)

Cmn

Added in 3.3.4

open val key: Key?

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.