mirror of
https://github.com/element-hq/synapse.git
synced 2026-03-30 21:35:53 +00:00
1296 lines
69 KiB
HTML
1296 lines
69 KiB
HTML
<!DOCTYPE HTML>
|
||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||
<head>
|
||
<!-- Book generated using mdBook -->
|
||
<meta charset="UTF-8">
|
||
<title>Rooms - Synapse</title>
|
||
|
||
|
||
<!-- Custom HTML head -->
|
||
|
||
<meta name="description" content="">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<meta name="theme-color" content="#ffffff">
|
||
|
||
<link rel="icon" href="../favicon-de23e50b.svg">
|
||
<link rel="shortcut icon" href="../favicon-8114d1fc.png">
|
||
<link rel="stylesheet" href="../css/variables-8adf115d.css">
|
||
<link rel="stylesheet" href="../css/general-2459343d.css">
|
||
<link rel="stylesheet" href="../css/chrome-ae938929.css">
|
||
<link rel="stylesheet" href="../css/print-9e4910d8.css" media="print">
|
||
|
||
<!-- Fonts -->
|
||
<link rel="stylesheet" href="../fonts/fonts-9644e21d.css">
|
||
|
||
<!-- Highlight.js Stylesheets -->
|
||
<link rel="stylesheet" id="mdbook-highlight-css" href="../highlight-493f70e1.css">
|
||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="../tomorrow-night-4c0ae647.css">
|
||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="../ayu-highlight-3fdfc3ac.css">
|
||
|
||
<!-- Custom theme stylesheets -->
|
||
<link rel="stylesheet" href="../docs/website_files/indent-section-headers-3390f960.css">
|
||
<link rel="stylesheet" href="../docs/website_files/version-picker-ddc5216e.css">
|
||
|
||
|
||
<!-- Provide site root and default themes to javascript -->
|
||
<script>
|
||
const path_to_root = "../";
|
||
const default_light_theme = "light";
|
||
const default_dark_theme = "navy";
|
||
window.path_to_searchindex_js = "../searchindex-b358e032.js";
|
||
</script>
|
||
<!-- Start loading toc.js asap -->
|
||
<script src="../toc-4dc10a98.js"></script>
|
||
</head>
|
||
<body>
|
||
<div id="mdbook-help-container">
|
||
<div id="mdbook-help-popup">
|
||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||
<div>
|
||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||
<p>Press <kbd>?</kbd> to show this help</p>
|
||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
<div id="mdbook-body-container">
|
||
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
||
<script>
|
||
try {
|
||
let theme = localStorage.getItem('mdbook-theme');
|
||
let sidebar = localStorage.getItem('mdbook-sidebar');
|
||
|
||
if (theme.startsWith('"') && theme.endsWith('"')) {
|
||
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
||
}
|
||
|
||
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
||
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
||
}
|
||
} catch (e) { }
|
||
</script>
|
||
|
||
<!-- Set the theme before any content is loaded, prevents flash -->
|
||
<script>
|
||
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
||
let theme;
|
||
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
||
if (theme === null || theme === undefined) { theme = default_theme; }
|
||
const html = document.documentElement;
|
||
html.classList.remove('light')
|
||
html.classList.add(theme);
|
||
html.classList.add("js");
|
||
</script>
|
||
|
||
<input type="checkbox" id="mdbook-sidebar-toggle-anchor" class="hidden">
|
||
|
||
<!-- Hide / unhide sidebar before it is displayed -->
|
||
<script>
|
||
let sidebar = null;
|
||
const sidebar_toggle = document.getElementById("mdbook-sidebar-toggle-anchor");
|
||
if (document.body.clientWidth >= 1080) {
|
||
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
||
sidebar = sidebar || 'visible';
|
||
} else {
|
||
sidebar = 'hidden';
|
||
sidebar_toggle.checked = false;
|
||
}
|
||
if (sidebar === 'visible') {
|
||
sidebar_toggle.checked = true;
|
||
} else {
|
||
html.classList.remove('sidebar-visible');
|
||
}
|
||
</script>
|
||
|
||
<nav id="mdbook-sidebar" class="sidebar" aria-label="Table of contents">
|
||
<!-- populated by js -->
|
||
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
||
<noscript>
|
||
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
||
</noscript>
|
||
<div id="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||
<div class="sidebar-resize-indicator"></div>
|
||
</div>
|
||
</nav>
|
||
|
||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||
|
||
<div class="page">
|
||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||
<div class="left-buttons">
|
||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||
</label>
|
||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||
</button>
|
||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||
</ul>
|
||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||
</button>
|
||
</div>
|
||
|
||
<!-- BEGIN CUSTOM SYNAPSE MODIFICATIONS -->
|
||
<div class="version-picker">
|
||
<div class="dropdown">
|
||
<div class="select">
|
||
<span></span>
|
||
<i class="fa fa-chevron-down"></i>
|
||
</div>
|
||
<input type="hidden" name="version">
|
||
<ul class="dropdown-menu">
|
||
<!-- Versions will be added dynamically in version-picker.js -->
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
<!-- END CUSTOM SYNAPSE MODIFICATIONS -->
|
||
|
||
<h1 class="menu-title">Synapse</h1>
|
||
|
||
<div class="right-buttons">
|
||
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/element-hq/synapse" title="Git repository" aria-label="Git repository">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||
</a>
|
||
<a href="https://github.com/element-hq/synapse/edit/develop/docs/admin_api/rooms.md" title="Suggest an edit" aria-label="Suggest an edit" rel="edit">
|
||
<span class=fa-svg id="git-edit-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M421.7 220.3l-11.3 11.3-22.6 22.6-205 205c-6.6 6.6-14.8 11.5-23.8 14.1L30.8 511c-8.4 2.5-17.5 .2-23.7-6.1S-1.5 489.7 1 481.2L38.7 353.1c2.6-9 7.5-17.2 14.1-23.8l205-205 22.6-22.6 11.3-11.3 33.9 33.9 62.1 62.1 33.9 33.9zM96 353.9l-9.3 9.3c-.9 .9-1.6 2.1-2 3.4l-25.3 86 86-25.3c1.3-.4 2.5-1.1 3.4-2l9.3-9.3H112c-8.8 0-16-7.2-16-16V353.9zM453.3 19.3l39.4 39.4c25 25 25 65.5 0 90.5l-14.5 14.5-22.6 22.6-11.3 11.3-33.9-33.9-62.1-62.1L314.3 67.7l11.3-11.3 22.6-22.6 14.5-14.5c25-25 65.5-25 90.5 0z"/></svg></span>
|
||
</a>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
<div id="mdbook-search-wrapper" class="hidden">
|
||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||
<div class="search-wrapper">
|
||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||
<div class="spinner-wrapper">
|
||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||
</div>
|
||
</div>
|
||
</form>
|
||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||
<ul id="mdbook-searchresults">
|
||
</ul>
|
||
</div>
|
||
</div>
|
||
|
||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||
<script>
|
||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||
});
|
||
</script>
|
||
|
||
<div id="mdbook-content" class="content">
|
||
<main>
|
||
<h1 id="list-room-api"><a class="header" href="#list-room-api">List Room API</a></h1>
|
||
<p>The List Room admin API allows server admins to get a list of rooms on their
|
||
server. There are various parameters available that allow for filtering and
|
||
sorting the returned list. This API supports pagination.</p>
|
||
<p>To use it, you will need to authenticate by providing an <code>access_token</code>
|
||
for a server admin: see <a href="../usage/administration/admin_api/">Admin API</a>.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following query parameters are available:</p>
|
||
<ul>
|
||
<li>
|
||
<p><code>from</code> - Offset in the returned list. Defaults to <code>0</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>limit</code> - Maximum amount of rooms to return. Defaults to <code>100</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>order_by</code> - The method in which to sort the returned list of rooms. Valid values are:</p>
|
||
<ul>
|
||
<li><code>alphabetical</code> - Same as <code>name</code>. This is deprecated.</li>
|
||
<li><code>size</code> - Same as <code>joined_members</code>. This is deprecated.</li>
|
||
<li><code>name</code> - Rooms are ordered alphabetically by room name. This is the default.</li>
|
||
<li><code>canonical_alias</code> - Rooms are ordered alphabetically by main alias address of the room.</li>
|
||
<li><code>joined_members</code> - Rooms are ordered by the number of members. Largest to smallest.</li>
|
||
<li><code>joined_local_members</code> - Rooms are ordered by the number of local members. Largest to smallest.</li>
|
||
<li><code>version</code> - Rooms are ordered by room version. Largest to smallest.</li>
|
||
<li><code>creator</code> - Rooms are ordered alphabetically by creator of the room.</li>
|
||
<li><code>encryption</code> - Rooms are ordered alphabetically by the end-to-end encryption algorithm.</li>
|
||
<li><code>federatable</code> - Rooms are ordered by whether the room is federatable.</li>
|
||
<li><code>public</code> - Rooms are ordered by visibility in room list.</li>
|
||
<li><code>join_rules</code> - Rooms are ordered alphabetically by join rules of the room.</li>
|
||
<li><code>guest_access</code> - Rooms are ordered alphabetically by guest access option of the room.</li>
|
||
<li><code>history_visibility</code> - Rooms are ordered alphabetically by visibility of history of the room.</li>
|
||
<li><code>state_events</code> - Rooms are ordered by number of state events. Largest to smallest.</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><code>dir</code> - Direction of room order. Either <code>f</code> for forwards or <code>b</code> for backwards. Setting
|
||
this value to <code>b</code> will reverse the above sort order. Defaults to <code>f</code>.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>search_term</code> - Filter rooms by their room name, canonical alias and room id.
|
||
Specifically, rooms are selected if the search term is contained in</p>
|
||
<ul>
|
||
<li>the room’s name,</li>
|
||
<li>the local part of the room’s canonical alias, or</li>
|
||
<li>the complete (local and server part) room’s id (case sensitive).</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><code>public_rooms</code> - Optional flag to filter public rooms. If <code>true</code>, only public rooms are queried. If <code>false</code>, public rooms are excluded from
|
||
the query. When the flag is absent (the default), <strong>both</strong> public and non-public rooms are included in the search results.</p>
|
||
</li>
|
||
<li>
|
||
<p><code>empty_rooms</code> - Optional flag to filter empty rooms. A room is empty if joined_members is zero. If <code>true</code>, only empty rooms are queried. If <code>false</code>, empty rooms are excluded from
|
||
the query. When the flag is absent (the default), <strong>both</strong> empty and non-empty rooms are included in the search results.</p>
|
||
<p>Defaults to no filtering.</p>
|
||
</li>
|
||
</ul>
|
||
<p><strong>Response</strong></p>
|
||
<p>The following fields are possible in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>rooms</code> - An array of objects, each containing information about a room.
|
||
<ul>
|
||
<li>Room objects contain the following fields:
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
<li><code>name</code> - The name of the room.</li>
|
||
<li><code>canonical_alias</code> - The canonical (main) alias address of the room.</li>
|
||
<li><code>joined_members</code> - How many users are currently in the room.</li>
|
||
<li><code>joined_local_members</code> - How many local users are currently in the room.</li>
|
||
<li><code>version</code> - The version of the room as a string.</li>
|
||
<li><code>creator</code> - The <code>user_id</code> of the room creator.</li>
|
||
<li><code>encryption</code> - Algorithm of end-to-end encryption of messages. Is <code>null</code> if encryption is not active.</li>
|
||
<li><code>federatable</code> - Whether users on other servers can join this room.</li>
|
||
<li><code>public</code> - Whether the room is visible in room directory.</li>
|
||
<li><code>join_rules</code> - The type of rules used for users wishing to join this room. One of: [“public”, “knock”, “invite”, “private”].</li>
|
||
<li><code>guest_access</code> - Whether guests can join the room. One of: [“can_join”, “forbidden”].</li>
|
||
<li><code>history_visibility</code> - Who can see the room history. One of: [“invited”, “joined”, “shared”, “world_readable”].</li>
|
||
<li><code>state_events</code> - Total number of state_events of a room. Complexity of the room.</li>
|
||
<li><code>room_type</code> - The type of the room taken from the room’s creation event; for example “m.space” if the room is a space. If the room does not define a type, the value will be <code>null</code>.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>offset</code> - The current pagination offset in rooms. This parameter should be
|
||
used instead of <code>next_token</code> for room offset as <code>next_token</code> is
|
||
not intended to be parsed.</li>
|
||
<li><code>total_rooms</code> - The total number of rooms this query can return. Using this
|
||
and <code>offset</code>, you have enough information to know the current
|
||
progression through the list.</li>
|
||
<li><code>next_batch</code> - If this field is present, we know that there are potentially
|
||
more rooms on the server that did not all fit into this response.
|
||
We can use <code>next_batch</code> to get the “next page” of results. To do
|
||
so, simply repeat your request, setting the <code>from</code> parameter to
|
||
the value of <code>next_batch</code>.</li>
|
||
<li><code>prev_batch</code> - If this field is present, it is possible to paginate backwards.
|
||
Use <code>prev_batch</code> for the <code>from</code> value in the next request to
|
||
get the “previous page” of results.</li>
|
||
</ul>
|
||
<p>The API is:</p>
|
||
<p>A standard request with no filtering:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"rooms": [
|
||
{
|
||
"room_id": "!OGEhHVWSdvArJzumhm:matrix.org",
|
||
"name": "Matrix HQ",
|
||
"canonical_alias": "#matrix:matrix.org",
|
||
"joined_members": 8326,
|
||
"joined_local_members": 2,
|
||
"version": "1",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": null,
|
||
"federatable": true,
|
||
"public": true,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 93534,
|
||
"room_type": "m.space"
|
||
},
|
||
... (8 hidden items) ...
|
||
{
|
||
"room_id": "!xYvNcQPhnkrdUmYczI:matrix.org",
|
||
"name": "This Week In Matrix (TWIM)",
|
||
"canonical_alias": "#twim:matrix.org",
|
||
"joined_members": 314,
|
||
"joined_local_members": 20,
|
||
"version": "4",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": "m.megolm.v1.aes-sha2",
|
||
"federatable": true,
|
||
"public": false,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 8345,
|
||
"room_type": null
|
||
}
|
||
],
|
||
"offset": 0,
|
||
"total_rooms": 10
|
||
}
|
||
</code></pre>
|
||
<p>Filtering by room name:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms?search_term=TWIM
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"rooms": [
|
||
{
|
||
"room_id": "!xYvNcQPhnkrdUmYczI:matrix.org",
|
||
"name": "This Week In Matrix (TWIM)",
|
||
"canonical_alias": "#twim:matrix.org",
|
||
"joined_members": 314,
|
||
"joined_local_members": 20,
|
||
"version": "4",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": "m.megolm.v1.aes-sha2",
|
||
"federatable": true,
|
||
"public": false,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 8,
|
||
"room_type": null
|
||
}
|
||
],
|
||
"offset": 0,
|
||
"total_rooms": 1
|
||
}
|
||
</code></pre>
|
||
<p>Paginating through a list of rooms:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms?order_by=size
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"rooms": [
|
||
{
|
||
"room_id": "!OGEhHVWSdvArJzumhm:matrix.org",
|
||
"name": "Matrix HQ",
|
||
"canonical_alias": "#matrix:matrix.org",
|
||
"joined_members": 8326,
|
||
"joined_local_members": 2,
|
||
"version": "1",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": null,
|
||
"federatable": true,
|
||
"public": true,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 93534,
|
||
"room_type": null
|
||
},
|
||
... (98 hidden items) ...
|
||
{
|
||
"room_id": "!xYvNcQPhnkrdUmYczI:matrix.org",
|
||
"name": "This Week In Matrix (TWIM)",
|
||
"canonical_alias": "#twim:matrix.org",
|
||
"joined_members": 314,
|
||
"joined_local_members": 20,
|
||
"version": "4",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": "m.megolm.v1.aes-sha2",
|
||
"federatable": true,
|
||
"public": false,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 8345,
|
||
"room_type": "m.space"
|
||
}
|
||
],
|
||
"offset": 0,
|
||
"total_rooms": 150,
|
||
"next_token": 100
|
||
}
|
||
</code></pre>
|
||
<p>The presence of the <code>next_token</code> parameter tells us that there are more rooms
|
||
than returned in this request, and we need to make another request to get them.
|
||
To get the next batch of room results, we repeat our request, setting the <code>from</code>
|
||
parameter to the value of <code>next_token</code>.</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms?order_by=size&from=100
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"rooms": [
|
||
{
|
||
"room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
|
||
"name": "Music Theory",
|
||
"canonical_alias": "#musictheory:matrix.org",
|
||
"joined_members": 127,
|
||
"joined_local_members": 2,
|
||
"version": "1",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": null,
|
||
"federatable": true,
|
||
"public": true,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 93534,
|
||
"room_type": "m.space"
|
||
|
||
},
|
||
... (48 hidden items) ...
|
||
{
|
||
"room_id": "!twcBhHVdZlQWuuxBhN:termina.org.uk",
|
||
"name": "weechat-matrix",
|
||
"canonical_alias": "#weechat-matrix:termina.org.uk",
|
||
"joined_members": 137,
|
||
"joined_local_members": 20,
|
||
"version": "4",
|
||
"creator": "@foo:termina.org.uk",
|
||
"encryption": null,
|
||
"federatable": true,
|
||
"public": true,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 8345,
|
||
"room_type": null
|
||
|
||
}
|
||
],
|
||
"offset": 100,
|
||
"prev_batch": 0,
|
||
"total_rooms": 150
|
||
}
|
||
</code></pre>
|
||
<p>Once the <code>next_token</code> parameter is no longer present, we know we’ve reached the
|
||
end of the list.</p>
|
||
<h1 id="room-details-api"><a class="header" href="#room-details-api">Room Details API</a></h1>
|
||
<p>The Room Details admin API allows server admins to get all details of a room.</p>
|
||
<p>The following fields are possible in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
<li><code>name</code> - The name of the room.</li>
|
||
<li><code>topic</code> - The topic of the room.</li>
|
||
<li><code>avatar</code> - The <code>mxc</code> URI to the avatar of the room.</li>
|
||
<li><code>canonical_alias</code> - The canonical (main) alias address of the room.</li>
|
||
<li><code>joined_members</code> - How many users are currently in the room.</li>
|
||
<li><code>joined_local_members</code> - How many local users are currently in the room.</li>
|
||
<li><code>joined_local_devices</code> - How many local devices are currently in the room.</li>
|
||
<li><code>version</code> - The version of the room as a string.</li>
|
||
<li><code>creator</code> - The <code>user_id</code> of the room creator.</li>
|
||
<li><code>encryption</code> - Algorithm of end-to-end encryption of messages. Is <code>null</code> if encryption is not active.</li>
|
||
<li><code>federatable</code> - Whether users on other servers can join this room.</li>
|
||
<li><code>public</code> - Whether the room is visible in room directory.</li>
|
||
<li><code>join_rules</code> - The type of rules used for users wishing to join this room. One of: [“public”, “knock”, “invite”, “private”].</li>
|
||
<li><code>guest_access</code> - Whether guests can join the room. One of: [“can_join”, “forbidden”].</li>
|
||
<li><code>history_visibility</code> - Who can see the room history. One of: [“invited”, “joined”, “shared”, “world_readable”].</li>
|
||
<li><code>state_events</code> - Total number of state_events of a room. Complexity of the room.</li>
|
||
<li><code>room_type</code> - The type of the room taken from the room’s creation event; for example “m.space” if the room is a space.
|
||
If the room does not define a type, the value will be <code>null</code>.</li>
|
||
<li><code>forgotten</code> - Whether all local users have
|
||
<a href="https://spec.matrix.org/latest/client-server-api/#leaving-rooms">forgotten</a> the room.</li>
|
||
</ul>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"room_id": "!mscvqgqpHYjBGDxNym:matrix.org",
|
||
"name": "Music Theory",
|
||
"avatar": "mxc://matrix.org/AQDaVFlbkQoErdOgqWRgiGSV",
|
||
"topic": "Theory, Composition, Notation, Analysis",
|
||
"canonical_alias": "#musictheory:matrix.org",
|
||
"joined_members": 127,
|
||
"joined_local_members": 2,
|
||
"joined_local_devices": 2,
|
||
"version": "1",
|
||
"creator": "@foo:matrix.org",
|
||
"encryption": null,
|
||
"federatable": true,
|
||
"public": true,
|
||
"join_rules": "invite",
|
||
"guest_access": null,
|
||
"history_visibility": "shared",
|
||
"state_events": 93534,
|
||
"room_type": "m.space",
|
||
"forgotten": false
|
||
}
|
||
</code></pre>
|
||
<p><em>Changed in Synapse 1.66:</em> Added the <code>forgotten</code> key to the response body.</p>
|
||
<h1 id="room-members-api"><a class="header" href="#room-members-api">Room Members API</a></h1>
|
||
<p>The Room Members admin API allows server admins to get a list of all members of a room.</p>
|
||
<p>The response includes the following fields:</p>
|
||
<ul>
|
||
<li><code>members</code> - A list of all the members that are present in the room, represented by their ids.</li>
|
||
<li><code>total</code> - Total number of members in the room.</li>
|
||
</ul>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>/members
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"members": [
|
||
"@foo:matrix.org",
|
||
"@bar:matrix.org",
|
||
"@foobar:matrix.org"
|
||
],
|
||
"total": 3
|
||
}
|
||
</code></pre>
|
||
<h1 id="room-state-api"><a class="header" href="#room-state-api">Room State API</a></h1>
|
||
<p>The Room State admin API allows server admins to get a list of all state events in a room.</p>
|
||
<p>The response includes the following fields:</p>
|
||
<ul>
|
||
<li><code>state</code> - The current state of the room at the time of request.</li>
|
||
</ul>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>/state
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following query parameter is available:</p>
|
||
<ul>
|
||
<li><code>type</code> - The type of room state event to filter by, eg “m.room.create”. If provided, only state events
|
||
of this type will be returned (regardless of their <code>state_key</code> value).</li>
|
||
</ul>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"state": [
|
||
{"type": "m.room.create", "state_key": "", "etc": true},
|
||
{"type": "m.room.power_levels", "state_key": "", "etc": true},
|
||
{"type": "m.room.name", "state_key": "", "etc": true}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<h1 id="room-messages-api"><a class="header" href="#room-messages-api">Room Messages API</a></h1>
|
||
<p>The Room Messages admin API allows server admins to get all messages
|
||
sent to a room in a given timeframe. There are various parameters available
|
||
that allow for filtering and ordering the returned list. This API supports pagination.</p>
|
||
<p>To use it, you will need to authenticate by providing an <code>access_token</code>
|
||
for a server admin: see <a href="../usage/administration/admin_api/">Admin API</a>.</p>
|
||
<p>This endpoint mirrors the <a href="https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidmessages">Matrix Spec defined Messages API</a>.</p>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>/messages
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following path parameters are required:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room you wish you fetch messages from.</li>
|
||
</ul>
|
||
<p>The following query parameters are available:</p>
|
||
<ul>
|
||
<li><code>from</code> (required) - The token to start returning events from. This token can be obtained from a prev_batch
|
||
or next_batch token returned by the /sync endpoint, or from an end token returned by a previous request to this endpoint.</li>
|
||
<li><code>to</code> - The token to stop returning events at.</li>
|
||
<li><code>limit</code> - The maximum number of events to return. Defaults to <code>10</code>.</li>
|
||
<li><code>filter</code> - A JSON RoomEventFilter to filter returned events with.</li>
|
||
<li><code>dir</code> - The direction to return events from. Either <code>f</code> for forwards or <code>b</code> for backwards. Setting
|
||
this value to <code>b</code> will reverse the above sort order. Defaults to <code>f</code>.</li>
|
||
</ul>
|
||
<p><strong>Response</strong></p>
|
||
<p>The following fields are possible in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>chunk</code> - A list of room events. The order depends on the dir parameter.
|
||
Note that an empty chunk does not necessarily imply that no more events are available. Clients should continue to paginate until no end property is returned.</li>
|
||
<li><code>end</code> - A token corresponding to the end of chunk. This token can be passed back to this endpoint to request further events.
|
||
If no further events are available, this property is omitted from the response.</li>
|
||
<li><code>start</code> - A token corresponding to the start of chunk.</li>
|
||
<li><code>state</code> - A list of state events relevant to showing the chunk.</li>
|
||
</ul>
|
||
<p><strong>Example</strong></p>
|
||
<p>For more details on each chunk, read <a href="https://spec.matrix.org/v1.1/client-server-api/#get_matrixclientv3roomsroomidmessages">the Matrix specification</a>.</p>
|
||
<pre><code class="language-json">{
|
||
"chunk": [
|
||
{
|
||
"content": {
|
||
"body": "This is an example text message",
|
||
"format": "org.matrix.custom.html",
|
||
"formatted_body": "<b>This is an example text message</b>",
|
||
"msgtype": "m.text"
|
||
},
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"type": "m.room.message",
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
},
|
||
{
|
||
"content": {
|
||
"name": "The room name"
|
||
},
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"state_key": "",
|
||
"type": "m.room.name",
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
},
|
||
{
|
||
"content": {
|
||
"body": "Gangnam Style",
|
||
"info": {
|
||
"duration": 2140786,
|
||
"h": 320,
|
||
"mimetype": "video/mp4",
|
||
"size": 1563685,
|
||
"thumbnail_info": {
|
||
"h": 300,
|
||
"mimetype": "image/jpeg",
|
||
"size": 46144,
|
||
"w": 300
|
||
},
|
||
"thumbnail_url": "mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe",
|
||
"w": 480
|
||
},
|
||
"msgtype": "m.video",
|
||
"url": "mxc://example.org/a526eYUSFFxlgbQYZmo442"
|
||
},
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"type": "m.room.message",
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
}
|
||
],
|
||
"end": "t47409-4357353_219380_26003_2265",
|
||
"start": "t47429-4392820_219380_26003_2265"
|
||
}
|
||
</code></pre>
|
||
<h1 id="room-timestamp-to-event-api"><a class="header" href="#room-timestamp-to-event-api">Room Timestamp to Event API</a></h1>
|
||
<p>The Room Timestamp to Event API endpoint fetches the <code>event_id</code> of the closest event to the given
|
||
timestamp (<code>ts</code> query parameter) in the given direction (<code>dir</code> query parameter).</p>
|
||
<p>Useful for cases like jump to date so you can start paginating messages from
|
||
a given date in the archive.</p>
|
||
<p>The API is:</p>
|
||
<pre><code> GET /_synapse/admin/v1/rooms/<room_id>/timestamp_to_event
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following path parameters are required:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room you wish to check.</li>
|
||
</ul>
|
||
<p>The following query parameters are available:</p>
|
||
<ul>
|
||
<li><code>ts</code> - a timestamp in milliseconds where we will find the closest event in
|
||
the given direction.</li>
|
||
<li><code>dir</code> - can be <code>f</code> or <code>b</code> to indicate forwards and backwards in time from the
|
||
given timestamp. Defaults to <code>f</code>.</li>
|
||
</ul>
|
||
<p><strong>Response</strong></p>
|
||
<ul>
|
||
<li><code>event_id</code> - The event ID closest to the given timestamp.</li>
|
||
<li><code>origin_server_ts</code> - The timestamp of the event in milliseconds since the Unix epoch.</li>
|
||
</ul>
|
||
<h1 id="block-room-api"><a class="header" href="#block-room-api">Block Room API</a></h1>
|
||
<p>The Block Room admin API allows server admins to block and unblock rooms,
|
||
and query to see if a given room is blocked.
|
||
This API can be used to pre-emptively block a room, even if it’s unknown to this
|
||
homeserver. Users will be prevented from joining a blocked room.</p>
|
||
<h2 id="block-or-unblock-a-room"><a class="header" href="#block-or-unblock-a-room">Block or unblock a room</a></h2>
|
||
<p>The API is:</p>
|
||
<pre><code>PUT /_synapse/admin/v1/rooms/<room_id>/block
|
||
</code></pre>
|
||
<p>with a body of:</p>
|
||
<pre><code class="language-json">{
|
||
"block": true
|
||
}
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"block": true
|
||
}
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following parameters should be set in the URL:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
</ul>
|
||
<p>The following JSON body parameters are available:</p>
|
||
<ul>
|
||
<li><code>block</code> - If <code>true</code> the room will be blocked and if <code>false</code> the room will be unblocked.</li>
|
||
</ul>
|
||
<p><strong>Response</strong></p>
|
||
<p>The following fields are possible in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>block</code> - A boolean. <code>true</code> if the room is blocked, otherwise <code>false</code></li>
|
||
</ul>
|
||
<h2 id="get-block-status"><a class="header" href="#get-block-status">Get block status</a></h2>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>/block
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"block": true,
|
||
"user_id": "<user_id>"
|
||
}
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following parameters should be set in the URL:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
</ul>
|
||
<p><strong>Response</strong></p>
|
||
<p>The following fields are possible in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>block</code> - A boolean. <code>true</code> if the room is blocked, otherwise <code>false</code></li>
|
||
<li><code>user_id</code> - An optional string. If the room is blocked (<code>block</code> is <code>true</code>) shows
|
||
the user who has add the room to blocking list. Otherwise it is not displayed.</li>
|
||
</ul>
|
||
<h1 id="delete-room-api"><a class="header" href="#delete-room-api">Delete Room API</a></h1>
|
||
<p>The Delete Room admin API allows server admins to remove rooms from the server
|
||
and block these rooms.</p>
|
||
<p>Shuts down a room. Moves all local users and room aliases automatically to a
|
||
new room if <code>new_room_user_id</code> is set. Otherwise local users only
|
||
leave the room without any information.</p>
|
||
<p>The new room will be created with the user specified by the <code>new_room_user_id</code> parameter
|
||
as room administrator and will contain a message explaining what happened. Users invited
|
||
to the new room will have power level <code>-10</code> by default, and thus be unable to speak.</p>
|
||
<p>If <code>block</code> is <code>true</code>, users will be prevented from joining the old room.
|
||
This option can in <a href="#version-1-old-version">Version 1</a> also be used to pre-emptively
|
||
block a room, even if it’s unknown to this homeserver. In this case, the room will be
|
||
blocked, and no further action will be taken. If <code>block</code> is <code>false</code>, attempting to
|
||
delete an unknown room is invalid and will be rejected as a bad request.</p>
|
||
<p>This API will remove all trace of the old room from your database after removing
|
||
all local users. If <code>purge</code> is <code>true</code> (the default), all traces of the old room will
|
||
be removed from your database after removing all local users. If you do not want
|
||
this to happen, set <code>purge</code> to <code>false</code>.
|
||
Depending on the amount of history being purged, a call to the API may take
|
||
several minutes or longer.</p>
|
||
<p>The local server will only have the power to move local user and room aliases to
|
||
the new room. Users on other servers will be unaffected.</p>
|
||
<h2 id="version-1-old-version"><a class="header" href="#version-1-old-version">Version 1 (old version)</a></h2>
|
||
<p>This version works synchronously. That means you only get the response once the server has
|
||
finished the action, which may take a long time. If you request the same action
|
||
a second time, and the server has not finished the first one, the second request will block.
|
||
This is fixed in version 2 of this API. The parameters are the same in both APIs.
|
||
This API will become deprecated in the future.</p>
|
||
<p>The API is:</p>
|
||
<pre><code>DELETE /_synapse/admin/v1/rooms/<room_id>
|
||
</code></pre>
|
||
<p>with a body of:</p>
|
||
<pre><code class="language-json">{
|
||
"new_room_user_id": "@someuser:example.com",
|
||
"room_name": "Content Violation Notification",
|
||
"message": "Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.",
|
||
"block": true,
|
||
"purge": true
|
||
}
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"kicked_users": [
|
||
"@foobar:example.com"
|
||
],
|
||
"failed_to_kick_users": [],
|
||
"local_aliases": [
|
||
"#badroom:example.com",
|
||
"#evilsaloon:example.com"
|
||
],
|
||
"new_room_id": "!newroomid:example.com"
|
||
}
|
||
</code></pre>
|
||
<p>The parameters and response values have the same format as
|
||
<a href="#version-2-new-version">version 2</a> of the API.</p>
|
||
<h2 id="version-2-new-version"><a class="header" href="#version-2-new-version">Version 2 (new version)</a></h2>
|
||
<p><strong>Note</strong>: This API is new, experimental and “subject to change”.</p>
|
||
<p>This version works asynchronously, meaning you get the response from server immediately
|
||
while the server works on that task in background. You can then request the status of the action
|
||
to check if it has completed.</p>
|
||
<p>The API is:</p>
|
||
<pre><code>DELETE /_synapse/admin/v2/rooms/<room_id>
|
||
</code></pre>
|
||
<p>with a body of:</p>
|
||
<pre><code class="language-json">{
|
||
"new_room_user_id": "@someuser:example.com",
|
||
"room_name": "Content Violation Notification",
|
||
"message": "Bad Room has been shutdown due to content violations on this server. Please review our Terms of Service.",
|
||
"block": true,
|
||
"purge": true
|
||
}
|
||
</code></pre>
|
||
<p>The API starts the shut down and purge running, and returns immediately with a JSON body with
|
||
a purge id:</p>
|
||
<pre><code class="language-json">{
|
||
"delete_id": "<opaque id>"
|
||
}
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following parameters should be set in the URL:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
</ul>
|
||
<p>The following JSON body parameters are available:</p>
|
||
<ul>
|
||
<li><code>new_room_user_id</code> - Optional. If set, a new room will be created with this user ID
|
||
as the creator and admin, and all users in the old room will be moved into that
|
||
room. If not set, no new room will be created and the users will just be removed
|
||
from the old room. The user ID must be on the local server, but does not necessarily
|
||
have to belong to a registered user.</li>
|
||
<li><code>room_name</code> - Optional. A string representing the name of the room that new users will be
|
||
invited to. Defaults to <code>Content Violation Notification</code></li>
|
||
<li><code>message</code> - Optional. A string containing the first message that will be sent as
|
||
<code>new_room_user_id</code> in the new room. Ideally this will clearly convey why the
|
||
original room was shut down. Defaults to <code>Sharing illegal content on this server is not permitted and rooms in violation will be blocked.</code></li>
|
||
<li><code>block</code> - Optional. If set to <code>true</code>, this room will be added to a blocking list,
|
||
preventing future attempts to join the room. Rooms can be blocked
|
||
even if they’re not yet known to the homeserver (only with
|
||
<a href="#version-1-old-version">Version 1</a> of the API). Defaults to <code>false</code>.</li>
|
||
<li><code>purge</code> - Optional. If set to <code>true</code>, it will remove all traces of the room from your database.
|
||
Defaults to <code>true</code>.</li>
|
||
<li><code>force_purge</code> - Optional, and ignored unless <code>purge</code> is <code>true</code>. If set to <code>true</code>, it
|
||
will force a purge to go ahead even if there are local users still in the room. Do not
|
||
use this unless a regular <code>purge</code> operation fails, as it could leave those users’
|
||
clients in a confused state.</li>
|
||
</ul>
|
||
<p>The JSON body must not be empty. The body must be at least <code>{}</code>.</p>
|
||
<h2 id="status-of-deleting-rooms"><a class="header" href="#status-of-deleting-rooms">Status of deleting rooms</a></h2>
|
||
<p><strong>Note</strong>: This API is new, experimental and “subject to change”.</p>
|
||
<p>It is possible to query the status of the background task for deleting rooms.
|
||
The status can be queried up to 24 hours after completion of the task,
|
||
or until Synapse is restarted (whichever happens first).</p>
|
||
<h3 id="query-by-room_id"><a class="header" href="#query-by-room_id">Query by <code>room_id</code></a></h3>
|
||
<p>With this API you can get the status of all active deletion tasks, and all those completed in the last 24h,
|
||
for the given <code>room_id</code>.</p>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v2/rooms/<room_id>/delete_status
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"results": [
|
||
{
|
||
"delete_id": "delete_id1",
|
||
"room_id": "!roomid:example.com",
|
||
"status": "failed",
|
||
"error": "error message",
|
||
"shutdown_room": {
|
||
"kicked_users": [],
|
||
"failed_to_kick_users": [],
|
||
"local_aliases": [],
|
||
"new_room_id": null
|
||
}
|
||
}, {
|
||
"delete_id": "delete_id2",
|
||
"room_id": "!roomid:example.com",
|
||
"status": "active",
|
||
"shutdown_room": {
|
||
"kicked_users": [
|
||
"@foobar:example.com"
|
||
],
|
||
"failed_to_kick_users": [],
|
||
"local_aliases": [
|
||
"#badroom:example.com",
|
||
"#evilsaloon:example.com"
|
||
],
|
||
"new_room_id": "!newroomid:example.com"
|
||
}
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following parameters should be set in the URL:</p>
|
||
<ul>
|
||
<li><code>room_id</code> - The ID of the room.</li>
|
||
</ul>
|
||
<h3 id="query-by-delete_id"><a class="header" href="#query-by-delete_id">Query by <code>delete_id</code></a></h3>
|
||
<p>With this API you can get the status of one specific task by <code>delete_id</code>.</p>
|
||
<p>The API is:</p>
|
||
<pre><code>GET /_synapse/admin/v2/rooms/delete_status/<delete_id>
|
||
</code></pre>
|
||
<p>A response body like the following is returned:</p>
|
||
<pre><code class="language-json">{
|
||
"status": "active",
|
||
"delete_id": "bHkCNQpHqOaFhPtK",
|
||
"room_id": "!roomid:example.com",
|
||
"shutdown_room": {
|
||
"kicked_users": [
|
||
"@foobar:example.com"
|
||
],
|
||
"failed_to_kick_users": [],
|
||
"local_aliases": [
|
||
"#badroom:example.com",
|
||
"#evilsaloon:example.com"
|
||
],
|
||
"new_room_id": "!newroomid:example.com"
|
||
}
|
||
}
|
||
</code></pre>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following parameters should be set in the URL:</p>
|
||
<ul>
|
||
<li><code>delete_id</code> - The ID for this delete.</li>
|
||
</ul>
|
||
<h3 id="response"><a class="header" href="#response">Response</a></h3>
|
||
<p>The following fields are returned in the JSON response body:</p>
|
||
<ul>
|
||
<li><code>results</code> - An array of objects, each containing information about one task.
|
||
This field is omitted from the result when you query by <code>delete_id</code>.
|
||
Task objects contain the following fields:
|
||
<ul>
|
||
<li><code>delete_id</code> - The ID for this purge</li>
|
||
<li><code>room_id</code> - The ID of the room being deleted</li>
|
||
<li><code>status</code> - The status will be one of:
|
||
<ul>
|
||
<li><code>scheduled</code> - The deletion is waiting to be started</li>
|
||
<li><code>active</code> - The process is purging the room and event data from database.</li>
|
||
<li><code>complete</code> - The process has completed successfully.</li>
|
||
<li><code>failed</code> - The process is aborted, an error has occurred.</li>
|
||
</ul>
|
||
</li>
|
||
<li><code>error</code> - A string that shows an error message if <code>status</code> is <code>failed</code>.
|
||
Otherwise this field is hidden.</li>
|
||
<li><code>shutdown_room</code> - An object containing information about the result of shutting down the room.
|
||
<em>Note:</em> The result is shown after removing the room members.
|
||
The delete process can still be running. Please pay attention to the <code>status</code>.
|
||
<ul>
|
||
<li><code>kicked_users</code> - An array of users (<code>user_id</code>) that were kicked.</li>
|
||
<li><code>failed_to_kick_users</code> - An array of users (<code>user_id</code>) that that were not kicked.</li>
|
||
<li><code>local_aliases</code> - An array of strings representing the local aliases that were
|
||
migrated from the old room to the new.</li>
|
||
<li><code>new_room_id</code> - A string representing the room ID of the new room, or <code>null</code> if
|
||
no such room was created.</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
<h2 id="undoing-room-deletions"><a class="header" href="#undoing-room-deletions">Undoing room deletions</a></h2>
|
||
<p><em>Note</em>: This guide may be outdated by the time you read it. By nature of room deletions being performed at the database level,
|
||
the structure can and does change without notice.</p>
|
||
<p>First, it’s important to understand that a room deletion is very destructive. Undoing a deletion is not as simple as pretending it
|
||
never happened - work has to be done to move forward instead of resetting the past. In fact, in some cases it might not be possible
|
||
to recover at all:</p>
|
||
<ul>
|
||
<li>If the room was invite-only, your users will need to be re-invited.</li>
|
||
<li>If the room no longer has any members at all, it’ll be impossible to rejoin.</li>
|
||
<li>The first user to rejoin will have to do so via an alias on a different
|
||
server (or receive an invite from a user on a different server).</li>
|
||
</ul>
|
||
<p>With all that being said, if you still want to try and recover the room:</p>
|
||
<ol>
|
||
<li>
|
||
<p>If the room was <code>block</code>ed, you must unblock it on your server. This can be
|
||
accomplished as follows:</p>
|
||
<ol>
|
||
<li>For safety reasons, shut down Synapse.</li>
|
||
<li>In the database, run <code>DELETE FROM blocked_rooms WHERE room_id = '!example:example.org';</code>
|
||
<ul>
|
||
<li>For caution: it’s recommended to run this in a transaction: <code>BEGIN; DELETE ...;</code>, verify you got 1 result, then <code>COMMIT;</code>.</li>
|
||
<li>The room ID is the same one supplied to the delete room API, not the Content Violation room.</li>
|
||
</ul>
|
||
</li>
|
||
<li>Restart Synapse.</li>
|
||
</ol>
|
||
<p>This step is unnecessary if <code>block</code> was not set.</p>
|
||
</li>
|
||
<li>
|
||
<p>Any room aliases on your server that pointed to the deleted room may have
|
||
been deleted, or redirected to the Content Violation room. These will need
|
||
to be restored manually.</p>
|
||
</li>
|
||
<li>
|
||
<p>Users on your server that were in the deleted room will have been kicked
|
||
from the room. Consider whether you want to update their membership
|
||
(possibly via the <a href="room_membership.html">Edit Room Membership API</a>) or let
|
||
them handle rejoining themselves.</p>
|
||
</li>
|
||
<li>
|
||
<p>If <code>new_room_user_id</code> was given, a ‘Content Violation’ will have been
|
||
created. Consider whether you want to delete that room.</p>
|
||
</li>
|
||
</ol>
|
||
<h1 id="make-room-admin-api"><a class="header" href="#make-room-admin-api">Make Room Admin API</a></h1>
|
||
<p>Grants another user the highest power available to a local user who is in the room.
|
||
If the user is not in the room, and it is not publicly joinable, then invite the user.</p>
|
||
<p>By default the server admin (the caller) is granted power, but another user can
|
||
optionally be specified, e.g.:</p>
|
||
<pre><code>POST /_synapse/admin/v1/rooms/<room_id_or_alias>/make_room_admin
|
||
{
|
||
"user_id": "@foo:example.com"
|
||
}
|
||
</code></pre>
|
||
<h1 id="forward-extremities-admin-api"><a class="header" href="#forward-extremities-admin-api">Forward Extremities Admin API</a></h1>
|
||
<p>Enables querying and deleting forward extremities from rooms. When a lot of forward
|
||
extremities accumulate in a room, performance can become degraded. For details, see
|
||
<a href="https://github.com/matrix-org/synapse/issues/1760">#1760</a>.</p>
|
||
<h2 id="check-for-forward-extremities"><a class="header" href="#check-for-forward-extremities">Check for forward extremities</a></h2>
|
||
<p>To check the status of forward extremities for a room:</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
|
||
</code></pre>
|
||
<p>A response as follows will be returned:</p>
|
||
<pre><code class="language-json">{
|
||
"count": 1,
|
||
"results": [
|
||
{
|
||
"event_id": "$M5SP266vsnxctfwFgFLNceaCo3ujhRtg_NiiHabcdefgh",
|
||
"state_group": 439,
|
||
"depth": 123,
|
||
"received_ts": 1611263016761
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<h2 id="deleting-forward-extremities"><a class="header" href="#deleting-forward-extremities">Deleting forward extremities</a></h2>
|
||
<p><strong>WARNING</strong>: Please ensure you know what you’re doing and have read
|
||
the related issue <a href="https://github.com/matrix-org/synapse/issues/1760">#1760</a>.
|
||
Under no situations should this API be executed as an automated maintenance task!</p>
|
||
<p>If a room has lots of forward extremities, the extra can be
|
||
deleted as follows:</p>
|
||
<pre><code>DELETE /_synapse/admin/v1/rooms/<room_id_or_alias>/forward_extremities
|
||
</code></pre>
|
||
<p>A response as follows will be returned, indicating the amount of forward extremities
|
||
that were deleted.</p>
|
||
<pre><code class="language-json">{
|
||
"deleted": 1
|
||
}
|
||
</code></pre>
|
||
<h1 id="event-context-api"><a class="header" href="#event-context-api">Event Context API</a></h1>
|
||
<p>This API lets a client find the context of an event. This is designed primarily to investigate abuse reports.</p>
|
||
<pre><code>GET /_synapse/admin/v1/rooms/<room_id>/context/<event_id>
|
||
</code></pre>
|
||
<p>This API mimmicks <a href="https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-rooms-roomid-context-eventid">GET /_matrix/client/r0/rooms/{roomId}/context/{eventId}</a>. Please refer to the link for all details on parameters and reseponse.</p>
|
||
<p>Example response:</p>
|
||
<pre><code class="language-json">{
|
||
"end": "t29-57_2_0_2",
|
||
"events_after": [
|
||
{
|
||
"content": {
|
||
"body": "This is an example text message",
|
||
"msgtype": "m.text",
|
||
"format": "org.matrix.custom.html",
|
||
"formatted_body": "<b>This is an example text message</b>"
|
||
},
|
||
"type": "m.room.message",
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
}
|
||
],
|
||
"event": {
|
||
"content": {
|
||
"body": "filename.jpg",
|
||
"info": {
|
||
"h": 398,
|
||
"w": 394,
|
||
"mimetype": "image/jpeg",
|
||
"size": 31037
|
||
},
|
||
"url": "mxc://example.org/JWEIFJgwEIhweiWJE",
|
||
"msgtype": "m.image"
|
||
},
|
||
"type": "m.room.message",
|
||
"event_id": "$f3h4d129462ha:example.com",
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
},
|
||
"events_before": [
|
||
{
|
||
"content": {
|
||
"body": "something-important.doc",
|
||
"filename": "something-important.doc",
|
||
"info": {
|
||
"mimetype": "application/msword",
|
||
"size": 46144
|
||
},
|
||
"msgtype": "m.file",
|
||
"url": "mxc://example.org/FHyPlCeYUSFFxlgbQYZmoEoe"
|
||
},
|
||
"type": "m.room.message",
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"unsigned": {
|
||
"age": 1234
|
||
}
|
||
}
|
||
],
|
||
"start": "t27-54_2_0_2",
|
||
"state": [
|
||
{
|
||
"content": {
|
||
"creator": "@example:example.org",
|
||
"room_version": "1",
|
||
"m.federate": true,
|
||
"predecessor": {
|
||
"event_id": "$something:example.org",
|
||
"room_id": "!oldroom:example.org"
|
||
}
|
||
},
|
||
"type": "m.room.create",
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"unsigned": {
|
||
"age": 1234
|
||
},
|
||
"state_key": ""
|
||
},
|
||
{
|
||
"content": {
|
||
"membership": "join",
|
||
"avatar_url": "mxc://example.org/SEsfnsuifSDFSSEF",
|
||
"displayname": "Alice Margatroid"
|
||
},
|
||
"type": "m.room.member",
|
||
"event_id": "$143273582443PhrSn:example.org",
|
||
"room_id": "!636q39766251:example.com",
|
||
"sender": "@example:example.org",
|
||
"origin_server_ts": 1432735824653,
|
||
"unsigned": {
|
||
"age": 1234
|
||
},
|
||
"state_key": "@alice:example.org"
|
||
}
|
||
]
|
||
}
|
||
</code></pre>
|
||
<h1 id="admin-space-hierarchy-endpoint"><a class="header" href="#admin-space-hierarchy-endpoint">Admin Space Hierarchy Endpoint</a></h1>
|
||
<p>This API allows an admin to fetch the space/room hierarchy for a given space,
|
||
returning details about that room and any children the room may have, paginating
|
||
over the space tree in a depth-first manner to locate child rooms. This is
|
||
functionally similar to the <a href="https://spec.matrix.org/v1.16/client-server-api/#get_matrixclientv1roomsroomidhierarchy">CS Hierarchy</a> endpoint but does not check for
|
||
room membership when returning room summaries.</p>
|
||
<p>The endpoint does not query other servers over federation about remote rooms
|
||
that the server has not joined. This is a deliberate trade-off: while this
|
||
means it will leave some holes in the hierarchy that we could otherwise
|
||
sometimes fill in, it significantly improves the endpoint’s response time and
|
||
the admin endpoint is designed for managing rooms local to the homeserver
|
||
anyway.</p>
|
||
<p><strong>Parameters</strong></p>
|
||
<p>The following query parameters are available:</p>
|
||
<ul>
|
||
<li><code>from</code> - An optional pagination token, provided when there are more rooms to
|
||
return than the limit.</li>
|
||
<li><code>limit</code> - Maximum amount of rooms to return. Must be a non-negative integer,
|
||
defaults to <code>50</code>.</li>
|
||
<li><code>max_depth</code> - The maximum depth in the tree to explore, must be a non-negative
|
||
integer. 0 would correspond to just the root room, 1 would include just the
|
||
root room’s children, etc. If not provided will recurse into the space tree without limit.</li>
|
||
</ul>
|
||
<p>Request:</p>
|
||
<pre><code class="language-http">GET /_synapse/admin/v1/rooms/<room_id>/hierarchy
|
||
</code></pre>
|
||
<p>Response:</p>
|
||
<pre><code class="language-json">{
|
||
"rooms":
|
||
[
|
||
{ "children_state": [
|
||
{
|
||
"content": {
|
||
"via": ["local_test_server"]
|
||
},
|
||
"origin_server_ts": 1500,
|
||
"sender": "@user:test",
|
||
"state_key": "!QrMkkqBSwYRIFNFCso:test",
|
||
"type": "m.space.child"
|
||
}
|
||
],
|
||
"name": "space room",
|
||
"guest_can_join": false,
|
||
"join_rule": "public",
|
||
"num_joined_members": 1,
|
||
"room_id": "!sPOpNyMHbZAoAOsOFL:test",
|
||
"room_type": "m.space",
|
||
"world_readable": false
|
||
},
|
||
|
||
{
|
||
"children_state": [],
|
||
"guest_can_join": true,
|
||
"join_rule": "invite",
|
||
"name": "nefarious",
|
||
"num_joined_members": 1,
|
||
"room_id": "!QrMkkqBSwYRIFNFCso:test",
|
||
"topic": "being bad",
|
||
"world_readable": false}
|
||
],
|
||
"next_batch": "KUYmRbeSpAoaAIgOKGgyaCEn"
|
||
}
|
||
</code></pre>
|
||
|
||
</main>
|
||
|
||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||
<!-- Mobile navigation buttons -->
|
||
<a rel="prev" href="../admin_api/room_membership.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="../admin_api/scheduled_tasks.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<div style="clear: both"></div>
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
|
||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||
<a rel="prev" href="../admin_api/room_membership.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||
</a>
|
||
|
||
<a rel="next prefetch" href="../admin_api/scheduled_tasks.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||
</a>
|
||
</nav>
|
||
|
||
</div>
|
||
|
||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||
|
||
|
||
|
||
<script>
|
||
window.playground_copyable = true;
|
||
</script>
|
||
|
||
|
||
<script src="../elasticlunr-ef4e11c1.min.js"></script>
|
||
<script src="../mark-09e88c2c.min.js"></script>
|
||
<script src="../searcher-c2a407aa.js"></script>
|
||
|
||
<script src="../clipboard-1626706a.min.js"></script>
|
||
<script src="../highlight-abc7f01d.js"></script>
|
||
<script src="../book-a0b12cfe.js"></script>
|
||
|
||
<!-- Custom JS scripts -->
|
||
<script src="../docs/website_files/version-picker-a1e40922.js"></script>
|
||
<script src="../docs/website_files/version-d2c738f4.js"></script>
|
||
|
||
|
||
|
||
</div>
|
||
</body>
|
||
</html>
|