Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / c2f2ba9c887aa0cc0def9a7914ce77d8262d6dd5 / . / testData / paging / docs / reference / kotlin / androidx / paging / LoadState.html
blob: 73e28cf945e667fa91c2965b725a233ced62a812 [file] [log] [blame]
<html devsite="true">
<head>
<title>LoadState</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>LoadState</h1>
{% setvar page_path %}androidx/paging/LoadState.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_kotlin_switcher2.md" %}
<p>
<pre>sealed class LoadState</pre>
</p>
<div class="devsite-table-wrapper"><devsite-expandable><span class="expand-control jd-sumtable-subclasses">Known direct subclasses
<div class="showalways" id="subclasses-direct"><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a>, <a href="/reference/kotlin/androidx/paging/LoadState.Loading.html">LoadState.Loading</a>, <a href="/reference/kotlin/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></div>
</span>
<div id="subclasses-direct-summary">
<div class="devsite-table-wrapper">
<table class="responsive">
<tbody>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a></code></td>
<td width="100%">
<p>Loading hit an error.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code></td>
<td width="100%">
<p>Loading is in progress.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code></td>
<td width="100%">
<p>Indicates the <code><a href="/reference/kotlin/androidx/paging/PagingData.html">PagingData</a></code> is not currently loading, and no error currently observed.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</devsite-expandable> </div>
<hr>
<p>LoadState of a PagedList load - associated with a <code><a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a></code></p>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> of any <code><a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a></code> may be observed for UI purposes by registering a listener via <code><a href="/reference/kotlin/androidx/paging/PagingDataAdapter.html#addLoadStateListener(kotlin.Function1)">androidx.paging.PagingDataAdapter.addLoadStateListener</a></code> or <code><a href="/reference/kotlin/androidx/paging/AsyncPagingDataDiffer.html#addLoadStateListener(kotlin.Function1)">androidx.paging.AsyncPagingDataDiffer.addLoadStateListener</a></code></p>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>endOfPaginationReached</code></td>
<td width="100%">
<p><code>false</code> if there is more data to load in the <code><a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a></code> this <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> is associated with, <code>true</code> otherwise. This parameter informs <code><a href="/reference/kotlin/androidx/paging/Pager.html">Pager</a></code> if it should continue to make requests for additional data in this direction or if it should halt as the end of the dataset has been reached.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">See also</th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a></code></td>
<td width="100%"></td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Nested types</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a></code></td>
<td width="100%">
<p>Loading hit an error.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code></td>
<td width="100%">
<p>Loading is in progress.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code></td>
<td width="100%">
<p>Indicates the <code><a href="/reference/kotlin/androidx/paging/PagingData.html">PagingData</a></code> is not currently loading, and no error currently observed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public properties</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code><a href="/reference/kotlin/kotlin/Boolean.html">Boolean</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadState.html#endOfPaginationReached()">endOfPaginationReached</a></code></div>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public properties</h2>
<div><a name="getEndOfPaginationReached()"></a><a name="setEndOfPaginationReached()"></a><a name="getEndOfPaginationReached--"></a><a name="setEndOfPaginationReached--"></a>
<h3 class="api-name" id="endOfPaginationReached()">endOfPaginationReached</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html#endOfPaginationReached()">endOfPaginationReached</a>:&nbsp;<a href="/reference/kotlin/kotlin/Boolean.html">Boolean</a></pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2">Parameters</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>endOfPaginationReached</code></td>
<td width="100%">
<p><code>false</code> if there is more data to load in the <code><a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a></code> this <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> is associated with, <code>true</code> otherwise. This parameter informs <code><a href="/reference/kotlin/androidx/paging/Pager.html">Pager</a></code> if it should continue to make requests for additional data in this direction or if it should halt as the end of the dataset has been reached.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</body>
</html>