PageKeyedDataSource.LoadCallback
public
static
abstract
class
PageKeyedDataSource.LoadCallback
extends Object
java.lang.Object | |
↳ | android.arch.paging.PageKeyedDataSource.LoadCallback<Key, Value> |
Callback for PageKeyedDataSource 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 | |
---|---|
PageKeyedDataSource.LoadCallback()
|
Public methods | |
---|---|
abstract
void
|
onResult(List<Value> data, Key adjacentPageKey)
Called to pass loaded data from a DataSource. |
Inherited methods | |
---|---|
Public constructors
PageKeyedDataSource.LoadCallback
PageKeyedDataSource.LoadCallback ()
Public methods
onResult
void onResult (List<Value> data, Key adjacentPageKey)
Called to pass loaded data from a DataSource.
Call this method from your PageKeyedDataSource's
loadBefore(LoadParams, LoadCallback)
and
loadAfter(LoadParams, LoadCallback)
methods to return data.
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.
Pass the key for the subsequent page to load to adjacentPageKey. For example, if you've
loaded a page in loadBefore(LoadParams, LoadCallback)
, pass the key for the
previous page, or null
if the loaded page is the first. If in
loadAfter(LoadParams, LoadCallback)
, pass the key for the next page, or
null
if the loaded page is the last.
Parameters | |
---|---|
data |
List : List of items loaded from the PageKeyedDataSource. |
adjacentPageKey |
Key : Key for subsequent page load (previous page in loadBefore(PageKeyedDataSource.LoadParams
/ next page in loadAfter(PageKeyedDataSource.LoadParams ), or null if there are
no more pages to load in the current load direction.
|
Interfaces
Classes
- AsyncPagedListDiffer
- DataSource
- DataSource.Factory
- ItemKeyedDataSource
- ItemKeyedDataSource.LoadCallback
- ItemKeyedDataSource.LoadInitialCallback
- ItemKeyedDataSource.LoadInitialParams
- ItemKeyedDataSource.LoadParams
- LivePagedListBuilder
- PagedList
- PagedList.BoundaryCallback
- PagedList.Builder
- PagedList.Callback
- PagedList.Config
- PagedList.Config.Builder
- PagedListAdapter
- PageKeyedDataSource
- PageKeyedDataSource.LoadCallback
- PageKeyedDataSource.LoadInitialCallback
- PageKeyedDataSource.LoadInitialParams
- PageKeyedDataSource.LoadParams
- PositionalDataSource
- PositionalDataSource.LoadInitialCallback
- PositionalDataSource.LoadInitialParams
- PositionalDataSource.LoadRangeCallback
- PositionalDataSource.LoadRangeParams
- RxPagedListBuilder