LoadCallback

Kotlin |Java

abstract class LoadCallback<Value>

kotlin.Any
↳	androidx.paging.ItemKeyedDataSource.LoadCallback

Known Direct Subclasses ItemKeyedDataSource.LoadInitialCallback ItemKeyedDataSource.LoadInitialCallback Callback for loadInitial to return data and, optionally, position/count information.

Callback for ItemKeyedDataSource loadBefore and loadAfter 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 loadBefore and loadAfter to return data.

Public methods
abstract Unit	onResult(data: List<Value>) Called to pass loaded data from a DataSource.

Public constructors

<init>

LoadCallback()

Callback for ItemKeyedDataSource loadBefore and loadAfter 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).

Parameters
Value	Type of items being loaded.

Public methods

onResult

abstract fun onResult(data: List<Value>): Unit

Called to pass loaded data from a DataSource.

Call this method from your ItemKeyedDataSource's loadBefore and loadAfter methods to return data.

Call this from loadInitial 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: List<Value>	List of items loaded from the ItemKeyedDataSource.