# androidx.paging

*** ** * ** ***

## Annotations

|---|---|
| `https://developer.android.com/reference/androidx/paging/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

|---|---|
| `https://developer.android.com/reference/androidx/paging/AsyncPagedListDiffer.PagedListListener` | **This interface is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/DataSource.InvalidatedCallback` | Invalidation callback for `https://developer.android.com/reference/androidx/paging/DataSource`. |
| `https://developer.android.com/reference/androidx/paging/Logger` | **This interface is deprecated.** Logger interface is no longer supported. |
| `https://developer.android.com/reference/androidx/paging/PagingSourceFactory` | Interface for a factory that generates `https://developer.android.com/reference/androidx/paging/PagingSource`. |
| `https://developer.android.com/reference/androidx/paging/PlaceholderPaddedList` | Interface to paged list that could contain placeholders. |

## Classes

|---|---|
| `https://developer.android.com/reference/androidx/paging/AdjacentItems` | Represents a pair of adjacent items, null values are used to signal boundary conditions. |
| `https://developer.android.com/reference/androidx/paging/AsyncPagedListDiffer` | **This class is deprecated.** AsyncPagedListDiffer is deprecated and has been replaced by AsyncPagingDataDiffer |
| `https://developer.android.com/reference/androidx/paging/AsyncPagingDataDiffer` | Helper class for mapping a `https://developer.android.com/reference/androidx/paging/PagingData` into a `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.Adapter`. |
| `https://developer.android.com/reference/androidx/paging/CachedPagingDataKt` |   |
| `https://developer.android.com/reference/androidx/paging/CombinedLoadStates` | Collection of pagination `https://developer.android.com/reference/androidx/paging/LoadState`s for both a `https://developer.android.com/reference/androidx/paging/PagingSource`, and `https://developer.android.com/reference/androidx/paging/RemoteMediator`. |
| `https://developer.android.com/reference/androidx/paging/CombinedLoadStatesKt` |   |
| `https://developer.android.com/reference/androidx/paging/DataSource` | Base class for loading pages of snapshot data into a `https://developer.android.com/reference/androidx/paging/PagedList`. |
| `https://developer.android.com/reference/androidx/paging/DataSource.Factory` | Factory for DataSources. |
| `https://developer.android.com/reference/androidx/paging/InvalidatingPagingSourceFactory` | Wrapper class for a `https://developer.android.com/reference/androidx/paging/PagingSource` factory intended for usage in `https://developer.android.com/reference/androidx/paging/Pager` construction. |
| `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource` | **This class is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadCallback` | **This class is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialCallback` | **This class is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadInitialParams` | **This class is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/ItemKeyedDataSource.LoadParams` | **This class is deprecated.** ItemKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/ItemSnapshotList` | Snapshot of data being presented by a androidx.pagingAsyncPagingDataDiffer or a androidx.paging.PagingDataAdapter. |
| `https://developer.android.com/reference/androidx/paging/ItemSnapshotListFlow` |   |
| `https://developer.android.com/reference/androidx/paging/ListenableFuturePagingSource` | `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html`-based compatibility wrapper around `https://developer.android.com/reference/androidx/paging/PagingSource`'s suspending APIs. |
| `https://developer.android.com/reference/androidx/paging/ListenableFutureRemoteMediator` | `https://guava.dev/releases/snapshot-android/api/docs/com/google/common/util/concurrent/ListenableFuture.html`-based compatibility wrapper around `https://developer.android.com/reference/androidx/paging/RemoteMediator`'s suspending APIs. |
| `https://developer.android.com/reference/androidx/paging/LivePagedListBuilder` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/LivePagedListKt` |   |
| `https://developer.android.com/reference/androidx/paging/LoadState` | LoadState of a PagedList load - associated with a `https://developer.android.com/reference/androidx/paging/LoadType` |
| `https://developer.android.com/reference/androidx/paging/LoadState.Error` | Loading hit an error. |
| `https://developer.android.com/reference/androidx/paging/LoadState.NotLoading` | Indicates the `https://developer.android.com/reference/androidx/paging/PagingData` is not currently loading, and no error currently observed. |
| `https://developer.android.com/reference/androidx/paging/LoadStateAdapter` | Adapter for displaying a RecyclerView item based on `https://developer.android.com/reference/androidx/paging/LoadState`, such as a loading spinner, or a retry error button. |
| `https://developer.android.com/reference/androidx/paging/LoadStates` | Collection of pagination `https://developer.android.com/reference/androidx/paging/LoadState`s - refresh, prepend, and append. |
| `https://developer.android.com/reference/androidx/paging/PageKeyedDataSource` | **This class is deprecated.** PageKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PageKeyedDataSource.LoadCallback` | **This class is deprecated.** PageKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PageKeyedDataSource.LoadInitialCallback` | **This class is deprecated.** PageKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams` | **This class is deprecated.** PageKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PageKeyedDataSource.LoadParams` | **This class is deprecated.** PageKeyedDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PagedList` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/PagedList.BoundaryCallback` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/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. |
| `https://developer.android.com/reference/androidx/paging/PagedList.Callback` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/PagedList.Config` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/PagedList.Config.Builder` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/PagedListAdapter` | **This class is deprecated.** PagedListAdapter is deprecated and has been replaced by PagingDataAdapter |
| `https://developer.android.com/reference/androidx/paging/Pager` | Primary entry point into Paging; constructor for a reactive stream of `https://developer.android.com/reference/androidx/paging/PagingData`. |
| `https://developer.android.com/reference/androidx/paging/PagingConfig` | An object used to configure loading behavior within a `https://developer.android.com/reference/androidx/paging/Pager`, as it loads content from a `https://developer.android.com/reference/androidx/paging/PagingSource`. |
| `https://developer.android.com/reference/androidx/paging/PagingData` | Container for Paged data from a single generation of loads. |
| `https://developer.android.com/reference/androidx/paging/PagingDataAdapter` | `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView.Adapter` base class for presenting paged data from `https://developer.android.com/reference/androidx/paging/PagingData`s in a `https://developer.android.com/reference/androidx/recyclerview/widget/RecyclerView`. |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent` | Events captured from a `https://developer.android.com/reference/androidx/paging/PagingData` that was submitted to the `https://developer.android.com/reference/androidx/paging/PagingDataPresenter` |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent.Append` | An append load event |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent.DropAppend` | A drop event from the end of the list |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent.DropPrepend` | A drop event from the front of the list |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent.Prepend` | A prepend load event |
| `https://developer.android.com/reference/androidx/paging/PagingDataEvent.Refresh` | A refresh load event |
| `https://developer.android.com/reference/androidx/paging/PagingDataFutures` |   |
| `https://developer.android.com/reference/androidx/paging/PagingDataPresenter` | The class that connects the UI layer to the underlying Paging operations. |
| `https://developer.android.com/reference/androidx/paging/PagingDataTransforms` |   |
| `https://developer.android.com/reference/androidx/paging/PagingLiveData` |   |
| `https://developer.android.com/reference/androidx/paging/PagingSource` | Base class for an abstraction of pageable static data from some source, where loading pages of data is typically an expensive operation. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams` | Params for a load request on a `https://developer.android.com/reference/androidx/paging/PagingSource` from `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)`. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Append` | Params to load a page of data from a `https://developer.android.com/reference/androidx/paging/PagingSource` via `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)` to be appended to the end of the list. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Prepend` | Params to load a page of data from a `https://developer.android.com/reference/androidx/paging/PagingSource` via `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)` to be prepended to the start of the list. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadParams.Refresh` | Params for an initial load request on a `https://developer.android.com/reference/androidx/paging/PagingSource` from `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)` or a refresh triggered by `https://developer.android.com/reference/androidx/paging/PagingSource#invalidate()`. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult` | Result of a load request from `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)`. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Error` | Error result object for `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)`. |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Invalid` | Invalid result object for `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)` |
| `https://developer.android.com/reference/androidx/paging/PagingSource.LoadResult.Page` | Success result object for `https://developer.android.com/reference/androidx/paging/PagingSource#load(androidx.paging.PagingSource.LoadParams)`. |
| `https://developer.android.com/reference/androidx/paging/PagingState` | Snapshot state of Paging system including the loaded `https://developer.android.com/reference/androidx/paging/PagingState#pages()`, the last accessed `https://developer.android.com/reference/androidx/paging/PagingState#anchorPosition()`, and the `https://developer.android.com/reference/androidx/paging/PagingState#config()` used. |
| `https://developer.android.com/reference/androidx/paging/PositionalDataSource` | **This class is deprecated.** PositionalDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PositionalDataSource.LoadInitialCallback` | **This class is deprecated.** PositionalDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PositionalDataSource.LoadInitialParams` | **This class is deprecated.** PositionalDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PositionalDataSource.LoadRangeCallback` | **This class is deprecated.** PositionalDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/PositionalDataSource.LoadRangeParams` | **This class is deprecated.** PositionalDataSource is deprecated and has been replaced by PagingSource |
| `https://developer.android.com/reference/androidx/paging/RemoteMediator` | Defines a set of callbacks used to incrementally load data from a remote source into a local source wrapped by a `https://developer.android.com/reference/androidx/paging/PagingSource`, e.g., loading data from network into a local db cache. |
| `https://developer.android.com/reference/androidx/paging/RemoteMediator.MediatorResult` | Return type of `https://developer.android.com/reference/androidx/paging/RemoteMediator#load(androidx.paging.LoadType,androidx.paging.PagingState)`, which determines `https://developer.android.com/reference/androidx/paging/LoadState`. |
| `https://developer.android.com/reference/androidx/paging/RemoteMediator.MediatorResult.Error` | Recoverable error that can be retried, sets the `https://developer.android.com/reference/androidx/paging/LoadState` to `https://developer.android.com/reference/androidx/paging/LoadState.Error`. |
| `https://developer.android.com/reference/androidx/paging/RemoteMediator.MediatorResult.Success` | Success signaling that `https://developer.android.com/reference/androidx/paging/LoadState` should be set to `https://developer.android.com/reference/androidx/paging/LoadState.NotLoading` if `https://developer.android.com/reference/androidx/paging/RemoteMediator.MediatorResult.Success#endOfPaginationReached()` is `true`, otherwise `https://developer.android.com/reference/androidx/paging/LoadState` is kept at `https://developer.android.com/reference/androidx/paging/LoadState.Loading` to await invalidation. |
| `https://developer.android.com/reference/androidx/paging/RxPagedListBuilder` | **This class is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `https://developer.android.com/reference/androidx/paging/RxPagedListKt` |   |
| `https://developer.android.com/reference/androidx/paging/LoadState.Loading` | Loading is in progress. |

## Enums

|---|---|
| `https://developer.android.com/reference/androidx/paging/LoadType` | Type of load a `https://developer.android.com/reference/androidx/paging/PagingData` can trigger a `https://developer.android.com/reference/androidx/paging/PagingSource` to perform. |
| `https://developer.android.com/reference/androidx/paging/RemoteMediator.InitializeAction` | Return type of `https://developer.android.com/reference/androidx/paging/RemoteMediator#initialize()`, which signals the action to take after `https://developer.android.com/reference/androidx/paging/RemoteMediator#initialize()` completes. |
| `https://developer.android.com/reference/androidx/paging/TerminalSeparatorType` | Mode for configuring when terminal separators (header and footer) would be displayed by the `https://developer.android.com/reference/androidx/paging/package-summary#(androidx.paging.PagingData).insertSeparators(androidx.paging.TerminalSeparatorType,kotlin.coroutines.SuspendFunction2)`, `https://developer.android.com/reference/androidx/paging/package-summary#(androidx.paging.PagingData).insertHeaderItem(androidx.paging.TerminalSeparatorType,kotlin.Any)` or `https://developer.android.com/reference/androidx/paging/package-summary#(androidx.paging.PagingData).insertFooterItem(androidx.paging.TerminalSeparatorType,kotlin.Any)` operators on `https://developer.android.com/reference/androidx/paging/PagingData`. |