blob: 6e055a48f4748a16a3bb92fe329f29343e5838e5 [file] [log] [blame]
<html devsite="true">
<head>
<title>RxPagedListBuilder</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>RxPagedListBuilder</h1>
{% setvar page_path %}androidx/paging/RxPagedListBuilder.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_java_switcher2.md" %}
<p>
<pre>public final class RxPagedListBuilder&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</pre>
</p>
<hr>
<aside class="caution"><strong>This class is deprecated.</strong><br>PagedList is deprecated and has been replaced by PagingData</aside>
<p>Builder for <code>Observable&lt;PagedList&gt;</code> or <code>Flowable&lt;PagedList&gt;</code>, given a <code><a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a></code> and a <code><a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a></code>.</p>
<p>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).</p>
<p>The returned observable/flowable will already be subscribed on the <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setFetchScheduler(Scheduler)">setFetchScheduler</a></code>, and will perform all loading on that scheduler. It will already be observed on <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setNotifyScheduler(Scheduler)">setNotifyScheduler</a></code>, and will dispatch new PagedLists, as well as their updates to that scheduler.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</code></td>
<td width="100%">
<p>Type of input valued used to load data from the <code><a href="/reference/androidx/paging/DataSource.html">DataSource</a></code>. Must be integer if you're using <code><a href="/reference/androidx/paging/PositionalDataSource.html">PositionalDataSource</a></code>.</p>
</td>
</tr>
<tr>
<td><code>&lt;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</code></td>
<td width="100%">
<p>Item type being presented.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public constructors</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td>
<div><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(kotlin.Function0,androidx.paging.PagedList.Config)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config<br>)</code></div>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
</td>
</tr>
<tr>
<td>
<div><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(kotlin.Function0,kotlin.Int)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;pageSize<br>)</code></div>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
</td>
</tr>
<tr>
<td>
<div><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(androidx.paging.DataSource.Factory,androidx.paging.PagedList.Config)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config<br>)</code></div>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
</td>
</tr>
<tr>
<td>
<div><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(androidx.paging.DataSource.Factory,kotlin.Int)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;pageSize<br>)</code></div>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public methods</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>final <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#buildFlowable(BackpressureStrategy)">buildFlowable</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;backpressureStrategy)</code></div>
<p>Constructs a <code>Flowable&lt;PagedList&gt;</code>.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#buildObservable()">buildObservable</a>()</code></div>
<p>Constructs a <code>Observable&lt;PagedList&gt;</code>.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback)">setBoundaryCallback</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="/reference/androidx/paging/PagedList.BoundaryCallback.html">PagedList.BoundaryCallback</a>&lt;Value&gt;&nbsp;boundaryCallback<br>)</code></div>
<p>Sets a <code><a href="/reference/androidx/paging/PagedList.BoundaryCallback.html">androidx.paging.PagedList.BoundaryCallback</a></code> on each PagedList created, typically used to load additional data from network when paging from local storage.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setFetchScheduler(Scheduler)">setFetchScheduler</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler)</code></div>
<p>Sets scheduler which will be used for background fetching of PagedLists, as well as on-demand fetching of pages inside.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setInitialLoadKey(kotlin.Any)">setInitialLoadKey</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;Key&nbsp;key)</code></div>
<p>First loading key passed to the first PagedList/DataSource.</p>
</td>
</tr>
<tr>
<td><code>final <a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/androidx/paging/RxPagedListBuilder.html#setNotifyScheduler(Scheduler)">setNotifyScheduler</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler)</code></div>
<p>Sets scheduler which will be used for observing new PagedLists, as well as loading updates within the PagedLists.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public constructors</h2>
<div><a name="RxPagedListBuilder(kotlin.Function0, androidx.paging.PagedList.Config)"></a><a name="RxPagedListBuilder-kotlin.Function0-androidx.paging.PagedList.Config-"></a>
<h3 class="api-name" id="RxPagedListBuilder(kotlin.Function0,androidx.paging.PagedList.Config)">RxPagedListBuilder</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(kotlin.Function0,androidx.paging.PagedList.Config)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config<br>)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>PagedList is deprecated and has been replaced by PagingData</aside>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory</code></td>
<td width="100%">
<p>DataSource factory providing DataSource generations.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config</code></td>
<td width="100%">
<p>Paging configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="RxPagedListBuilder(kotlin.Function0, kotlin.Int)"></a><a name="RxPagedListBuilder-kotlin.Function0-kotlin.Int-"></a>
<h3 class="api-name" id="RxPagedListBuilder(kotlin.Function0,kotlin.Int)">RxPagedListBuilder</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(kotlin.Function0,kotlin.Int)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;pageSize<br>)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>PagedList is deprecated and has been replaced by PagingData</aside>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
<p>This method is a convenience for:</p>
<pre class="prettyprint">RxPagedListBuilder(<br> pagingSourceFactory,<br> PagedList.Config.Builder().setPageSize(pageSize).build()<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>Function0&lt;<a href="/reference/androidx/paging/PagingSource.html">PagingSource</a>&lt;Key,&nbsp;Value&gt;&gt;&nbsp;pagingSourceFactory</code></td>
<td width="100%">
<p><code><a href="/reference/androidx/paging/PagingSource.html">PagingSource</a></code> factory providing <code><a href="/reference/androidx/paging/PagingSource.html">PagingSource</a></code> generations.</p>
</td>
</tr>
<tr>
<td><code>int&nbsp;pageSize</code></td>
<td width="100%">
<p>Size of pages to load.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="RxPagedListBuilder(androidx.paging.DataSource.Factory, androidx.paging.PagedList.Config)"></a><a name="RxPagedListBuilder-androidx.paging.DataSource.Factory-androidx.paging.PagedList.Config-"></a>
<h3 class="api-name" id="RxPagedListBuilder(androidx.paging.DataSource.Factory,androidx.paging.PagedList.Config)">RxPagedListBuilder</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(androidx.paging.DataSource.Factory,androidx.paging.PagedList.Config)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config<br>)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>PagedList is deprecated and has been replaced by PagingData</aside>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory</code></td>
<td width="100%">
<p>DataSource factory providing DataSource generations.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/androidx/paging/PagedList.Config.html">PagedList.Config</a>&nbsp;config</code></td>
<td width="100%">
<p>Paging configuration.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="RxPagedListBuilder(androidx.paging.DataSource.Factory, kotlin.Int)"></a><a name="RxPagedListBuilder-androidx.paging.DataSource.Factory-kotlin.Int-"></a>
<h3 class="api-name" id="RxPagedListBuilder(androidx.paging.DataSource.Factory,kotlin.Int)">RxPagedListBuilder</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>,&nbsp;Value&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <span><del><a href="/reference/androidx/paging/RxPagedListBuilder.html#RxPagedListBuilder(androidx.paging.DataSource.Factory,kotlin.Int)">RxPagedListBuilder</a></del></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory,<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;pageSize<br>)</pre>
<aside class="caution"><strong>This method is deprecated.</strong><br>PagedList is deprecated and has been replaced by PagingData</aside>
<p>Creates a <code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a></code> with required parameters.</p>
<p>This method is a convenience for:</p>
<pre class="prettyprint">RxPagedListBuilder(<br> dataSourceFactory,<br> PagedList.Config.Builder().setPageSize(pageSize).build()<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a>&lt;Key,&nbsp;Value&gt;&nbsp;dataSourceFactory</code></td>
<td width="100%">
<p><code><a href="/reference/androidx/paging/DataSource.Factory.html">DataSource.Factory</a></code> providing DataSource generations.</p>
</td>
</tr>
<tr>
<td><code>int&nbsp;pageSize</code></td>
<td width="100%">
<p>Size of pages to load.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<h2>Public methods</h2>
<div><a name="buildFlowable-BackpressureStrategy-"></a>
<h3 class="api-name" id="buildFlowable(BackpressureStrategy)">buildFlowable</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#buildFlowable(BackpressureStrategy)">buildFlowable</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;backpressureStrategy)</pre>
<p>Constructs a <code>Flowable&lt;PagedList&gt;</code>.</p>
<p>The returned Observable will already be observed on the <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#notifyScheduler()">notifyScheduler</a></code>, and subscribed on the <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#fetchScheduler()">fetchScheduler</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;</code></td>
<td width="100%">
<p>The <a href="[Flowable]">Flowable</a> of PagedLists</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;backpressureStrategy</code></td>
<td width="100%">
<p>BackpressureStrategy for the <a href="[Flowable]">Flowable</a> to use.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="buildObservable--"></a>
<h3 class="api-name" id="buildObservable()">buildObservable</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#buildObservable()">buildObservable</a>()</pre>
<p>Constructs a <code>Observable&lt;PagedList&gt;</code>.</p>
<p>The returned Observable will already be observed on the <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#notifyScheduler()">notifyScheduler</a></code>, and subscribed on the <code><a href="/reference/androidx/paging/RxPagedListBuilder.html#fetchScheduler()">fetchScheduler</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&lt;<a href="/reference/androidx/paging/PagedList.html">PagedList</a>&lt;Value&gt;&gt;</code></td>
<td width="100%">
<p>The <a href="[Observable]">Observable</a> of PagedLists</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="setBoundaryCallback-androidx.paging.PagedList.BoundaryCallback-"></a>
<h3 class="api-name" id="setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback)">setBoundaryCallback</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#setBoundaryCallback(androidx.paging.PagedList.BoundaryCallback)">setBoundaryCallback</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="/reference/androidx/paging/PagedList.BoundaryCallback.html">PagedList.BoundaryCallback</a>&lt;Value&gt;&nbsp;boundaryCallback<br>)</pre>
<p>Sets a <code><a href="/reference/androidx/paging/PagedList.BoundaryCallback.html">androidx.paging.PagedList.BoundaryCallback</a></code> on each PagedList created, typically used to load additional data from network when paging from local storage.</p>
<p>Pass a BoundaryCallback to listen to when the PagedList runs out of data to load. If this method is not called, or <code>null</code> is passed, you will not be notified when each DataSource runs out of data to provide to its PagedList.</p>
<p>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.</p>
<p>Note that when using a BoundaryCallback with a <code>Observable&lt;PagedList&gt;</code>, 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.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<p>this</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;<a href="/reference/androidx/paging/PagedList.BoundaryCallback.html">PagedList.BoundaryCallback</a>&lt;Value&gt;&nbsp;boundaryCallback</code></td>
<td width="100%">
<p>The boundary callback for listening to PagedList load state.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="setFetchScheduler-Scheduler-"></a>
<h3 class="api-name" id="setFetchScheduler(Scheduler)">setFetchScheduler</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#setFetchScheduler(Scheduler)">setFetchScheduler</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler)</pre>
<p>Sets scheduler which will be used for background fetching of PagedLists, as well as on-demand fetching of pages inside.</p>
<p>If not set, defaults to the Arch components I/O thread pool.</p>
<p>The built <a href="[Observable]">Observable</a> / <a href="[Flowable]">Flowable</a> will be subscribed on this scheduler.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<p>this</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler</code></td>
<td width="100%">
<p><a href="[Scheduler]">Scheduler</a> used to fetch from DataSources, generally a background thread pool for e.g. I/O or network loading.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="setInitialLoadKey-kotlin.Any-"></a>
<h3 class="api-name" id="setInitialLoadKey(kotlin.Any)">setInitialLoadKey</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#setInitialLoadKey(kotlin.Any)">setInitialLoadKey</a>(@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;Key&nbsp;key)</pre>
<p>First loading key passed to the first PagedList/DataSource.</p>
<p>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.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<p>this</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>@<a href="/reference/androidx/annotation/Nullable.html">Nullable</a>&nbsp;Key&nbsp;key</code></td>
<td width="100%">
<p>Initial load key passed to the first PagedList/DataSource.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div><a name="setNotifyScheduler-Scheduler-"></a>
<h3 class="api-name" id="setNotifyScheduler(Scheduler)">setNotifyScheduler</h3>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;&nbsp;<a href="/reference/androidx/paging/RxPagedListBuilder.html#setNotifyScheduler(Scheduler)">setNotifyScheduler</a>(<a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler)</pre>
<p>Sets scheduler which will be used for observing new PagedLists, as well as loading updates within the PagedLists.</p>
<p>If not set, defaults to the UI thread.</p>
<p>The built <a href="[Observable]">Observable</a> / <a href="[Flowable]">Flowable</a> will be observed on this scheduler, so that the thread receiving PagedLists will also receive the internal updates to the PagedList.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Returns</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/androidx/paging/RxPagedListBuilder.html">RxPagedListBuilder</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<p>this</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a>&nbsp;scheduler</code></td>
<td width="100%">
<p>Scheduler that receives PagedList updates, and where <code><a href="/reference/androidx/paging/PagedList.Callback.html">PagedList.Callback</a></code> calls are dispatched. Generally, this is the UI/main thread.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>