PagingSource.LoadParams.Append
-
Cmn
class PagingSource.LoadParams.Append<Key : Any> : PagingSource.LoadParams
kotlin.Any | ||
↳ | androidx.paging.PagingSource.LoadParams | |
↳ | androidx.paging.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.
Summary
Public properties |
||
---|---|---|
open Key |
Key for the page to be loaded. |
Cmn
|
Inherited properties |
||||||
---|---|---|---|---|---|---|
|
Public properties
key
open 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 thePager
. -
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.