blob: e534c982218e098353f1696911e667c1de84ff01 [file] [log] [blame]
<html devsite="true">
<head>
<title>RemoteMediator.MediatorResult</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>RemoteMediator.MediatorResult</h1>
{% setvar page_path %}androidx/paging/RemoteMediator.MediatorResult.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_kotlin_switcher2.md" %}
<p>
<pre>sealed class RemoteMediator.MediatorResult</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/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a>, <a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</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/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a></code></td>
<td width="100%">
<p>Recoverable error that can be retried, sets the <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> to <code><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a></code>.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</a></code></td>
<td width="100%">
<p>Success signaling that <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> should be set to <code><a href="/reference/kotlin/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> if <code><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a></code> is <code>true</code>, otherwise <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> is kept at <code><a href="/reference/kotlin/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code> to await invalidation.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</devsite-expandable> </div>
<hr>
<p>Return type of <code><a href="/reference/kotlin/androidx/paging/RemoteMediator.html#load(androidx.paging.LoadType,androidx.paging.PagingState)">load</a></code>, which determines <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code>.</p>
<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/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a></code></td>
<td width="100%">
<p>Recoverable error that can be retried, sets the <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> to <code><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a></code>.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</a></code></td>
<td width="100%">
<p>Success signaling that <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> should be set to <code><a href="/reference/kotlin/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> if <code><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a></code> is <code>true</code>, otherwise <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> is kept at <code><a href="/reference/kotlin/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code> to await invalidation.</p>
</td>
</tr>
</tbody>
</table>
</div>
</body>
</html>