PagingDataAdapter

Kotlin |Java

class PagingDataAdapter<T : Any> : ObjectAdapter

kotlin.Any
↳	androidx.leanback.widget.ObjectAdapter
	↳	androidx.leanback.paging.PagingDataAdapter

An ObjectAdapter implemented with an AsyncPagingDataDiffer. It is an analogue of androidx.paging.PagingDataAdapter for leanback widgets.

Summary

Public constructors
`<init>(diffCallback: DiffUtil.ItemCallback<T>, mainDispatcher: CoroutineDispatcher = Dispatchers.Main, workerDispatcher: CoroutineDispatcher = Dispatchers.Default)` Constructs an adapter
`<init>(presenter: Presenter, diffCallback: DiffUtil.ItemCallback<T>, mainDispatcher: CoroutineDispatcher = Dispatchers.Main, workerDispatcher: CoroutineDispatcher = Dispatchers.Default)` Constructs an adapter
`<init>(presenterSelector: PresenterSelector, diffCallback: DiffUtil.ItemCallback<T>, mainDispatcher: CoroutineDispatcher = Dispatchers.Main, workerDispatcher: CoroutineDispatcher = Dispatchers.Default)` Constructs an adapter

Public methods
Unit	`addLoadStateListener(listener: (CombinedLoadStates) -> Unit)` Add a CombinedLoadStates listener to observe the loading state of the current PagingData.
T?	`get(position: Int)` Returns the item for the given position.
Unit	`refresh()` Refresh the data presented by this PagingDataAdapter.
Unit	`removeLoadStateListener(listener: (CombinedLoadStates) -> Unit)` Remove a previously registered CombinedLoadStates listener.
Unit	`retry()` Retry any failed load requests that would result in a LoadState.Error update to this
Int	`size()`
suspend Unit	`submitData(pagingData: PagingData<T>)` Present a PagingData until it is invalidated by a call to refresh or PagingSource.invalidate.
Unit	`submitData(lifecycle: Lifecycle, pagingData: PagingData<T>)` Present a PagingData until it is either invalidated or another call to submitData is made.

Inherited functions

From class ObjectAdapter

`Long`	`getId(position: Int)` Returns the id for the given position.
`Presenter!`	`getPresenter(item: Any!)` Returns the `Presenter` for the given item from the adapter.
`PresenterSelector!`	`getPresenterSelector()` Returns the presenter selector for this ObjectAdapter.
`Boolean`	`hasStableIds()` Returns true if the item ids are stable across changes to the underlying data. When this is true, clients of the ObjectAdapter can use `getId(int)` to correlate Objects across changes.
`Boolean`	`isImmediateNotifySupported()` Returns true if the adapter pairs each underlying data change with a call to notify and false otherwise.
`Unit`	`notifyChanged()` Notifies UI that the underlying data has changed.
`Unit`	`notifyItemMoved(fromPosition: Int, toPosition: Int)` Notifies UI that item at fromPosition has been moved to toPosition.
`Unit`	`notifyItemRangeChanged(positionStart: Int, itemCount: Int)` Notifies UI that some items has changed.
`Unit`	`notifyItemRangeChanged(positionStart: Int, itemCount: Int, payload: Any!)` Notifies UI that some items has changed.
`Unit`	`notifyItemRangeInserted(positionStart: Int, itemCount: Int)` Notifies UI that new items has been inserted.
`Unit`	`notifyItemRangeRemoved(positionStart: Int, itemCount: Int)` Notifies UI that some items that has been removed.
`Unit`	`onHasStableIdsChanged()` Called when `setHasStableIds(boolean)` is called and the status of stable ids has changed.
`Unit`	`onPresenterSelectorChanged()` Called when `setPresenterSelector(PresenterSelector)` is called and the PresenterSelector differs from the previous one.
`Unit`	`registerObserver(observer: ObjectAdapter.DataObserver!)` Registers a DataObserver for data change notifications.
`Unit`	`setHasStableIds(hasStableIds: Boolean)` Sets whether the item ids are stable across changes to the underlying data.
`Unit`	`setPresenterSelector(presenterSelector: PresenterSelector!)` Sets the presenter selector. May not be null.
`Unit`	`unregisterAllObservers()` Unregisters all DataObservers for this ObjectAdapter.
`Unit`	`unregisterObserver(observer: ObjectAdapter.DataObserver!)` Unregisters a DataObserver for data change notifications.

Properties
Flow<CombinedLoadStates>	`loadStateFlow` A hot Flow of CombinedLoadStates that emits a snapshot whenever the loading state of the current PagingData changes.

Public constructors

<init>

PagingDataAdapter(
    diffCallback: DiffUtil.ItemCallback<T>, 
    mainDispatcher: CoroutineDispatcher = Dispatchers.Main, 
    workerDispatcher: CoroutineDispatcher = Dispatchers.Default)

Constructs an adapter

Parameters
diffCallback: DiffUtil.ItemCallback<T>	The DiffUtil.ItemCallback instance to compare items in the list.