LivePagedListBuilder

<Key : Any, Value : Any> LivePagedListBuilder(
    dataSourceFactory: DataSource.Factory<Key, Value>,
    config: PagedList.Config
)

Creates a LivePagedListBuilder with required parameters.

<Key : Any, Value : Any> LivePagedListBuilder(
    dataSourceFactory: DataSource.Factory<Key, Value>,
    pageSize: Int
)

Creates a LivePagedListBuilder with required parameters.

This method is a convenience for:

LivePagedListBuilder(dataSourceFactory,
        new PagedList.Config.Builder().setPageSize(pageSize).build())

<Key : Any, Value : Any> LivePagedListBuilder(
    pagingSourceFactory: () -> PagingSource<Key, Value>,
    config: PagedList.Config
)

Creates a LivePagedListBuilder with required parameters.

<Key : Any, Value : Any> LivePagedListBuilder(
    pagingSourceFactory: () -> PagingSource<Key, Value>,
    pageSize: Int
)

Creates a LivePagedListBuilder with required parameters.

This method is a convenience for:

LivePagedListBuilder(pagingSourceFactory,
        new PagedList.Config.Builder().setPageSize(pageSize).build())

fun build(): LiveData<PagedList<Value>>

Constructs the LiveData<PagedList>.

No work (such as loading) is done immediately, the creation of the first PagedList is deferred until the LiveData is observed.

fun setBoundaryCallback(
    boundaryCallback: PagedList.BoundaryCallback<Value>?
): LivePagedListBuilder<Key, Value>

Sets a androidx.paging.PagedList.BoundaryCallback on each PagedList created, typically used to load additional data from network when paging from local storage.

Pass a PagedList.BoundaryCallback to listen to when the PagedList runs out of data to load. If this method is not called, or null is passed, you will not be notified when each PagingSource runs out of data to provide to its PagedList.

If you are paging from a DataSource.Factory backed by local storage, you can set a BoundaryCallback to know when there is no more information to page from local storage. This is useful to page from the network when local storage is a cache of network data.

Note that when using a BoundaryCallback with a LiveData<PagedList>, method calls on the callback may be dispatched multiple times - one for each PagedList/DataSource pair. If loading network data from a BoundaryCallback, you should prevent multiple dispatches of the same method from triggering multiple simultaneous network loads.

fun setCoroutineScope(coroutineScope: CoroutineScope): LivePagedListBuilder<Key, Value>

Set the CoroutineScope that page loads should be launched within. The set coroutineScope allows a PagingSource to cancel running load operations when the results are no longer needed - for example, when the containing activity is destroyed.

Defaults to GlobalScope.

fun setFetchExecutor(fetchExecutor: Executor): LivePagedListBuilder<Key, Value>

Sets Executor used for background fetching of PagedLists, and the pages within.

The library will wrap this as a kotlinx.coroutines.CoroutineDispatcher.

If not set, defaults to a ExecutorCoroutineDispatcher backed by ArchTaskExecutor.getIOThreadExecutor.

fun setInitialLoadKey(key: Key?): LivePagedListBuilder<Key, Value>

First loading key passed to the first PagedList/DataSource.

When a new PagedList/DataSource pair is created after the first, it acquires a load key from the previous generation so that data is loaded around the position already being observed.