androidx.paging

Annotations

ExperimentalPagingApi

Marks experimental Paging APIs, which may have known issues that would likely be solved by a source-incompatible change in newer versions of the artifact that supplies it.

Interfaces

AsyncPagedListDiffer.PagedListListener

This interface is deprecated. PagedList is deprecated and has been replaced by PagingData

DataSource.InvalidatedCallback

Invalidation callback for DataSource.

Classes

AdjacentItems

Represents a pair of adjacent items, null values are used to signal boundary conditions.

AsyncPagedListDiffer

This class is deprecated. AsyncPagedListDiffer is deprecated and has been replaced by AsyncPagingDataDiffer

AsyncPagingDataDiffer

Helper class for mapping a PagingData into a RecyclerView.Adapter.

CachedPagingDataKt
CombinedLoadStates

Collection of pagination LoadStates for both a PagingSource, and RemoteMediator.

DataSource

Base class for loading pages of snapshot data into a PagedList.

DataSource.Factory

Factory for DataSources.

InvalidatingPagingSourceFactory

Wrapper class for PagingSource factory intended for usage in Pager construction.

ItemKeyedDataSource

This class is deprecated. ItemKeyedDataSource is deprecated and has been replaced by PagingSource

ItemKeyedDataSource.LoadCallback

Callback for ItemKeyedDataSource loadBefore and loadAfter to return data.

ItemKeyedDataSource.LoadInitialCallback

Callback for loadInitial to return data and, optionally, position/count information.

ItemKeyedDataSource.LoadInitialParams

Holder object for inputs to loadInitial.

ItemKeyedDataSource.LoadParams

Holder object for inputs to loadBefore and loadAfter.

ItemSnapshotList

Snapshot of data being presented by a androidx.pagingAsyncPagingDataDiffer or a PagingDataAdapter.

ListenableFuturePagingSource

ListenableFuture-based compatibility wrapper around PagingSource's suspending APIs.

ListenableFutureRemoteMediator

ListenableFuture-based compatibility wrapper around RemoteMediator's suspending APIs.

LivePagedListBuilder

This class is deprecated. PagedList is deprecated and has been replaced by PagingData

LivePagedListKt
LoadState

LoadState of a PagedList load - associated with a LoadType

LoadState.Error

Loading hit an error.

LoadState.NotLoading

Indicates the PagingData is not currently loading, and no error currently observed.

LoadStateAdapter

Adapter for displaying a RecyclerView item based on LoadState, such as a loading spinner, or a retry error button.

LoadStates

Collection of pagination LoadStates - refresh, prepend, and append.

PageKeyedDataSource

This class is deprecated. PageKeyedDataSource is deprecated and has been replaced by PagingSource

PageKeyedDataSource.LoadCallback

Callback for loadBefore and loadAfter to return data.

PageKeyedDataSource.LoadInitialCallback

Callback for loadInitial to return data and, optionally, position/count information.

PageKeyedDataSource.LoadInitialParams

Holder object for inputs to loadInitial.

PageKeyedDataSource.LoadParams

Holder object for inputs to loadBefore and loadAfter.

PagedList

This class is deprecated. PagedList is deprecated and has been replaced by PagingData

PagedList.BoundaryCallback

Signals when a PagedList has reached the end of available data.

PagedList.Builder

This class is deprecated. PagedList is deprecated and has been replaced by PagingData, which no longer supports constructing snapshots of loaded data manually.

PagedList.Callback

Callback signaling when content is loaded into the list.

PagedList.Config

Configures how a PagedList loads content from its PagingSource.

PagedList.Config.Builder

Builder class for PagedList.Config.

PagedListAdapter

This class is deprecated. PagedListAdapter is deprecated and has been replaced by PagingDataAdapter

Pager

Primary entry point into Paging; constructor for a reactive stream of PagingData.

PagingConfig

An object used to configure loading behavior within a Pager, as it loads content from a PagingSource.

PagingData

Container for Paged data from a single generation of loads.

PagingDataAdapter

RecyclerView.Adapter base class for presenting paged data from PagingDatas in a RecyclerView.

PagingDataFutures
PagingDataTransforms
PagingLiveData
PagingSource

Base class for an abstraction of pageable static data from some source, where loading pages of data is typically an expensive operation.

PagingSource.LoadParams

Params for a load request on a PagingSource from PagingSource.load.

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.

PagingSource.LoadResult

Result of a load request from PagingSource.load.

PagingSource.LoadResult.Error

Error result object for PagingSource.load.

PagingSource.LoadResult.Page

Success result object for PagingSource.load.

PagingState

Snapshot state of Paging system including the loaded pages, the last accessed anchorPosition, and the config used.

PositionalDataSource

This class is deprecated. PositionalDataSource is deprecated and has been replaced by PagingSource

PositionalDataSource.LoadInitialCallback

Callback for loadInitial to return data, position, and count.

PositionalDataSource.LoadInitialParams

Holder object for inputs to loadInitial.

PositionalDataSource.LoadRangeCallback

Callback for PositionalDataSource loadRange to return data.

PositionalDataSource.LoadRangeParams

Holder object for inputs to loadRange.

RemoteMediator

Defines a set of callbacks used to incrementally load data from a remote source into a local source wrapped by a PagingSource, e.g., loading data from network into a local db cache.

RemoteMediator.MediatorResult

Return type of load, which determines LoadState.

RemoteMediator.MediatorResult.Error

Recoverable error that can be retried, sets the LoadState to LoadState.Error.

RemoteMediator.MediatorResult.Success

Success signaling that LoadState should be set to LoadState.NotLoading if endOfPaginationReached is true, otherwise LoadState is kept at LoadState.Loading to await invalidation.

RxPagedListBuilder

This class is deprecated. PagedList is deprecated and has been replaced by PagingData

RxPagedListKt

Enums

DiffingChangePayload

Payloads used to dispatch change events.

LoadType

Type of load a PagingData can trigger a PagingSource to perform.

RemoteMediator.InitializeAction

Return type of initialize, which signals the action to take after initialize completes.

TerminalSeparatorType

Mode for configuring when terminal separators (header and footer) would be displayed by the insertSeparators, insertHeaderItem or insertFooterItem operators on PagingData.