{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}
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 fields |
|
---|---|
@NonNull Key |
Key for the page to be loaded. |
final int |
Requested number of items to load. |
final boolean |
From |
Public constructors |
|
---|---|
@NonNull
public @NonNull 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.
@NonNull
public final 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.
@NonNull
public final 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.