PagingSource.LoadParams.Refresh

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


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

Key for the page to be loaded.

Inherited methods

From androidx.paging.PagingSource.LoadParams
final int

Requested number of items to load.

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

Public constructors

Refresh

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

Public methods

getKey

Added in 3.3.0-alpha04
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: