PagedList.Builder

<Key : Any, Value : Any> Builder(
    dataSource: DataSource<Key, Value>,
    config: PagedList.Config
)

Create a Builder with the provided DataSource and Config.

<Key : Any, Value : Any> Builder(
    dataSource: DataSource<Key, Value>,
    pageSize: Int
)

Create a PagedList.Builder with the provided DataSource and pageSize.

This method is a convenience for:

PagedList.Builder(dataSource,
    new PagedList.Config.Builder().setPageSize(pageSize).build());

<Key : Any, Value : Any> Builder(
    pagingSource: PagingSource<Key, Value>,
    initialPage: PagingSource.LoadResult.Page<Key, Value>,
    config: PagedList.Config
)

Create a PagedList.Builder with the provided PagingSource, initial PagingSource.LoadResult.Page, and PagedList.Config.

<Key : Any, Value : Any> Builder(
    pagingSource: PagingSource<Key, Value>,
    initialPage: PagingSource.LoadResult.Page<Key, Value>,
    pageSize: Int
)

Create a PagedList.Builder with the provided PagingSource, initial PagingSource.LoadResult.Page, and pageSize.

This method is a convenience for:

PagedList.Builder(
    pagingSource,
    page,
    PagedList.Config.Builder().setPageSize(pageSize).build()
)

fun build(): PagedList<Value>

Creates a PagedList with the given parameters.

This call will dispatch the androidx.paging.PagingSource's loadInitial method immediately on the current thread, and block the current on the result. This method should always be called on a worker thread to prevent blocking the main thread.

It's fine to create a PagedList with an async PagingSource on the main thread, such as in the constructor of a ViewModel. An async network load won't block the initial call to the Load function. For a synchronous PagingSource such as one created from a Room database, a LiveData<PagedList> can be safely constructed with androidx.paging.LivePagedListBuilder on the main thread, since actual construction work is deferred, and done on a background thread.

While build will always return a PagedList, it's important to note that the PagedList initial load may fail to acquire data from the PagingSource. This can happen for example if the PagingSource is invalidated during its initial load. If this happens, the PagedList will be immediately detached, and you can retry construction (including setting a new PagingSource).

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

The BoundaryCallback for out of data events.

Pass a BoundaryCallback to listen to when the PagedList runs out of data to load.

fun setCoroutineScope(coroutineScope: CoroutineScope): PagedList.Builder<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 setFetchDispatcher(fetchDispatcher: CoroutineDispatcher): PagedList.Builder<Key, Value>

The CoroutineDispatcher used to fetch additional pages from the PagingSource.

Does not affect initial load, which will be done immediately on whichever thread the PagedList is created on.

fun setFetchExecutor(fetchExecutor: Executor): PagedList.Builder<Key, Value>

The Executor used to fetch additional pages from the PagingSource.

Does not affect initial load, which will be done immediately on whichever thread the PagedList is created on.

fun setInitialKey(initialKey: Key?): PagedList.Builder<Key, Value>

Sets the initial key the PagingSource should load around as part of initialization.

fun setNotifyDispatcher(notifyDispatcher: CoroutineDispatcher): PagedList.Builder<Key, Value>

The CoroutineDispatcher defining where page loading updates are dispatched.

fun setNotifyExecutor(notifyExecutor: Executor): PagedList.Builder<Key, Value>

The Executor defining where page loading updates are dispatched.