| <html devsite="true"> |
| <head> |
| <title>PositionalDataSource.LoadInitialParams</title> |
| {% setvar book_path %}/reference/kotlin/androidx/_book.yaml{% endsetvar %} |
| {% include "_shared/_reference-head-tags.html" %} |
| </head> |
| <body> |
| <h1>PositionalDataSource.LoadInitialParams</h1> |
| {% setvar page_path %}androidx/paging/PositionalDataSource.LoadInitialParams.html{% endsetvar %} |
| {% setvar can_switch %}1{% endsetvar %} |
| {% include "reference/_kotlin_switcher2.md" %} |
| <p> |
| <pre>open class PositionalDataSource.LoadInitialParams</pre> |
| </p> |
| <hr> |
| <p>Holder object for inputs to <code><a href="/reference/kotlin/androidx/paging/PositionalDataSource.html#loadInitial(androidx.paging.PositionalDataSource.LoadInitialParams)">loadInitial</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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#pageSize()">pageSize</a></code></div> |
| <p>Defines page size acceptable for return values.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/kotlin/androidx/paging/PositionalDataSource.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><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#requestedLoadSize()">requestedLoadSize</a></code></div> |
| <p>Requested number of items to load.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><code><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></code></td> |
| <td width="100%"> |
| <div><code><a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#requestedStartPosition()">requestedStartPosition</a></code></div> |
| <p>Initial load position requested.</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/PositionalDataSource.LoadInitialParams.html#LoadInitialParams(kotlin.Int,kotlin.Int,kotlin.Int,kotlin.Boolean)">LoadInitialParams</a>(<br> requestedStartPosition: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> requestedLoadSize: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> pageSize: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> placeholdersEnabled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><br>)</code></div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <h2>Public properties</h2> |
| <div><a name="getPageSize()"></a><a name="setPageSize()"></a><a name="getPageSize--"></a><a name="setPageSize--"></a> |
| <h3 class="api-name" id="pageSize()">pageSize</h3> |
| <pre class="api-signature no-pretty-print">val <a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#pageSize()">pageSize</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre> |
| <p>Defines page size acceptable for return values.</p> |
| <p>List of items passed to the callback must be an integer multiple of page size.</p> |
| </div> |
| <div><a name="getPlaceholdersEnabled()"></a><a name="setPlaceholdersEnabled()"></a><a name="getPlaceholdersEnabled--"></a><a name="setPlaceholdersEnabled--"></a> |
| <h3 class="api-name" id="placeholdersEnabled()">placeholdersEnabled</h3> |
| <pre class="api-signature no-pretty-print">val <a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#placeholdersEnabled()">placeholdersEnabled</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a></pre> |
| <p>Defines whether placeholders are enabled, and whether the loaded total count will be ignored.</p> |
| </div> |
| <div><a name="getRequestedLoadSize()"></a><a name="setRequestedLoadSize()"></a><a name="getRequestedLoadSize--"></a><a name="setRequestedLoadSize--"></a> |
| <h3 class="api-name" id="requestedLoadSize()">requestedLoadSize</h3> |
| <pre class="api-signature no-pretty-print">val <a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#requestedLoadSize()">requestedLoadSize</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre> |
| <p>Requested number of items to load.</p> |
| <p>Note that this may be larger than available data.</p> |
| </div> |
| <div><a name="getRequestedStartPosition()"></a><a name="setRequestedStartPosition()"></a><a name="getRequestedStartPosition--"></a><a name="setRequestedStartPosition--"></a> |
| <h3 class="api-name" id="requestedStartPosition()">requestedStartPosition</h3> |
| <pre class="api-signature no-pretty-print">val <a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#requestedStartPosition()">requestedStartPosition</a>: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a></pre> |
| <p>Initial load position requested.</p> |
| <p>Note that this may not be within the bounds of your data set, it may need to be adjusted before you execute your load.</p> |
| </div> |
| <h2>Public constructors</h2> |
| <div><a name="LoadInitialParams(kotlin.Int, kotlin.Int, kotlin.Int, kotlin.Boolean)"></a><a name="LoadInitialParams-kotlin.Int-kotlin.Int-kotlin.Int-kotlin.Boolean-"></a> |
| <h3 class="api-name" id="LoadInitialParams(kotlin.Int,kotlin.Int,kotlin.Int,kotlin.Boolean)">LoadInitialParams</h3> |
| <pre class="api-signature no-pretty-print"><a href="/reference/kotlin/androidx/paging/PositionalDataSource.LoadInitialParams.html#LoadInitialParams(kotlin.Int,kotlin.Int,kotlin.Int,kotlin.Boolean)">LoadInitialParams</a>(<br> requestedStartPosition: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> requestedLoadSize: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> pageSize: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a>,<br> placeholdersEnabled: <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><br>)</pre> |
| </div> |
| </body> |
| </html> |
