| <html devsite="true"> |
| <head> |
| <title>RemoteMediator.MediatorResult.Success</title> |
| {% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <h1>RemoteMediator.MediatorResult.Success</h1> |
| {% setvar page_path %}androidx/paging/RemoteMediator.MediatorResult.Success.html{% endsetvar %} |
| {% setvar can_switch %}1{% endsetvar %} |
| {% include "reference/_kotlin_switcher2.md" %} |
| <p> |
| <pre>class RemoteMediator.MediatorResult.Success : <a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.html">RemoteMediator.MediatorResult</a></pre> |
| </p> |
| <div class="devsite-table-wrapper"> |
| <table class="jd-inheritance-table"> |
| <tbody> |
| <tr> |
| <td colspan="3"><a href="/reference/kotlin/kotlin/Any.html">Any</a></td> |
| </tr> |
| <tr> |
| <td class="jd-inheritance-space"> ↳</td> |
| <td colspan="2"><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.html">RemoteMediator.MediatorResult</a></td> |
| </tr> |
| <tr> |
| <td> </td> |
| <td class="jd-inheritance-space"> ↳</td> |
| <td colspan="1"><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html">RemoteMediator.MediatorResult.Success</a></td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <hr> |
| <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> |
| <p>NOTE: It is the responsibility of <code><a href="/reference/kotlin/androidx/paging/RemoteMediator.html#load(androidx.paging.LoadType,androidx.paging.PagingState)">load</a></code> to update the backing dataset and trigger <code><a href="/reference/kotlin/androidx/paging/PagingSource.html#invalidate()">PagingSource.invalidate</a></code> to allow <code><a href="/reference/kotlin/androidx/paging/PagingDataAdapter.html">androidx.paging.PagingDataAdapter</a></code> to pick up new items found by <code><a href="/reference/kotlin/androidx/paging/RemoteMediator.html#load(androidx.paging.LoadType,androidx.paging.PagingState)">load</a></code>.</p> |
| <h2>Summary</h2> |
| <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/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a></code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <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><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html#Success(kotlin.Boolean)">Success</a>(endOfPaginationReached: <a href="/reference/kotlin/kotlin/Boolean.html">Boolean</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 <a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html#endOfPaginationReached()">endOfPaginationReached</a>: <a href="/reference/kotlin/kotlin/Boolean.html">Boolean</a></pre> |
| </div> |
| <h2>Public constructors</h2> |
| <div><a name="Success-kotlin.Boolean-"></a> |
| <h3 class="api-name" id="Success(kotlin.Boolean)">Success</h3> |
| <pre class="api-signature no-pretty-print"><a href="/reference/kotlin/androidx/paging/RemoteMediator.MediatorResult.Success.html#Success(kotlin.Boolean)">Success</a>(endOfPaginationReached: <a href="/reference/kotlin/kotlin/Boolean.html">Boolean</a>)</pre> |
| </div> |
| </body> |
| </html> |
