154 lines
21 KiB
HTML
154 lines
21 KiB
HTML
<!DOCTYPE html>
|
||
<html>
|
||
<head>
|
||
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
||
<title>PublicRoomsResponse</title>
|
||
<link href="../../../images/logo-icon.svg" rel="icon" type="image/svg">
|
||
<script>var pathToRoot = "../../../";</script>
|
||
<script>const storage = localStorage.getItem("dokka-dark-mode")
|
||
if (storage == null) {
|
||
const osDarkSchemePreferred = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches
|
||
if (osDarkSchemePreferred === true) {
|
||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||
}
|
||
} else {
|
||
const savedDarkMode = JSON.parse(storage)
|
||
if(savedDarkMode === true) {
|
||
document.getElementsByTagName("html")[0].classList.add("theme-dark")
|
||
}
|
||
}
|
||
</script>
|
||
<script type="text/javascript" src="../../../scripts/sourceset_dependencies.js" async="async"></script>
|
||
<link href="../../../styles/style.css" rel="Stylesheet">
|
||
<link href="../../../styles/jetbrains-mono.css" rel="Stylesheet">
|
||
<link href="../../../styles/main.css" rel="Stylesheet">
|
||
<link href="../../../styles/prism.css" rel="Stylesheet">
|
||
<link href="../../../styles/logo-styles.css" rel="Stylesheet">
|
||
<script type="text/javascript" src="../../../scripts/clipboard.js" async="async"></script>
|
||
<script type="text/javascript" src="../../../scripts/navigation-loader.js" async="async"></script>
|
||
<script type="text/javascript" src="../../../scripts/platform-content-handler.js" async="async"></script>
|
||
<script type="text/javascript" src="../../../scripts/main.js" defer="defer"></script>
|
||
<script type="text/javascript" src="../../../scripts/prism.js" async="async"></script>
|
||
<script type="text/javascript" src="../../../scripts/symbol-parameters-wrapper_deferred.js" defer="defer"></script>
|
||
</head>
|
||
<body>
|
||
<div class="navigation-wrapper" id="navigation-wrapper">
|
||
<div id="leftToggler"><span class="icon-toggler"></span></div>
|
||
<div class="library-name">
|
||
<a href="../../../index.html">
|
||
<span>matrix-sdk-android</span>
|
||
</a>
|
||
</div>
|
||
<div>
|
||
</div>
|
||
<div class="pull-right d-flex">
|
||
<button id="theme-toggle-button"><span id="theme-toggle"></span></button>
|
||
<div id="searchBar"></div>
|
||
</div>
|
||
</div>
|
||
<div id="container">
|
||
<div id="leftColumn">
|
||
<div id="sideMenu"></div>
|
||
</div>
|
||
<div id="main">
|
||
<div class="main-content" id="content" pageIds="matrix-sdk-android::org.matrix.android.sdk.api.session.room.model.roomdirectory/PublicRoomsResponse///PointingToDeclaration//468305090">
|
||
<div class="breadcrumbs"><a href="../../../index.html">matrix-sdk-android</a><span class="delimiter">/</span><a href="../index.html">org.matrix.android.sdk.api.session.room.model.roomdirectory</a><span class="delimiter">/</span><span class="current">PublicRoomsResponse</span></div>
|
||
<div class="cover ">
|
||
<h1 class="cover"><span>Public</span><wbr></wbr><span>Rooms</span><wbr></wbr><span><span>Response</span></span></h1>
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><div class="block"><div class="block"><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/JsonClass///PointingToDeclaration/"><span class="token annotation builtin">JsonClass</span></span><span class="token punctuation">(</span><span>generateAdapter<span class="token operator"> = </span><span class="breakable-word"><span class="token boolean">true</span></span></span><wbr></wbr><span class="token punctuation">)</span></div></div><span class="token keyword">data </span><span class="token keyword">class </span><a href="index.html">PublicRoomsResponse</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"next_batch"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span><span class="token keyword">val </span>nextBatch<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"prev_batch"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span><span class="token keyword">val </span>prevBatch<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"chunk"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span><span class="token keyword">val </span>chunk<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-public-room/index.html">PublicRoom</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"total_room_count_estimate"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span><span class="token keyword">val </span>totalRoomCountEstimate<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div><p class="paragraph">Class representing the public rooms request response.</p></div></div>
|
||
</div>
|
||
<div class="tabbedcontent">
|
||
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Constructors">Constructors</button><button class="section-tab" data-togglable="Properties">Properties</button></div>
|
||
<div class="tabs-section-body">
|
||
<h2 class="tabbedcontent">Constructors</h2>
|
||
<div class="table" data-togglable="Constructors"><a data-name="-1300068042%2FConstructors%2F468305090" anchor-label="PublicRoomsResponse" id="-1300068042%2FConstructors%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
||
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
||
<div class="main-subrow keyValue TabbedContent">
|
||
<div class=""><span class="inline-flex">
|
||
<div><a href="-public-rooms-response.html"><span>Public</span><wbr></wbr><span>Rooms</span><wbr></wbr><span><span>Response</span></span></a></div>
|
||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1300068042%2FConstructors%2F468305090"></span>
|
||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||
</span></span></div>
|
||
<div>
|
||
<div class="title">
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">fun </span><a href="-public-rooms-response.html"><span class="token function">PublicRoomsResponse</span></a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"next_batch"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span>nextBatch<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"prev_batch"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span>prevBatch<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"chunk"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span>chunk<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-public-room/index.html">PublicRoom</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null<span class="token punctuation">, </span></span><span class="parameter "><span><span class="token annotation builtin">@</span><span data-unresolved-link="com.squareup.moshi/Json///PointingToDeclaration/"><span class="token annotation builtin">Json</span></span><span class="token punctuation">(</span><span>name<span class="token operator"> = </span><span class="breakable-word"><span class="token string">"total_room_count_estimate"</span></span></span><wbr></wbr><span class="token punctuation">)</span> </span>totalRoomCountEstimate<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null</span></span><span class="token punctuation">)</span></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<h2 class="">Properties</h2>
|
||
<div class="table" data-togglable="Properties"><a data-name="1404730402%2FProperties%2F468305090" anchor-label="chunk" id="1404730402%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
||
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
||
<div class="main-subrow keyValue ">
|
||
<div class=""><span class="inline-flex">
|
||
<div><a href="chunk.html"><span><span>chunk</span></span></a></div>
|
||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1404730402%2FProperties%2F468305090"></span>
|
||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||
</span></span></div>
|
||
<div>
|
||
<div class="title">
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><a data-name="1404730402%2FProperties%2F468305090" anchor-label="chunk" id="1404730402%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="chunk.html">chunk</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-list/index.html">List</a><span class="token operator"><</span><span class="token keyword"></span><a href="../-public-room/index.html">PublicRoom</a><span class="token operator">></span><span class="token operator">?</span><span class="token operator"> = </span>null</div><div class="brief "><a data-name="1404730402%2FProperties%2F468305090" anchor-label="chunk" id="1404730402%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><p class="paragraph">A paginated chunk of public rooms.</p></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<a data-name="1307712200%2FProperties%2F468305090" anchor-label="nextBatch" id="1307712200%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
||
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
||
<div class="main-subrow keyValue ">
|
||
<div class=""><span class="inline-flex">
|
||
<div><a href="next-batch.html"><span>next</span><wbr></wbr><span><span>Batch</span></span></a></div>
|
||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1307712200%2FProperties%2F468305090"></span>
|
||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||
</span></span></div>
|
||
<div>
|
||
<div class="title">
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><a data-name="1307712200%2FProperties%2F468305090" anchor-label="nextBatch" id="1307712200%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="next-batch.html">nextBatch</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null</div><div class="brief "><a data-name="1307712200%2FProperties%2F468305090" anchor-label="nextBatch" id="1307712200%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><p class="paragraph">A pagination token for the response. The absence of this token means there are no more results to fetch and the client should stop paginating.</p></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<a data-name="979567112%2FProperties%2F468305090" anchor-label="prevBatch" id="979567112%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
||
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
||
<div class="main-subrow keyValue ">
|
||
<div class=""><span class="inline-flex">
|
||
<div><a href="prev-batch.html"><span>prev</span><wbr></wbr><span><span>Batch</span></span></a></div>
|
||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="979567112%2FProperties%2F468305090"></span>
|
||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||
</span></span></div>
|
||
<div>
|
||
<div class="title">
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><a data-name="979567112%2FProperties%2F468305090" anchor-label="prevBatch" id="979567112%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="prev-batch.html">prevBatch</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token operator"> = </span>null</div><div class="brief "><a data-name="979567112%2FProperties%2F468305090" anchor-label="prevBatch" id="979567112%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><p class="paragraph">A pagination token that allows fetching previous results. The absence of this token means there are no results before this batch, i.e. this is the first batch.</p></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<a data-name="829542259%2FProperties%2F468305090" anchor-label="totalRoomCountEstimate" id="829542259%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a>
|
||
<div class="table-row" data-filterable-current=":matrix-sdk-android:dokkaHtml/release" data-filterable-set=":matrix-sdk-android:dokkaHtml/release">
|
||
<div class="main-subrow keyValue ">
|
||
<div class=""><span class="inline-flex">
|
||
<div><a href="total-room-count-estimate.html"><span>total</span><wbr></wbr><span>Room</span><wbr></wbr><span>Count</span><wbr></wbr><span><span>Estimate</span></span></a></div>
|
||
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="829542259%2FProperties%2F468305090"></span>
|
||
<div class="copy-popup-wrapper "><span class="copy-popup-icon"></span><span>Link copied to clipboard</span></div>
|
||
</span></span></div>
|
||
<div>
|
||
<div class="title">
|
||
<div class="platform-hinted " data-platform-hinted="data-platform-hinted" data-togglable="Properties"><div class="content sourceset-dependent-content" data-active="" data-togglable=":matrix-sdk-android:dokkaHtml/release"><a data-name="829542259%2FProperties%2F468305090" anchor-label="totalRoomCountEstimate" id="829542259%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><div class="symbol monospace"><span class="token keyword"></span><span class="token keyword">val </span><a href="total-room-count-estimate.html">totalRoomCountEstimate</a><span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html">Int</a><span class="token operator">?</span><span class="token operator"> = </span>null</div><div class="brief "><a data-name="829542259%2FProperties%2F468305090" anchor-label="totalRoomCountEstimate" id="829542259%2FProperties%2F468305090" data-filterable-set=":matrix-sdk-android:dokkaHtml/release"></a><p class="paragraph">An estimate on the total number of public rooms, if the server has an estimate.</p></div></div></div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div class="footer">
|
||
<span class="go-to-top-icon"><a href="#content" id="go-to-top-link"></a></span><span>© 2023 Copyright</span><span
|
||
class="pull-right"><span>Generated by </span><a
|
||
href="https://github.com/Kotlin/dokka"><span>dokka</span><span class="padded-icon"></span></a></span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
</body>
|
||
</html>
|