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 for the page to be loaded.

Cmn

Inherited properties

From androidx.paging.PagingSource.LoadParams
Int

Requested number of items to load.

Cmn
Boolean

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

Public constructors

Refresh

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

Public properties

key

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: