LoadCallback
abstract class LoadCallback<Value : Any!>
| kotlin.Any | |
| ↳ | androidx.paging.ItemKeyedDataSource.LoadCallback |
Callback for ItemKeyedDataSource loadBefore(LoadParams, LoadCallback) and loadAfter(LoadParams, LoadCallback) to return data.
A callback can be called only once, and will throw if called again.
It is always valid for a DataSource loading method that takes a callback to stash the callback and call it later. This enables DataSources to be fully asynchronous, and to handle temporary, recoverable error states (such as a network error that can be retried).
Summary
Public constructors |
|
|---|---|
<init>()Callback for ItemKeyedDataSource |
|
Public methods |
|
|---|---|
| abstract Unit |
onResult(@NonNull data: MutableList<Value>)Called to pass loaded data from a DataSource. |
Public constructors
<init>
LoadCallback()
Callback for ItemKeyedDataSource loadBefore(LoadParams, LoadCallback) and loadAfter(LoadParams, LoadCallback) to return data.
A callback can be called only once, and will throw if called again.
It is always valid for a DataSource loading method that takes a callback to stash the callback and call it later. This enables DataSources to be fully asynchronous, and to handle temporary, recoverable error states (such as a network error that can be retried).
Public methods
onResult
abstract fun onResult(@NonNull data: MutableList<Value>): Unit
Called to pass loaded data from a DataSource.
Call this method from your ItemKeyedDataSource's loadBefore(LoadParams, LoadCallback) and loadAfter(LoadParams, LoadCallback) methods to return data.
Call this from loadInitial(LoadInitialParams, LoadInitialCallback) to initialize without counting available data, or supporting placeholders.
It is always valid to pass a different amount of data than what is requested. Pass an empty list if there is no more data to load.
| Parameters | |
|---|---|
data |
MutableList<Value>: List of items loaded from the ItemKeyedDataSource. |