PagingSource.LoadParams

public sealed class PagingSource.LoadParams<Key extends Object>

Known direct subclasses
PagingSource.LoadParams.Append

Params to load a page of data from a PagingSource via PagingSource.load to be appended to the end of the list.

PagingSource.LoadParams.Prepend

Params to load a page of data from a PagingSource via PagingSource.load to be prepended to the start of the list.

PagingSource.LoadParams.Refresh

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


Params for a load request on a PagingSource from PagingSource.load.

Summary

Nested types

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

Params to load a page of data from a PagingSource via PagingSource.load to be appended to the end of the list.

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

Params to load a page of data from a PagingSource via PagingSource.load to be prepended to the start of the list.

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.

Protected constructors

<Key extends Object> LoadParams(int loadSize, boolean placeholdersEnabled)

Public methods

abstract Key

Key for the page to be loaded.

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.

Protected constructors

LoadParams

protected <Key extends Object> LoadParams(int loadSize, boolean placeholdersEnabled)

Public methods

getKey

Added in 3.0.0
public abstract 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:

getLoadSize

Added in 3.0.0
public final int getLoadSize()

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.

getPlaceholdersEnabled

Added in 3.0.0
public final boolean getPlaceholdersEnabled()

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.