# RxPagedListBuilder

Artifact: [androidx.paging:paging-rxjava3](https://developer.android.com/jetpack/androidx/releases/paging) [View Source](https://cs.android.com/search?q=file:androidx/paging/rxjava3/RxPagedListBuilder.kt+class:androidx.paging.rxjava3.RxPagedListBuilder) Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

*** ** * ** ***


```
public final class RxPagedListBuilder<Key extends Object, Value extends Object>
```

<br />

*** ** * ** ***

> [!CAUTION]
> **This class is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

Builder for `Observable<PagedList>` or `Flowable<PagedList>`, given a `https://developer.android.com/reference/androidx/paging/DataSource.Factory` and a `https://developer.android.com/reference/androidx/paging/PagedList.Config`.

The required parameters are in the constructor, so you can simply construct and build, or optionally enable extra features (such as initial load key, or BoundaryCallback).

The returned observable/flowable will already be subscribed on the `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setFetchScheduler(io.reactivex.rxjava3.core.Scheduler)`, and will perform all loading on that scheduler. It will already be observed on `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setNotifyScheduler(io.reactivex.rxjava3.core.Scheduler)`, and will dispatch new PagedLists, as well as their updates to that scheduler.

| Parameters |
|---|---|
| `<Key extends https://developer.android.com/reference/java/lang/Object.html>` | Type of input valued used to load data from the `https://developer.android.com/reference/androidx/paging/DataSource`. Must be integer if you're using `https://developer.android.com/reference/androidx/paging/PositionalDataSource`. |
| `<Value extends https://developer.android.com/reference/java/lang/Object.html>` | Item type being presented. |

## Summary

| ### Public constructors |
|---|
| `<Key extends https://developer.android.com/reference/java/lang/Object.html, Value extends https://developer.android.com/reference/java/lang/Object.html> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(androidx.paging.DataSource.Factory,androidx.paging.PagedList.Config))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/DataSource.Factory<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value> dataSourceFactory, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList.Config config )` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `<Key extends https://developer.android.com/reference/java/lang/Object.html, Value extends https://developer.android.com/reference/java/lang/Object.html> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(androidx.paging.DataSource.Factory,kotlin.Int))( @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/DataSource.Factory<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value> dataSourceFactory, int pageSize )` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `<Key extends https://developer.android.com/reference/java/lang/Object.html, Value extends https://developer.android.com/reference/java/lang/Object.html> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(kotlin.Function0,androidx.paging.PagedList.Config))( @https://developer.android.com/reference/androidx/annotation/NonNull Function0<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagingSource<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>> pagingSourceFactory, @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList.Config config )` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `<Key extends https://developer.android.com/reference/java/lang/Object.html, Value extends https://developer.android.com/reference/java/lang/Object.html> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(kotlin.Function0,kotlin.Int))( @https://developer.android.com/reference/androidx/annotation/NonNull Function0<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagingSource<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>> pagingSourceFactory, int pageSize )` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |

| ### Public methods |
|---|---|
| `final @https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList<@https://developer.android.com/reference/androidx/annotation/NonNull Value>>` | `[buildFlowable](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#buildFlowable(io.reactivex.rxjava3.core.BackpressureStrategy))(@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/BackpressureStrategy.html backpressureStrategy)` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList<@https://developer.android.com/reference/androidx/annotation/NonNull Value>>` | `[buildObservable](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#buildObservable())()` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | `[setBoundaryCallback](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback))( https://developer.android.com/reference/androidx/paging/PagedList.BoundaryCallback<@https://developer.android.com/reference/androidx/annotation/NonNull Value> boundaryCallback )` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | `[setFetchScheduler](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setFetchScheduler(io.reactivex.rxjava3.core.Scheduler))(@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Scheduler.html scheduler)` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | `[setInitialLoadKey](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setInitialLoadKey(kotlin.Any))(Key key)` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |
| `final @https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | `[setNotifyScheduler](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setNotifyScheduler(io.reactivex.rxjava3.core.Scheduler))(@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Scheduler.html scheduler)` **This method is deprecated.** PagedList is deprecated and has been replaced by PagingData |

## Public constructors

### RxPagedListBuilder

```
public <Key extends Object, Value extends Object> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(androidx.paging.DataSource.Factory,androidx.paging.PagedList.Config))(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> dataSourceFactory,
    @NonNull PagedList.Config config
)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData, use this instead:
>
> ```java
> Pager(
>                 config = PagingConfig(
>                     config.pageSize,
>                     config.prefetchDistance,
>                     config.enablePlaceholders,
>                     config.initialLoadSizeHint,
>                     config.maxSize
>                 ),
>                 initialKey = null,
>                 pagingSourceFactory = dataSourceFactory.asPagingSourceFactory(Dispatchers.IO)
>             ).flowable
> ```

Creates a `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder` with required parameters.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/DataSource.Factory<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value> dataSourceFactory` | DataSource factory providing DataSource generations. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList.Config config` | Paging configuration. |

### RxPagedListBuilder

```
public <Key extends Object, Value extends Object> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(androidx.paging.DataSource.Factory,kotlin.Int))(
    @NonNull DataSource.Factory<@NonNull Key, @NonNull Value> dataSourceFactory,
    int pageSize
)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData, use this instead:
>
> ```java
> Pager(
>                 config = PagingConfig(pageSize),
>                 initialKey = null,
>                 pagingSourceFactory = dataSourceFactory.asPagingSourceFactory(Dispatchers.IO)
>             ).flowable
> ```

Creates a `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder` with required parameters.

This method is a convenience for:

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/DataSource.Factory<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value> dataSourceFactory` | `https://developer.android.com/reference/androidx/paging/DataSource.Factory` providing DataSource generations. |
| `int pageSize` | Size of pages to load. |

### RxPagedListBuilder

```
public <Key extends Object, Value extends Object> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(kotlin.Function0,androidx.paging.PagedList.Config))(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> pagingSourceFactory,
    @NonNull PagedList.Config config
)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData, use this instead:
>
> ```java
> Pager(
>                 config = PagingConfig(
>                     config.pageSize,
>                     config.prefetchDistance,
>                     config.enablePlaceholders,
>                     config.initialLoadSizeHint,
>                     config.maxSize
>                 ),
>                 initialKey = null,
>                 pagingSourceFactory = pagingSourceFactory
>             ).flowable
> ```

Creates a `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder` with required parameters.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function0<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagingSource<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>> pagingSourceFactory` | DataSource factory providing DataSource generations. |
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList.Config config` | Paging configuration. |

### RxPagedListBuilder

```
public <Key extends Object, Value extends Object> [RxPagedListBuilder](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#RxPagedListBuilder(kotlin.Function0,kotlin.Int))(
    @NonNull Function0<@NonNull PagingSource<@NonNull Key, @NonNull Value>> pagingSourceFactory,
    int pageSize
)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData, use this instead:
>
> ```java
> Pager(
>                 config = PagingConfig(pageSize),
>                 initialKey = null,
>                 pagingSourceFactory = pagingSourceFactory
>             ).flowable
> ```

Creates a `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder` with required parameters.

This method is a convenience for:

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

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull Function0<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagingSource<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>> pagingSourceFactory` | `https://developer.android.com/reference/androidx/paging/PagingSource` factory providing `https://developer.android.com/reference/androidx/paging/PagingSource` generations. |
| `int pageSize` | Size of pages to load. |

## Public methods

### buildFlowable

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull Flowable<@NonNull PagedList<@NonNull Value>> [buildFlowable](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#buildFlowable(io.reactivex.rxjava3.core.BackpressureStrategy))(@NonNull BackpressureStrategy backpressureStrategy)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

Constructs a `Flowable<PagedList>`.

The returned Observable will already be observed on the `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#notifyScheduler()`, and subscribed on the `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#fetchScheduler()`.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/BackpressureStrategy.html backpressureStrategy` | BackpressureStrategy for the `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html` to use. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList<@https://developer.android.com/reference/androidx/annotation/NonNull Value>>` | The `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html` of PagedLists |

### buildObservable

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull Observable<@NonNull PagedList<@NonNull Value>> [buildObservable](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#buildObservable())()
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

Constructs a `Observable<PagedList>`.

The returned Observable will already be observed on the `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#notifyScheduler()`, and subscribed on the `https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#fetchScheduler()`.

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html<@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/PagedList<@https://developer.android.com/reference/androidx/annotation/NonNull Value>>` | The `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html` of PagedLists |

### setBoundaryCallback

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull RxPagedListBuilder<@NonNull Key, @NonNull Value> [setBoundaryCallback](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback))(
    PagedList.BoundaryCallback<@NonNull Value> boundaryCallback
)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

Sets a `https://developer.android.com/reference/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.

| Parameters |
|---|---|
| `https://developer.android.com/reference/androidx/paging/PagedList.BoundaryCallback<@https://developer.android.com/reference/androidx/annotation/NonNull Value> boundaryCallback` | The boundary callback for listening to PagedList load state. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | this |

### setFetchScheduler

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull RxPagedListBuilder<@NonNull Key, @NonNull Value> [setFetchScheduler](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setFetchScheduler(io.reactivex.rxjava3.core.Scheduler))(@NonNull Scheduler scheduler)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

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 `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html` / `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html` will be subscribed on this scheduler.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Scheduler.html scheduler` | `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Scheduler.html` used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | this |

### setInitialLoadKey

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull RxPagedListBuilder<@NonNull Key, @NonNull Value> [setInitialLoadKey](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setInitialLoadKey(kotlin.Any))(Key key)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

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.

| Parameters |
|---|---|
| `Key key` | Initial load key passed to the first PagedList/DataSource. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | this |

### setNotifyScheduler

Added in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0) Deprecated in [3.1.0](https://developer.android.com/jetpack/androidx/releases/paging#3.1.0)

```
public final @NonNull RxPagedListBuilder<@NonNull Key, @NonNull Value> [setNotifyScheduler](https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder#setNotifyScheduler(io.reactivex.rxjava3.core.Scheduler))(@NonNull Scheduler scheduler)
```

> [!CAUTION]
> **This method is deprecated.**   
> PagedList is deprecated and has been replaced by PagingData

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 `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Observable.html` / `http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Flowable.html` will be observed on this scheduler, so that the thread receiving PagedLists will also receive the internal updates to the PagedList.

| Parameters |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull http://reactivex.io/RxJava/3.x/javadoc/io/reactivex/rxjava3/core/Scheduler.html scheduler` | Scheduler that receives PagedList updates, and where `https://developer.android.com/reference/androidx/paging/PagedList.Callback` calls are dispatched. Generally, this is the UI/main thread. |

| Returns |
|---|---|
| `@https://developer.android.com/reference/androidx/annotation/NonNull https://developer.android.com/reference/androidx/paging/rxjava3/RxPagedListBuilder<@https://developer.android.com/reference/androidx/annotation/NonNull Key, @https://developer.android.com/reference/androidx/annotation/NonNull Value>` | this |