PagingDataPresenter

<T : Any> PagingDataPresenter(
    mainContext: CoroutineContext = Dispatchers.Main,
    cachedPagingData: PagingData<T>? = null
)

fun addLoadStateListener(listener: (CombinedLoadStates) -> Unit): Unit

Add a CombinedLoadStates listener to observe the loading state of the current PagingData.

As new PagingData generations are submitted and displayed, the listener will be notified to reflect the current CombinedLoadStates.

When a new listener is added, it will be immediately called with the current CombinedLoadStates, unless this PagingDataPresenter has not been hooked up to a PagingData yet, and thus has no state to emit.

import androidx.paging.LoadState

val adapter = UserPagingAdapter()
adapter.addLoadStateListener {
    // show a retry button outside the list when refresh hits an error
    retryButton.isVisible = it.refresh is LoadState.Error

    // swipeRefreshLayout displays whether refresh is occurring
    swipeRefreshLayout.isRefreshing = it.refresh is LoadState.Loading

    // show an empty state over the list when loading initially, before items are loaded
    emptyState.isVisible = it.refresh is LoadState.Loading && adapter.itemCount == 0
}

fun addOnPagesUpdatedListener(listener: () -> Unit): Unit

Add a listener which triggers after the pages presented to the UI are updated, even if the actual items presented don't change.

An update is triggered from one of the following:

• collectFrom is called and initial load completes, regardless of any differences in the loaded data

• A Page is inserted

• A Page is dropped

suspend fun collectFrom(pagingData: PagingData<T>): Unit

@MainThread
operator fun get(index: @IntRange(from = 0) Int): T?

Returns the presented item at the specified position, notifying Paging of the item access to trigger any loads necessary to fulfill prefetchDistance.

@MainThread
fun peek(index: @IntRange(from = 0) Int): T?

Returns the presented item at the specified position, without notifying Paging of the item access that would normally trigger page loads.

abstract suspend fun presentPagingDataEvent(event: PagingDataEvent<T>): Unit

Handler for PagingDataEvent emitted by PagingData.

When a PagingData is submitted to this PagingDataPresenter through collectFrom, page loads, drops, or LoadStateUpdates will be emitted to presenters as PagingDataEvent through this method.

Presenter layers that communicate directly with PagingDataPresenter should override this method to handle the PagingDataEvent accordingly. For example by diffing two PagingDataEvent.Refresh lists, or appending the inserted list of data from PagingDataEvent.Prepend or PagingDataEvent.Append.

fun refresh(): Unit

Refresh the data presented by this PagingDataPresenter.

refresh triggers the creation of a new PagingData with a new instance of PagingSource to represent an updated snapshot of the backing dataset. If a RemoteMediator is set, calling refresh will also trigger a call to RemoteMediator.load with LoadType to allow RemoteMediator to check for updates to the dataset backing PagingSource.

Note: This API is intended for UI-driven refresh signals, such as swipe-to-refresh. Invalidation due repository-layer signals, such as DB-updates, should instead use PagingSource.invalidate.

import androidx.appcompat.app.AppCompatActivity
import androidx.paging.LoadState

class MyActivity : AppCompatActivity() {
    private lateinit var binding: MyActivityBinding
    private val pagingAdapter = UserPagingAdapter()

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        binding = MyActivityBinding.inflate(layoutInflater)
        setContentView(binding.root)

        binding.recyclerView.adapter = pagingAdapter
        pagingAdapter.addLoadStateListener { loadStates ->
            binding.swipeRefreshLayout.isRefreshing = loadStates.refresh is LoadState.Loading
        }

        binding.swipeRefreshLayout.setOnRefreshListener {
            pagingAdapter.refresh()
        }
    }
}

fun removeLoadStateListener(listener: (CombinedLoadStates) -> Unit): Unit

Remove a previously registered CombinedLoadStates listener.

fun removeOnPagesUpdatedListener(listener: () -> Unit): Unit

Remove a previously registered listener for updates to presented pages.

fun retry(): Unit

Retry any failed load requests that would result in a LoadState.Error update to this PagingDataPresenter.

Unlike refresh, this does not invalidate PagingSource, it only retries failed loads within the same generation of PagingData.

LoadState.Error can be generated from two types of load requests:

• PagingSource.load returning PagingSource.LoadResult.Error

• RemoteMediator.load returning RemoteMediator.MediatorResult.Error

fun snapshot(): ItemSnapshotList<T>

Returns a new ItemSnapshotList representing the currently presented items, including any placeholders if they are enabled.

val loadStateFlow: StateFlow<CombinedLoadStates?>

A hot Flow of CombinedLoadStates that emits a snapshot whenever the loading state of the current PagingData changes.

This flow is conflated. It buffers the last update to CombinedLoadStates and immediately delivers the current load states on collection, unless this PagingDataPresenter has not been hooked up to a PagingData yet, and thus has no state to emit.

import androidx.lifecycle.lifecycleScope
import androidx.paging.LoadState

val adapter = UserPagingAdapter()
lifecycleScope.launch {
    adapter.loadStateFlow
        .map { it.refresh }
        .distinctUntilChanged()
        .collectLatest {
            // show a retry button outside the list when refresh hits an error
            retryButton.isVisible = it is LoadState.Error

            // swipeRefreshLayout displays whether refresh is occurring
            swipeRefreshLayout.isRefreshing = it is LoadState.Loading

            // show an empty state over the list when loading initially, before items are loaded
            emptyState.isVisible = it is LoadState.Loading && adapter.itemCount == 0
        }
}

val onPagesUpdatedFlow: Flow<Unit>

A hot Flow that emits after the pages presented to the UI are updated, even if the actual items presented don't change.

An update is triggered from one of the following:

• collectFrom is called and initial load completes, regardless of any differences in the loaded data

• A Page is inserted

• A Page is dropped

Note: This is a SharedFlow configured to replay 0 items with a buffer of size 64. If a collector lags behind page updates, it may trigger multiple times for each intermediate update that was presented while your collector was still working. To avoid this behavior, you can conflate this Flow so that you only receive the latest update, which is useful in cases where you are simply updating UI and don't care about tracking the exact number of page updates.

val size: Int