PagedList.Config

Added in 2.0.0
Deprecated in 3.0.0


Configures how a PagedList loads content from its PagingSource.

Use PagedList.Config.Builder to construct and define custom loading behavior, such as setPageSize, which defines number of items loaded at a time.

Summary

Nested types

Builder class for PagedList.Config.

Public properties

Boolean

Defines whether the PagedList may display null placeholders, if the PagingSource provides them.

android
Int

Size hint for initial load of PagedList, often larger than a regular page.

android
Int

Defines the maximum number of items that may be loaded into this pagedList before pages should be dropped.

android
Int

Size of each page loaded by the PagedList.

android
Int

Prefetch distance which defines how far ahead to load.

android

Public properties

enablePlaceholders

val enablePlaceholdersBoolean

Defines whether the PagedList may display null placeholders, if the PagingSource provides them.

initialLoadSizeHint

val initialLoadSizeHintInt

Size hint for initial load of PagedList, often larger than a regular page.

maxSize

val maxSizeInt

Defines the maximum number of items that may be loaded into this pagedList before pages should be dropped.

If set to PagedList.Config.Companion.MAX_SIZE_UNBOUNDED, pages will never be dropped.

pageSize

val pageSizeInt

Size of each page loaded by the PagedList.

prefetchDistance

val prefetchDistanceInt

Prefetch distance which defines how far ahead to load.

If this value is set to 50, the paged list will attempt to load 50 items in advance of data that's already been accessed.

See also
loadAround