RxPagedListBuilder

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

Creates a RxPagedListBuilder with required parameters.

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

Creates a RxPagedListBuilder with required parameters.

This method is a convenience for:

RxPagedListBuilder(
    dataSourceFactory,
    PagedList.Config.Builder().setPageSize(pageSize).build()
)

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

Creates a RxPagedListBuilder with required parameters.

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

Creates a RxPagedListBuilder with required parameters.

This method is a convenience for:

RxPagedListBuilder(
    pagingSourceFactory,
    PagedList.Config.Builder().setPageSize(pageSize).build()
)

fun buildFlowable(backpressureStrategy: BackpressureStrategy): Flowable<PagedList<Value>>

Constructs a Flowable<PagedList>.

The returned Observable will already be observed on the notifyScheduler, and subscribed on the fetchScheduler.

fun buildObservable(): Observable<PagedList<Value>>

Constructs a Observable<PagedList>.

The returned Observable will already be observed on the notifyScheduler, and subscribed on the fetchScheduler.

fun setBoundaryCallback(
    boundaryCallback: PagedList.BoundaryCallback<Value>?
): RxPagedListBuilder<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 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 DataSource 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 Observable<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 setFetchScheduler(scheduler: Scheduler): RxPagedListBuilder<Key, Value>

Sets scheduler which will be used for background fetching of PagedLists, as well as on-demand fetching of pages inside.

If not set, defaults to the Arch components I/O thread pool.

The built Observable / Flowable will be subscribed on this scheduler.

fun setInitialLoadKey(key: Key?): RxPagedListBuilder<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.

fun setNotifyScheduler(scheduler: Scheduler): RxPagedListBuilder<Key, Value>

Sets scheduler which will be used for observing new PagedLists, as well as loading updates within the PagedLists.

If not set, defaults to the UI thread.

The built Observable / Flowable will be observed on this scheduler, so that the thread receiving PagedLists will also receive the internal updates to the PagedList.