{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} {% include "_shared/_reference-head-tags.html" %}

PagingSource.LoadParams.Prepend

class PagingSource.LoadParams.Prepend<Key : Any> : PagingSource.LoadParams

kotlin.Any
   ↳ androidx.paging.PagingSource.LoadParams
     ↳ androidx.paging.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.

Summary

Public constructors

<Key : Any> Prepend(key: Key, loadSize: Int, placeholdersEnabled: Boolean)

Public properties

open Key

Key for the page to be loaded.

Inherited properties

From androidx.paging.PagingSource.LoadParams
Int

Requested number of items to load.

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

Prepend

<Key : Any> Prepend(key: Key, loadSize: Int, placeholdersEnabled: Boolean)

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: