Google is committed to advancing racial equity for Black communities. See how.

Refresh

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, pageSize: Int = loadSize)

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

Properties
Key?

Key for the page to be loaded.

Inherited properties

Public constructors

<init>

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

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: