Refresh

Kotlin |Java

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

kotlin.Any
↳	androidx.paging.PagingSource.LoadParams<Key>
	↳	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
<init>(key: Key?, loadSize: Int, placeholdersEnabled: Boolean) Params for an initial load request on a PagingSource from PagingSource.load or a refresh triggered by invalidate.

Properties
Key?	key Key for the page to be loaded.

Inherited properties

From class LoadParams Int loadSize Requested number of items to load. Note: It is valid for PagingSource.load to return a LoadResult that has a different number of items than the requested load size. 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.

Public constructors

<init>

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

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

Properties

key

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:

• Refresh

  • 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.