Google Git
Sign in
android / platform / tools / dokka-devsite-plugin / c2f2ba9c887aa0cc0def9a7914ce77d8262d6dd5 / . / testData / paging / docs / reference / kotlin / androidx / paging / LoadStates.html
blob: cab861824ec162457de9cf071ce2d892fe928260 [file] [log] [blame]
<html devsite="true">
<head>
<title>LoadStates</title>
{% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<h1>LoadStates</h1>
{% setvar page_path %}androidx/paging/LoadStates.html{% endsetvar %}
{% setvar can_switch %}1{% endsetvar %}
{% include "reference/_kotlin_switcher2.md" %}
<p>
<pre>data class LoadStates</pre>
</p>
<hr>
<p>Collection of pagination <code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code>s - refresh, prepend, and append.</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/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#append()">append</a></code></div>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.APPEND.html">LoadType.APPEND</a></code> loads.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#prepend()">prepend</a></code></div>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.PREPEND.html">LoadType.PREPEND</a></code> loads.</p>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#refresh()">refresh</a></code></div>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.REFRESH.html">LoadType.REFRESH</a></code> loads.</p>
</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/LoadStates.html#LoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">LoadStates</a>(refresh:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;prepend:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;append:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</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/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#component1()">component1</a>()</code></div>
</td>
</tr>
<tr>
<td><code>operator <a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#component2()">component2</a>()</code></div>
</td>
</tr>
<tr>
<td><code>operator <a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#component3()">component3</a>()</code></div>
</td>
</tr>
<tr>
<td><code><a href="/reference/kotlin/androidx/paging/LoadStates.html">LoadStates</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#copy(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">copy</a>(refresh:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;prepend:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;append:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>)</code></div>
</td>
</tr>
<tr>
<td><code>inline <a href="/reference/kotlin/kotlin/Unit.html">Unit</a></code></td>
<td width="100%">
<div><code><a href="/reference/kotlin/androidx/paging/LoadStates.html#forEach(kotlin.Function2)">forEach</a>(op:&nbsp;(<a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a>,&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>)&nbsp;-&gt;&nbsp;<a href="/reference/kotlin/kotlin/Unit.html">Unit</a>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Public properties</h2>
<div><a name="getAppend()"></a><a name="setAppend()"></a><a name="getAppend--"></a><a name="setAppend--"></a>
<h3 class="api-name" id="append()">append</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#append()">append</a>:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.APPEND.html">LoadType.APPEND</a></code> loads.</p>
</div>
<div><a name="getPrepend()"></a><a name="setPrepend()"></a><a name="getPrepend--"></a><a name="setPrepend--"></a>
<h3 class="api-name" id="prepend()">prepend</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#prepend()">prepend</a>:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.PREPEND.html">LoadType.PREPEND</a></code> loads.</p>
</div>
<div><a name="getRefresh()"></a><a name="setRefresh()"></a><a name="getRefresh--"></a><a name="setRefresh--"></a>
<h3 class="api-name" id="refresh()">refresh</h3>
<pre class="api-signature no-pretty-print">val&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#refresh()">refresh</a>:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
<p><code><a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></code> corresponding to <code><a href="/reference/kotlin/androidx/paging/LoadType.REFRESH.html">LoadType.REFRESH</a></code> loads.</p>
</div>
<h2>Public constructors</h2>
<div><a name="LoadStates(androidx.paging.LoadState, androidx.paging.LoadState, androidx.paging.LoadState)"></a><a name="LoadStates-androidx.paging.LoadState-androidx.paging.LoadState-androidx.paging.LoadState-"></a>
<h3 class="api-name" id="LoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">LoadStates</h3>
<pre class="api-signature no-pretty-print"><a href="/reference/kotlin/androidx/paging/LoadStates.html#LoadStates(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">LoadStates</a>(refresh:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;prepend:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;append:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</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/LoadStates.html#component1()">component1</a>():&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
</div>
<div><a name="component2--"></a>
<h3 class="api-name" id="component2()">component2</h3>
<pre class="api-signature no-pretty-print">operator&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#component2()">component2</a>():&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
</div>
<div><a name="component3--"></a>
<h3 class="api-name" id="component3()">component3</h3>
<pre class="api-signature no-pretty-print">operator&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#component3()">component3</a>():&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a></pre>
</div>
<div><a name="copy(androidx.paging.LoadState, androidx.paging.LoadState, androidx.paging.LoadState)"></a><a name="copy-androidx.paging.LoadState-androidx.paging.LoadState-androidx.paging.LoadState-"></a>
<h3 class="api-name" id="copy(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">copy</h3>
<pre class="api-signature no-pretty-print">fun&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#copy(androidx.paging.LoadState,androidx.paging.LoadState,androidx.paging.LoadState)">copy</a>(refresh:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;prepend:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>,&nbsp;append:&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>):&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html">LoadStates</a></pre>
</div>
<div><a name="forEach-kotlin.Function2-"></a>
<h3 class="api-name" id="forEach(kotlin.Function2)">forEach</h3>
<pre class="api-signature no-pretty-print">@<a href="/reference/kotlin/[JVM root]/&lt;ERROR CLASS&gt;.html">&lt;ERROR CLASS&gt;</a><br>inline&nbsp;fun&nbsp;<a href="/reference/kotlin/androidx/paging/LoadStates.html#forEach(kotlin.Function2)">forEach</a>(op:&nbsp;(<a href="/reference/kotlin/androidx/paging/LoadType.html">LoadType</a>,&nbsp;<a href="/reference/kotlin/androidx/paging/LoadState.html">LoadState</a>)&nbsp;-&gt;&nbsp;<a href="/reference/kotlin/kotlin/Unit.html">Unit</a>):&nbsp;<a href="/reference/kotlin/kotlin/Unit.html">Unit</a></pre>
</div>
</body>
</html>