blob: ba3899c9a435ec442928bd3ebec91d9cd92da54b [file] [log] [blame]
<html devsite="true">
<head>
<title>RemoteMediator.MediatorResult</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div id="metadata-info-block"></div>
<h1>RemoteMediator.MediatorResult</h1>
<p>
<pre>public class <a href="/reference/androidx/paging/RemoteMediator.MediatorResult.html">RemoteMediator.MediatorResult</a></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/androidx/paging/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a>, <a href="/reference/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">
<colgroup>
<col width="40%">
<col>
</colgroup>
<tbody class="list">
<tr>
<td width="40%"><code><a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a></code></td>
<td>
<p>Recoverable error that can be retried, sets the <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> to <code><a href="/reference/androidx/paging/LoadState.Error.html">LoadState.Error</a></code>.</p>
</td>
</tr>
<tr>
<td width="40%"><code><a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</a></code></td>
<td>
<p>Success signaling that <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> should be set to <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> if <code><a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a></code> is <code>true</code>, otherwise <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> is kept at <code><a href="/reference/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/androidx/paging/RemoteMediator.html#load(androidx.paging.LoadType,androidx.paging.PagingState)">load</a></code>, which determines <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code>.</p>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Nested types</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code>public final class <a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Error.html">RemoteMediator.MediatorResult.Error</a> extends <a href="/reference/androidx/paging/RemoteMediator.MediatorResult.html">RemoteMediator.MediatorResult</a></code></div>
<p>Recoverable error that can be retried, sets the <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> to <code><a href="/reference/androidx/paging/LoadState.Error.html">LoadState.Error</a></code>.</p>
</td>
</tr>
<tr>
<td>
<div><code>public final class <a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</a> extends <a href="/reference/androidx/paging/RemoteMediator.MediatorResult.html">RemoteMediator.MediatorResult</a></code></div>
<p>Success signaling that <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> should be set to <code><a href="/reference/androidx/paging/LoadState.NotLoading.html">LoadState.NotLoading</a></code> if <code><a href="/reference/androidx/paging/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a></code> is <code>true</code>, otherwise <code><a href="/reference/androidx/paging/LoadState.html">LoadState</a></code> is kept at <code><a href="/reference/androidx/paging/LoadState.Loading.html">LoadState.Loading</a></code> to await invalidation.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Protected constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code><a href="/reference/androidx/paging/RemoteMediator.MediatorResult.html#MediatorResult()">MediatorResult</a>()</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Protected constructors</h2>
<div class="api-item"><a name="MediatorResult--"></a><a name="mediatorresult"></a>
<h3 class="api-name" id="MediatorResult()">MediatorResult</h3>
<pre class="api-signature no-pretty-print">protected&nbsp;<a href="/reference/androidx/paging/RemoteMediator.MediatorResult.html#MediatorResult()">MediatorResult</a>()</pre>
</div>
</div>
</body>
</html>