183 lines
16 KiB
HTML
183 lines
16 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" charset="UTF-8">
|
|
<title>org.matrix.android.sdk.api.query</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.query////PointingToDeclaration//468305090">
|
|
<div class="breadcrumbs"><a href="../../index.html">matrix-sdk-android</a><span class="delimiter">/</span><span class="current">org.matrix.android.sdk.api.query</span></div>
|
|
<div class="cover ">
|
|
<h1 class="cover"><span><span>Package-level</span></span> <span><span>declarations</span></span></h1>
|
|
</div>
|
|
<div class="tabbedcontent">
|
|
<div class="tabs-section" tabs-section="tabs-section"><button class="section-tab" data-active="" data-togglable="Types">Types</button><button class="section-tab" data-togglable="Functions">Functions</button></div>
|
|
<div class="tabs-section-body">
|
|
<h2 class="">Types</h2>
|
|
<div class="table" data-togglable="Types"><a data-name="-774633568%2FClasslikes%2F468305090" anchor-label="QueryStateEventValue" id="-774633568%2FClasslikes%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="-query-state-event-value/index.html"><span>Query</span><wbr></wbr><span>State</span><wbr></wbr><span>Event</span><wbr></wbr><span><span>Value</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-774633568%2FClasslikes%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">interface </span><a href="-query-state-event-value/index.html">QueryStateEventValue</a></div><div class="brief "><p class="paragraph">Only a subset of <a href="-query-string-value/index.html">QueryStringValue</a> are applicable to query the <code class="lang-kotlin">stateKey</code> of a state event.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="2033360040%2FClasslikes%2F468305090" anchor-label="QueryStringValue" id="2033360040%2FClasslikes%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="-query-string-value/index.html"><span>Query</span><wbr></wbr><span>String</span><wbr></wbr><span><span>Value</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="2033360040%2FClasslikes%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">interface </span><a href="-query-string-value/index.html">QueryStringValue</a></div><div class="brief "><p class="paragraph">Basic query language. All these cases are mutually exclusive.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="-1462793937%2FClasslikes%2F468305090" anchor-label="RoomCategoryFilter" id="-1462793937%2FClasslikes%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="-room-category-filter/index.html"><span>Room</span><wbr></wbr><span>Category</span><wbr></wbr><span><span>Filter</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-1462793937%2FClasslikes%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">enum </span><a href="-room-category-filter/index.html">RoomCategoryFilter</a> : <a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-enum/index.html">Enum</a><span class="token operator"><</span><span class="token keyword"></span><a href="-room-category-filter/index.html">RoomCategoryFilter</a><span class="token operator">> </span></div><div class="brief "><p class="paragraph">To filter by Room category.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="705077983%2FClasslikes%2F468305090" anchor-label="RoomTagQueryFilter" id="705077983%2FClasslikes%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="-room-tag-query-filter/index.html"><span>Room</span><wbr></wbr><span>Tag</span><wbr></wbr><span>Query</span><wbr></wbr><span><span>Filter</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="705077983%2FClasslikes%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">data </span><span class="token keyword">class </span><a href="-room-tag-query-filter/index.html">RoomTagQueryFilter</a><span class="token punctuation">(</span><span class="parameters "><span class="parameter "><span class="token keyword">val </span>isFavorite<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>isLowPriority<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span><span class="token punctuation">, </span></span><span class="parameter "><span class="token keyword">val </span>isServerNotice<span class="token operator">: </span><a href="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html">Boolean</a><span class="token operator">?</span></span></span><span class="token punctuation">)</span></div><div class="brief "><p class="paragraph">Filter room by their tag.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1387321604%2FClasslikes%2F468305090" anchor-label="SpaceFilter" id="1387321604%2FClasslikes%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="-space-filter/index.html"><span>Space</span><wbr></wbr><span><span>Filter</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1387321604%2FClasslikes%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">interface </span><a href="-space-filter/index.html">SpaceFilter</a></div><div class="brief "><p class="paragraph">Filter to be used to do room queries regarding the space hierarchy.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2 class="">Functions</h2>
|
|
<div class="table" data-togglable="Functions"><a data-name="-792157125%2FFunctions%2F468305090" anchor-label="toActiveSpaceOrNoFilter" id="-792157125%2FFunctions%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="to-active-space-or-no-filter.html"><span>to</span><wbr></wbr><span>Active</span><wbr></wbr><span>Space</span><wbr></wbr><span>Or</span><wbr></wbr><span>No</span><wbr></wbr><span><span>Filter</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="-792157125%2FFunctions%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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">.</span><a href="to-active-space-or-no-filter.html"><span class="token function">toActiveSpaceOrNoFilter</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-space-filter/index.html">SpaceFilter</a></div><div class="brief "><p class="paragraph">Return a <a href="-space-filter/-active-space/index.html">SpaceFilter.ActiveSpace</a> if the String is not null, or <a href="-space-filter/-no-filter/index.html">SpaceFilter.NoFilter</a>.</p></div></div></div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<a data-name="1257700728%2FFunctions%2F468305090" anchor-label="toActiveSpaceOrOrphanRooms" id="1257700728%2FFunctions%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="to-active-space-or-orphan-rooms.html"><span>to</span><wbr></wbr><span>Active</span><wbr></wbr><span>Space</span><wbr></wbr><span>Or</span><wbr></wbr><span>Orphan</span><wbr></wbr><span><span>Rooms</span></span></a></div>
|
|
<span class="anchor-wrapper"><span class="anchor-icon" pointing-to="1257700728%2FFunctions%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="https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html">String</a><span class="token operator">?</span><span class="token punctuation">.</span><a href="to-active-space-or-orphan-rooms.html"><span class="token function">toActiveSpaceOrOrphanRooms</span></a><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token operator">: </span><a href="-space-filter/index.html">SpaceFilter</a></div><div class="brief "><p class="paragraph">Return a <a href="-space-filter/-active-space/index.html">SpaceFilter.ActiveSpace</a> if the String is not null, or <a href="-space-filter/-orphan-rooms/index.html">SpaceFilter.OrphanRooms</a>.</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>
|