PagingSource.LoadParams

Added in 3.0.0

Kotlin |Java

Cmn

sealed class PagingSource.LoadParams<Key : Any>

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
`class PagingSource.LoadParams.Append<Key : Any> : PagingSource.LoadParams` Params to load a page of data from a `PagingSource` via `PagingSource.load` to be appended to the end of the list.
`class PagingSource.LoadParams.Prepend<Key : Any> : PagingSource.LoadParams` Params to load a page of data from a `PagingSource` via `PagingSource.load` to be prepended to the start of the list.
`class PagingSource.LoadParams.Refresh<Key : Any> : PagingSource.LoadParams` Params for an initial load request on a `PagingSource` from `PagingSource.load` or a refresh triggered by `invalidate`.

Protected constructors
`<Key : Any> LoadParams(loadSize: Int, placeholdersEnabled: Boolean)`	Cmn

Public properties
`abstract Key?`	`key` Key for the page to be loaded.	Cmn
`Int`	`loadSize` Requested number of items to load.	Cmn
`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.	Cmn

Cmn

protected <Key : Any> LoadParams(loadSize: Int, placeholdersEnabled: Boolean)

Cmn

Added in 3.0.0

abstract 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:

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.

Cmn

Added in 3.0.0

val loadSize: Int

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.

Cmn

Added in 3.0.0

val placeholdersEnabled: 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.