Register now for Android Dev Summit 2019!

LoadInitialCallback

abstract class LoadInitialCallback<Key : Any!, Value : Any!>
kotlin.Any
   ↳ androidx.paging.PageKeyedDataSource.LoadInitialCallback

Callback for loadInitial(LoadInitialParams, LoadInitialCallback) to return data and, optionally, position/count information.

A callback can be called only once, and will throw if called again.

If you can compute the number of items in the data set before and after the loaded range, call the five parameter onResult(List, int, int, Object, Object) to pass that information. You can skip passing this information by calling the three parameter onResult(List, Object, Object), either if it's difficult to compute, or if LoadInitialParams#placeholdersEnabled is false, so the positioning information will be ignored.

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

Callback for loadInitial(LoadInitialParams, LoadInitialCallback) to return data and, optionally, position/count information.

Public methods

abstract Unit
onResult(@NonNull data: MutableList<Value>, position: Int, totalCount: Int, @Nullable previousPageKey: Key?, @Nullable nextPageKey: Key?)

Called to pass initial load state from a DataSource.

abstract Unit
onResult(@NonNull data: MutableList<Value>, @Nullable previousPageKey: Key?, @Nullable nextPageKey: Key?)

Called to pass loaded data from a DataSource.

Public constructors

<init>

LoadInitialCallback()

Callback for loadInitial(LoadInitialParams, LoadInitialCallback) to return data and, optionally, position/count information.

A callback can be called only once, and will throw if called again.

If you can compute the number of items in the data set before and after the loaded range, call the five parameter onResult(List, int, int, Object, Object) to pass that information. You can skip passing this information by calling the three parameter onResult(List, Object, Object), either if it's difficult to compute, or if LoadInitialParams#placeholdersEnabled is false, so the positioning information will be ignored.

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>, position: Int, totalCount: Int, @Nullable previousPageKey: Key?, @Nullable nextPageKey: Key?): Unit

Called to pass initial load state from a DataSource.

Call this method from your DataSource's loadInitial function to return data, and inform how many placeholders should be shown before and after. If counting is cheap to compute (for example, if a network load returns the information regardless), it's recommended to pass data back through this method.

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 DataSource. If this is empty, the DataSource is treated as empty, and no further loads will occur.
position MutableList<Value>: Position of the item at the front of the list. If there are N items before the items in data that can be loaded from this DataSource, pass N.
totalCount MutableList<Value>: Total number of items that may be returned from this DataSource. Includes the number in the initial data parameter as well as any items that can be loaded in front or behind of data.

onResult

abstract fun onResult(@NonNull data: MutableList<Value>, @Nullable previousPageKey: Key?, @Nullable nextPageKey: Key?): Unit

Called to pass loaded data from a DataSource.

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 PageKeyedDataSource.
previousPageKey MutableList<Value>: Key for page before the initial load result, or null if no more data can be loaded before.
nextPageKey MutableList<Value>: Key for page after the initial load result, or null if no more data can be loaded after.