Google Git
Sign in
android/platform/tools/dokka-devsite-plugin/0a4e539cb5607c306e3ffe51b616f4e6601a4bc3/./testData/paging/docs/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html
blob: a700e90d6f319c423e69e8416e8de2231eb369de [file]
<html devsite="true">
<head>
<title>PageKeyedDataSource.LoadInitialParams</title>
{% setvar book_path %}/reference/androidx/_book.yaml{% endsetvar %}
{% include "_shared/_reference-head-tags.html" %}
</head>
<body>
<div itemscope="" itemtype="http://developers.google.com/ReferenceObject">
<meta itemprop="name" content="PageKeyedDataSource.LoadInitialParams">
<meta itemprop="path" content="androidx.paging">
<meta itemprop="property" content="placeholdersEnabled()">
<meta itemprop="property" content="requestedLoadSize()">
<meta itemprop="language" content="JAVA">
</div>
<div id="header-block">
<div>
<h1>PageKeyedDataSource.LoadInitialParams</h1>
</div>
<div id="metadata-info-block">
<div id="source-link"><a href="https://cs.android.com/search?q=file:androidx/paging/PageKeyedDataSource.kt+class:androidx.paging.PageKeyedDataSource.LoadInitialParams&amp;ss=androidx/platform/frameworks/support" class="external">View Source</a></div>
</div>
</div>
<div id="refdoc-switcher-placeholder"></div>
<p>
<pre>public class <a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html">PageKeyedDataSource.LoadInitialParams</a>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</pre>
</p>
<hr>
<p>Holder object for inputs to <code><a href="/reference/androidx/paging/PageKeyedDataSource.html#loadInitial(androidx.paging.PageKeyedDataSource.LoadInitialParams)">loadInitial</a></code>.</p>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</code></td>
<td>
<p>Type of data used to query pages.</p>
</td>
</tr>
</tbody>
</table>
</div>
<h2>Summary</h2>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%"><h3>Public fields</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>final boolean</code></td>
<td>
<div><code><a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#placeholdersEnabled()">placeholdersEnabled</a></code></div>
<p>Defines whether placeholders are enabled, and whether the loaded total count will be ignored.</p>
</td>
</tr>
<tr>
<td><code>final int</code></td>
<td>
<div><code><a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#requestedLoadSize()">requestedLoadSize</a></code></div>
<p>Requested number of items to load.</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>Public constructors</h3></th>
</tr>
</thead>
<tbody class="list">
<tr>
<td>
<div><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#LoadInitialParams(kotlin.Int,kotlin.Boolean)">LoadInitialParams</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;requestedLoadSize,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;placeholdersEnabled<br>)</code></div>
</td>
</tr>
</tbody>
</table>
</div>
<div class="list">
<h2>Public fields</h2>
<div class="api-item"><a name="getPlaceholdersEnabled()"></a><a name="setPlaceholdersEnabled()"></a><a name="getPlaceholdersEnabled--"></a><a name="setPlaceholdersEnabled--"></a>
<div class="api-name-block">
<div>
<h3 id="placeholdersEnabled()">placeholdersEnabled</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;boolean&nbsp;<a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#placeholdersEnabled()">placeholdersEnabled</a></pre>
<p>Defines whether placeholders are enabled, and whether the loaded total count will be ignored.</p>
</div>
<div class="api-item"><a name="getRequestedLoadSize()"></a><a name="setRequestedLoadSize()"></a><a name="getRequestedLoadSize--"></a><a name="setRequestedLoadSize--"></a>
<div class="api-name-block">
<div>
<h3 id="requestedLoadSize()">requestedLoadSize</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;final&nbsp;int&nbsp;<a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#requestedLoadSize()">requestedLoadSize</a></pre>
<p>Requested number of items to load.</p>
<p>Note that this may be larger than available data.</p>
</div>
</div>
<div class="list">
<h2>Public constructors</h2>
<div class="api-item"><a name="LoadInitialParams(kotlin.Int, kotlin.Boolean)"></a><a name="LoadInitialParams-kotlin.Int-kotlin.Boolean-"></a><a name="loadinitialparams"></a>
<div class="api-name-block">
<div>
<h3 id="LoadInitialParams(kotlin.Int,kotlin.Boolean)">LoadInitialParams</h3>
</div>
</div>
<pre class="api-signature no-pretty-print">public&nbsp;&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt; <a href="/reference/androidx/paging/PageKeyedDataSource.LoadInitialParams.html#LoadInitialParams(kotlin.Int,kotlin.Boolean)">LoadInitialParams</a>(<br>&nbsp;&nbsp;&nbsp;&nbsp;int&nbsp;requestedLoadSize,<br>&nbsp;&nbsp;&nbsp;&nbsp;boolean&nbsp;placeholdersEnabled<br>)</pre>
<div class="devsite-table-wrapper">
<table class="responsive">
<colgroup>
<col width="40%">
<col>
</colgroup>
<thead>
<tr>
<th colspan="100%">Parameters</th>
</tr>
</thead>
<tbody class="list">
<tr>
<td><code>&lt;Key&nbsp;extends&nbsp;<a href="https://developer.android.com/reference/java/lang/Object.html">Object</a>&gt;</code></td>
<td>
<p>Type of data used to query pages.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</body>
</html>