blob: 72643ee8e113ac1976056fed4f59942463ab007e [file] [log] [blame]
<html devsite="true">
<head>
<title>PagingSource.LoadResult.Error</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>PagingSource.LoadResult.Error</h1>
{% setvar page_path %}androidx/paging/PagingSource.LoadResult.Error.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_kotlin_switcher2.md" %}
<p>
<pre>data class PagingSource.LoadResult.Error : <a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.html">PagingSource.LoadResult</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">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="2"><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.html">PagingSource.LoadResult</a></td>
</tr>
<tr>
<td>&nbsp;</td>
<td class="jd-inheritance-space">&nbsp;&nbsp;&nbsp;↳</td>
<td colspan="1"><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html">PagingSource.LoadResult.Error</a></td>
</tr>
</tbody>
</table>
</div>
<hr>
<p>Error result object for <code><a href="/reference/kotlin/androidx/paging/PagingSource.html#load(androidx.paging.PagingSource.LoadParams)">PagingSource.load</a></code>.</p>
<p>This return type indicates an expected, recoverable error (such as a network load failure). This failure will be forwarded to the UI as a <code><a href="/reference/kotlin/androidx/paging/LoadState.Error.html">LoadState.Error</a></code>, and may be retried.</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/Throwable.html">Throwable</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#throwable()">throwable</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/PagingSource.LoadResult.Error.html#Error(kotlin.Throwable)">Error</a>(throwable:&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="devsite-table-wrapper">
<table class="responsive">
<thead>
<tr>
<th colspan="2"><h3>Public functions</h3></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>operator <a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#component1()">component1</a>()</code></div>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html">PagingSource.LoadResult.Error</a>&lt;Key,&nbsp;Value&gt;</code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#copy(kotlin.Throwable)">copy</a>(throwable:&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public properties</h2>
<div><a name="getThrowable()"></a><a name="setThrowable()"></a><a name="getThrowable--"></a><a name="setThrowable--"></a>
<h3 class="api-name" id="throwable()">throwable</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#throwable()">throwable</a>:&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a></pre>
</div>
<h2>Public constructors</h2>
<div><a name="Error-kotlin.Throwable-"></a>
<h3 class="api-name" id="Error(kotlin.Throwable)">Error</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#Error(kotlin.Throwable)">Error</a>(throwable:&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a>)</pre>
</div>
<h2>Public functions</h2>
<div><a name="component1--"></a>
<h3 class="api-name" id="component1()">component1</h3>
<pre class="api-signature no-pretty-print">operator&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#component1()">component1</a>():&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a></pre>
</div>
<div><a name="copy-kotlin.Throwable-"></a>
<h3 class="api-name" id="copy(kotlin.Throwable)">copy</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html#copy(kotlin.Throwable)">copy</a>(throwable:&nbsp;<a href="/reference/kotlin/kotlin/Throwable.html">Throwable</a>):&nbsp;<a href="/reference/kotlin/androidx/paging/PagingSource.LoadResult.Error.html">PagingSource.LoadResult.Error</a>&lt;Key,&nbsp;Value&gt;</pre>
</div>
</body>
</html>