third_party_rules_callbacks.html 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424
  1. <!DOCTYPE HTML>
  2. <html lang="en" class="sidebar-visible no-js light">
  3. <head>
  4. <!-- Book generated using mdBook -->
  5. <meta charset="UTF-8">
  6. <title>Third-party rules callbacks - Synapse</title>
  7. <!-- Custom HTML head -->
  8. <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
  9. <meta name="description" content="">
  10. <meta name="viewport" content="width=device-width, initial-scale=1">
  11. <meta name="theme-color" content="#ffffff" />
  12. <link rel="icon" href="../favicon.svg">
  13. <link rel="shortcut icon" href="../favicon.png">
  14. <link rel="stylesheet" href="../css/variables.css">
  15. <link rel="stylesheet" href="../css/general.css">
  16. <link rel="stylesheet" href="../css/chrome.css">
  17. <link rel="stylesheet" href="../css/print.css" media="print">
  18. <!-- Fonts -->
  19. <link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
  20. <link rel="stylesheet" href="../fonts/fonts.css">
  21. <!-- Highlight.js Stylesheets -->
  22. <link rel="stylesheet" href="../highlight.css">
  23. <link rel="stylesheet" href="../tomorrow-night.css">
  24. <link rel="stylesheet" href="../ayu-highlight.css">
  25. <!-- Custom theme stylesheets -->
  26. <link rel="stylesheet" href="../docs/website_files/table-of-contents.css">
  27. <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css">
  28. <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css">
  29. <link rel="stylesheet" href="../docs/website_files/version-picker.css">
  30. </head>
  31. <body>
  32. <!-- Provide site root to javascript -->
  33. <script type="text/javascript">
  34. var path_to_root = "../";
  35. var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
  36. </script>
  37. <!-- Work around some values being stored in localStorage wrapped in quotes -->
  38. <script type="text/javascript">
  39. try {
  40. var theme = localStorage.getItem('mdbook-theme');
  41. var sidebar = localStorage.getItem('mdbook-sidebar');
  42. if (theme.startsWith('"') && theme.endsWith('"')) {
  43. localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
  44. }
  45. if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
  46. localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
  47. }
  48. } catch (e) { }
  49. </script>
  50. <!-- Set the theme before any content is loaded, prevents flash -->
  51. <script type="text/javascript">
  52. var theme;
  53. try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
  54. if (theme === null || theme === undefined) { theme = default_theme; }
  55. var html = document.querySelector('html');
  56. html.classList.remove('no-js')
  57. html.classList.remove('light')
  58. html.classList.add(theme);
  59. html.classList.add('js');
  60. </script>
  61. <!-- Hide / unhide sidebar before it is displayed -->
  62. <script type="text/javascript">
  63. var html = document.querySelector('html');
  64. var sidebar = 'hidden';
  65. if (document.body.clientWidth >= 1080) {
  66. try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
  67. sidebar = sidebar || 'visible';
  68. }
  69. html.classList.remove('sidebar-visible');
  70. html.classList.add("sidebar-" + sidebar);
  71. </script>
  72. <nav id="sidebar" class="sidebar" aria-label="Table of contents">
  73. <div class="sidebar-scrollbox">
  74. <ol class="chapter"><li class="chapter-item expanded affix "><li class="part-title">Introduction</li><li class="chapter-item expanded "><a href="../welcome_and_overview.html">Welcome and Overview</a></li><li class="chapter-item expanded affix "><li class="part-title">Setup</li><li class="chapter-item expanded "><a href="../setup/installation.html">Installation</a></li><li class="chapter-item expanded "><a href="../postgres.html">Using Postgres</a></li><li class="chapter-item expanded "><a href="../reverse_proxy.html">Configuring a Reverse Proxy</a></li><li class="chapter-item expanded "><a href="../setup/forward_proxy.html">Configuring a Forward/Outbound Proxy</a></li><li class="chapter-item expanded "><a href="../turn-howto.html">Configuring a Turn Server</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../setup/turn/coturn.html">coturn TURN server</a></li><li class="chapter-item expanded "><a href="../setup/turn/eturnal.html">eturnal TURN server</a></li></ol></li><li class="chapter-item expanded "><a href="../delegate.html">Delegation</a></li><li class="chapter-item expanded affix "><li class="part-title">Upgrading</li><li class="chapter-item expanded "><a href="../upgrade.html">Upgrading between Synapse Versions</a></li><li class="chapter-item expanded affix "><li class="part-title">Usage</li><li class="chapter-item expanded "><a href="../federate.html">Federation</a></li><li class="chapter-item expanded "><a href="../usage/configuration/index.html">Configuration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/config_documentation.html">Configuration Manual</a></li><li class="chapter-item expanded "><a href="../usage/configuration/homeserver_sample_config.html">Homeserver Sample Config File</a></li><li class="chapter-item expanded "><a href="../usage/configuration/logging_sample_config.html">Logging Sample Config File</a></li><li class="chapter-item expanded "><a href="../structured_logging.html">Structured Logging</a></li><li class="chapter-item expanded "><a href="../templates.html">Templates</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/index.html">User Authentication</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/index.html">Single-Sign On</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../openid.html">OpenID Connect</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/single_sign_on/cas.html">CAS</a></li><li class="chapter-item expanded "><a href="../sso_mapping_providers.html">SSO Mapping Providers</a></li></ol></li><li class="chapter-item expanded "><a href="../password_auth_providers.html">Password Auth Providers</a></li><li class="chapter-item expanded "><a href="../jwt.html">JSON Web Tokens</a></li><li class="chapter-item expanded "><a href="../usage/configuration/user_authentication/refresh_tokens.html">Refresh Tokens</a></li></ol></li><li class="chapter-item expanded "><a href="../CAPTCHA_SETUP.html">Registration Captcha</a></li><li class="chapter-item expanded "><a href="../application_services.html">Application Services</a></li><li class="chapter-item expanded "><a href="../server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../consent_tracking.html">Consent Tracking</a></li><li class="chapter-item expanded "><a href="../user_directory.html">User Directory</a></li><li class="chapter-item expanded "><a href="../message_retention_policies.html">Message Retention Policies</a></li><li class="chapter-item expanded "><a href="../modules/index.html">Pluggable Modules</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../modules/writing_a_module.html">Writing a module</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../modules/spam_checker_callbacks.html">Spam checker callbacks</a></li><li class="chapter-item expanded "><a href="../modules/third_party_rules_callbacks.html" class="active">Third-party rules callbacks</a></li><li class="chapter-item expanded "><a href="../modules/presence_router_callbacks.html">Presence router callbacks</a></li><li class="chapter-item expanded "><a href="../modules/account_validity_callbacks.html">Account validity callbacks</a></li><li class="chapter-item expanded "><a href="../modules/password_auth_provider_callbacks.html">Password auth provider callbacks</a></li><li class="chapter-item expanded "><a href="../modules/background_update_controller_callbacks.html">Background update controller callbacks</a></li><li class="chapter-item expanded "><a href="../modules/account_data_callbacks.html">Account data callbacks</a></li><li class="chapter-item expanded "><a href="../modules/porting_legacy_module.html">Porting a legacy module to the new interface</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../workers.html">Workers</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../synctl_workers.html">Using synctl with Workers</a></li><li class="chapter-item expanded "><a href="../systemd-with-workers/index.html">Systemd</a></li></ol></li></ol></li><li class="chapter-item expanded "><a href="../usage/administration/index.html">Administration</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/administration/admin_api/index.html">Admin API</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../admin_api/account_validity.html">Account Validity</a></li><li class="chapter-item expanded "><a href="../usage/administration/admin_api/background_updates.html">Background Updates</a></li><li class="chapter-item expanded "><a href="../admin_api/event_reports.html">Event Reports</a></li><li class="chapter-item expanded "><a href="../admin_api/media_admin_api.html">Media</a></li><li class="chapter-item expanded "><a href="../admin_api/purge_history_api.html">Purge History</a></li><li class="chapter-item expanded "><a href="../admin_api/register_api.html">Register Users</a></li><li class="chapter-item expanded "><a href="../usage/administration/admin_api/registration_tokens.html">Registration Tokens</a></li><li class="chapter-item expanded "><a href="../admin_api/room_membership.html">Manipulate Room Membership</a></li><li class="chapter-item expanded "><a href="../admin_api/rooms.html">Rooms</a></li><li class="chapter-item expanded "><a href="../admin_api/server_notices.html">Server Notices</a></li><li class="chapter-item expanded "><a href="../admin_api/statistics.html">Statistics</a></li><li class="chapter-item expanded "><a href="../admin_api/user_admin_api.html">Users</a></li><li class="chapter-item expanded "><a href="../admin_api/version_api.html">Server Version</a></li><li class="chapter-item expanded "><a href="../usage/administration/admin_api/federation.html">Federation</a></li></ol></li><li class="chapter-item expanded "><a href="../manhole.html">Manhole</a></li><li class="chapter-item expanded "><a href="../metrics-howto.html">Monitoring</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../usage/administration/monitoring/reporting_homeserver_usage_statistics.html">Reporting Homeserver Usage Statistics</a></li></ol></li><li class="chapter-item expanded "><a href="../usage/administration/monthly_active_users.html">Monthly Active Users</a></li><li class="chapter-item expanded "><a href="../usage/administration/understanding_synapse_through_grafana_graphs.html">Understanding Synapse Through Grafana Graphs</a></li><li class="chapter-item expanded "><a href="../usage/administration/useful_sql_for_admins.html">Useful SQL for Admins</a></li><li class="chapter-item expanded "><a href="../usage/administration/database_maintenance_tools.html">Database Maintenance Tools</a></li><li class="chapter-item expanded "><a href="../usage/administration/state_groups.html">State Groups</a></li><li class="chapter-item expanded "><a href="../usage/administration/request_log.html">Request log format</a></li><li class="chapter-item expanded "><a href="../usage/administration/admin_faq.html">Admin FAQ</a></li><li class="chapter-item expanded "><div>Scripts</div></li></ol></li><li class="chapter-item expanded "><li class="part-title">Development</li><li class="chapter-item expanded "><a href="../development/contributing_guide.html">Contributing Guide</a></li><li class="chapter-item expanded "><a href="../code_style.html">Code Style</a></li><li class="chapter-item expanded "><a href="../development/reviews.html">Reviewing Code</a></li><li class="chapter-item expanded "><a href="../development/releases.html">Release Cycle</a></li><li class="chapter-item expanded "><a href="../development/git.html">Git Usage</a></li><li class="chapter-item expanded "><div>Testing</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../development/demo.html">Demo scripts</a></li></ol></li><li class="chapter-item expanded "><a href="../opentracing.html">OpenTracing</a></li><li class="chapter-item expanded "><a href="../development/database_schema.html">Database Schemas</a></li><li class="chapter-item expanded "><a href="../development/experimental_features.html">Experimental features</a></li><li class="chapter-item expanded "><a href="../development/dependencies.html">Dependency management</a></li><li class="chapter-item expanded "><div>Synapse Architecture</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../development/synapse_architecture/cancellation.html">Cancellation</a></li><li class="chapter-item expanded "><a href="../log_contexts.html">Log Contexts</a></li><li class="chapter-item expanded "><a href="../replication.html">Replication</a></li><li class="chapter-item expanded "><a href="../tcp_replication.html">TCP Replication</a></li></ol></li><li class="chapter-item expanded "><a href="../development/internal_documentation/index.html">Internal Documentation</a></li><li><ol class="section"><li class="chapter-item expanded "><div>Single Sign-On</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../development/saml.html">SAML</a></li><li class="chapter-item expanded "><a href="../development/cas.html">CAS</a></li></ol></li><li class="chapter-item expanded "><a href="../development/room-dag-concepts.html">Room DAG concepts</a></li><li class="chapter-item expanded "><div>State Resolution</div></li><li><ol class="section"><li class="chapter-item expanded "><a href="../auth_chain_difference_algorithm.html">The Auth Chain Difference Algorithm</a></li></ol></li><li class="chapter-item expanded "><a href="../media_repository.html">Media Repository</a></li><li class="chapter-item expanded "><a href="../room_and_user_statistics.html">Room and User Statistics</a></li></ol></li><li class="chapter-item expanded "><div>Scripts</div></li><li class="chapter-item expanded affix "><li class="part-title">Other</li><li class="chapter-item expanded "><a href="../deprecation_policy.html">Dependency Deprecation Policy</a></li><li class="chapter-item expanded "><a href="../other/running_synapse_on_single_board_computers.html">Running Synapse on a Single-Board Computer</a></li></ol>
  75. </div>
  76. <div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
  77. </nav>
  78. <div id="page-wrapper" class="page-wrapper">
  79. <div class="page">
  80. <div id="menu-bar-hover-placeholder"></div>
  81. <div id="menu-bar" class="menu-bar sticky bordered">
  82. <div class="left-buttons">
  83. <button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
  84. <i class="fa fa-bars"></i>
  85. </button>
  86. <button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
  87. <i class="fa fa-paint-brush"></i>
  88. </button>
  89. <ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
  90. <li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
  91. <li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
  92. <li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
  93. <li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
  94. <li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
  95. </ul>
  96. <button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
  97. <i class="fa fa-search"></i>
  98. </button>
  99. <div class="version-picker">
  100. <div class="dropdown">
  101. <div class="select">
  102. <span></span>
  103. <i class="fa fa-chevron-down"></i>
  104. </div>
  105. <input type="hidden" name="version">
  106. <ul class="dropdown-menu">
  107. <!-- Versions will be added dynamically in version-picker.js -->
  108. </ul>
  109. </div>
  110. </div>
  111. </div>
  112. <h1 class="menu-title">Synapse</h1>
  113. <div class="right-buttons">
  114. <a href="../print.html" title="Print this book" aria-label="Print this book">
  115. <i id="print-button" class="fa fa-print"></i>
  116. </a>
  117. <a href="https://github.com/matrix-org/synapse" title="Git repository" aria-label="Git repository">
  118. <i id="git-repository-button" class="fa fa-github"></i>
  119. </a>
  120. <a href="https://github.com/matrix-org/synapse/edit/develop/docs/modules/third_party_rules_callbacks.md" title="Suggest an edit" aria-label="Suggest an edit">
  121. <i id="git-edit-button" class="fa fa-edit"></i>
  122. </a>
  123. </div>
  124. </div>
  125. <div id="search-wrapper" class="hidden">
  126. <form id="searchbar-outer" class="searchbar-outer">
  127. <input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
  128. </form>
  129. <div id="searchresults-outer" class="searchresults-outer hidden">
  130. <div id="searchresults-header" class="searchresults-header"></div>
  131. <ul id="searchresults">
  132. </ul>
  133. </div>
  134. </div>
  135. <!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
  136. <script type="text/javascript">
  137. document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
  138. document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
  139. Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
  140. link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
  141. });
  142. </script>
  143. <div id="content" class="content">
  144. <main>
  145. <!-- Page table of contents -->
  146. <div class="sidetoc">
  147. <nav class="pagetoc"></nav>
  148. </div>
  149. <h1 id="third-party-rules-callbacks"><a class="header" href="#third-party-rules-callbacks">Third party rules callbacks</a></h1>
  150. <p>Third party rules callbacks allow module developers to add extra checks to verify the
  151. validity of incoming events. Third party event rules callbacks can be registered using
  152. the module API's <code>register_third_party_rules_callbacks</code> method.</p>
  153. <h2 id="callbacks"><a class="header" href="#callbacks">Callbacks</a></h2>
  154. <p>The available third party rules callbacks are:</p>
  155. <h3 id="check_event_allowed"><a class="header" href="#check_event_allowed"><code>check_event_allowed</code></a></h3>
  156. <p><em>First introduced in Synapse v1.39.0</em></p>
  157. <pre><code class="language-python">async def check_event_allowed(
  158. event: &quot;synapse.events.EventBase&quot;,
  159. state_events: &quot;synapse.types.StateMap&quot;,
  160. ) -&gt; Tuple[bool, Optional[dict]]
  161. </code></pre>
  162. <p><strong><span style="color:red">
  163. This callback is very experimental and can and will break without notice. Module developers
  164. are encouraged to implement <code>check_event_for_spam</code> from the spam checker category instead.
  165. </span></strong></p>
  166. <p>Called when processing any incoming event, with the event and a <code>StateMap</code>
  167. representing the current state of the room the event is being sent into. A <code>StateMap</code> is
  168. a dictionary that maps tuples containing an event type and a state key to the
  169. corresponding state event. For example retrieving the room's <code>m.room.create</code> event from
  170. the <code>state_events</code> argument would look like this: <code>state_events.get((&quot;m.room.create&quot;, &quot;&quot;))</code>.
  171. The module must return a boolean indicating whether the event can be allowed.</p>
  172. <p>Note that this callback function processes incoming events coming via federation
  173. traffic (on top of client traffic). This means denying an event might cause the local
  174. copy of the room's history to diverge from that of remote servers. This may cause
  175. federation issues in the room. It is strongly recommended to only deny events using this
  176. callback function if the sender is a local user, or in a private federation in which all
  177. servers are using the same module, with the same configuration.</p>
  178. <p>If the boolean returned by the module is <code>True</code>, it may also tell Synapse to replace the
  179. event with new data by returning the new event's data as a dictionary. In order to do
  180. that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a
  181. dictionary, and modify the returned dictionary accordingly.</p>
  182. <p>If <code>check_event_allowed</code> raises an exception, the module is assumed to have failed.
  183. The event will not be accepted but is not treated as explicitly rejected, either.
  184. An HTTP request causing the module check will likely result in a 500 Internal
  185. Server Error.</p>
  186. <p>When the boolean returned by the module is <code>False</code>, the event is rejected.
  187. (Module developers should not use exceptions for rejection.)</p>
  188. <p>Note that replacing the event only works for events sent by local users, not for events
  189. received over federation.</p>
  190. <p>If multiple modules implement this callback, they will be considered in order. If a
  191. callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
  192. callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
  193. any of the subsequent implementations of this callback.</p>
  194. <h3 id="on_create_room"><a class="header" href="#on_create_room"><code>on_create_room</code></a></h3>
  195. <p><em>First introduced in Synapse v1.39.0</em></p>
  196. <pre><code class="language-python">async def on_create_room(
  197. requester: &quot;synapse.types.Requester&quot;,
  198. request_content: dict,
  199. is_requester_admin: bool,
  200. ) -&gt; None
  201. </code></pre>
  202. <p>Called when processing a room creation request, with the <code>Requester</code> object for the user
  203. performing the request, a dictionary representing the room creation request's JSON body
  204. (see <a href="https://matrix.org/docs/spec/client_server/latest#post-matrix-client-r0-createroom">the spec</a>
  205. for a list of possible parameters), and a boolean indicating whether the user performing
  206. the request is a server admin.</p>
  207. <p>Modules can modify the <code>request_content</code> (by e.g. adding events to its <code>initial_state</code>),
  208. or deny the room's creation by raising a <code>module_api.errors.SynapseError</code>.</p>
  209. <p>If multiple modules implement this callback, they will be considered in order. If a
  210. callback returns without raising an exception, Synapse falls through to the next one. The
  211. room creation will be forbidden as soon as one of the callbacks raises an exception. If
  212. this happens, Synapse will not call any of the subsequent implementations of this
  213. callback.</p>
  214. <h3 id="check_threepid_can_be_invited"><a class="header" href="#check_threepid_can_be_invited"><code>check_threepid_can_be_invited</code></a></h3>
  215. <p><em>First introduced in Synapse v1.39.0</em></p>
  216. <pre><code class="language-python">async def check_threepid_can_be_invited(
  217. medium: str,
  218. address: str,
  219. state_events: &quot;synapse.types.StateMap&quot;,
  220. ) -&gt; bool:
  221. </code></pre>
  222. <p>Called when processing an invite via a third-party identifier (i.e. email or phone number).
  223. The module must return a boolean indicating whether the invite can go through.</p>
  224. <p>If multiple modules implement this callback, they will be considered in order. If a
  225. callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
  226. callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
  227. any of the subsequent implementations of this callback.</p>
  228. <h3 id="check_visibility_can_be_modified"><a class="header" href="#check_visibility_can_be_modified"><code>check_visibility_can_be_modified</code></a></h3>
  229. <p><em>First introduced in Synapse v1.39.0</em></p>
  230. <pre><code class="language-python">async def check_visibility_can_be_modified(
  231. room_id: str,
  232. state_events: &quot;synapse.types.StateMap&quot;,
  233. new_visibility: str,
  234. ) -&gt; bool:
  235. </code></pre>
  236. <p>Called when changing the visibility of a room in the local public room directory. The
  237. visibility is a string that's either &quot;public&quot; or &quot;private&quot;. The module must return a
  238. boolean indicating whether the change can go through.</p>
  239. <p>If multiple modules implement this callback, they will be considered in order. If a
  240. callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
  241. callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
  242. any of the subsequent implementations of this callback.</p>
  243. <h3 id="on_new_event"><a class="header" href="#on_new_event"><code>on_new_event</code></a></h3>
  244. <p><em>First introduced in Synapse v1.47.0</em></p>
  245. <pre><code class="language-python">async def on_new_event(
  246. event: &quot;synapse.events.EventBase&quot;,
  247. state_events: &quot;synapse.types.StateMap&quot;,
  248. ) -&gt; None:
  249. </code></pre>
  250. <p>Called after sending an event into a room. The module is passed the event, as well
  251. as the state of the room <em>after</em> the event. This means that if the event is a state event,
  252. it will be included in this state.</p>
  253. <p>Note that this callback is called when the event has already been processed and stored
  254. into the room, which means this callback cannot be used to deny persisting the event. To
  255. deny an incoming event, see <a href="spam_checker_callbacks.html#check_event_for_spam"><code>check_event_for_spam</code></a> instead.</p>
  256. <p>If multiple modules implement this callback, Synapse runs them all in order.</p>
  257. <h3 id="check_can_shutdown_room"><a class="header" href="#check_can_shutdown_room"><code>check_can_shutdown_room</code></a></h3>
  258. <p><em>First introduced in Synapse v1.55.0</em></p>
  259. <pre><code class="language-python">async def check_can_shutdown_room(
  260. user_id: str, room_id: str,
  261. ) -&gt; bool:
  262. </code></pre>
  263. <p>Called when an admin user requests the shutdown of a room. The module must return a
  264. boolean indicating whether the shutdown can go through. If the callback returns <code>False</code>,
  265. the shutdown will not proceed and the caller will see a <code>M_FORBIDDEN</code> error.</p>
  266. <p>If multiple modules implement this callback, they will be considered in order. If a
  267. callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
  268. callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
  269. any of the subsequent implementations of this callback.</p>
  270. <h3 id="check_can_deactivate_user"><a class="header" href="#check_can_deactivate_user"><code>check_can_deactivate_user</code></a></h3>
  271. <p><em>First introduced in Synapse v1.55.0</em></p>
  272. <pre><code class="language-python">async def check_can_deactivate_user(
  273. user_id: str, by_admin: bool,
  274. ) -&gt; bool:
  275. </code></pre>
  276. <p>Called when the deactivation of a user is requested. User deactivation can be
  277. performed by an admin or the user themselves, so developers are encouraged to check the
  278. requester when implementing this callback. The module must return a
  279. boolean indicating whether the deactivation can go through. If the callback returns <code>False</code>,
  280. the deactivation will not proceed and the caller will see a <code>M_FORBIDDEN</code> error.</p>
  281. <p>The module is passed two parameters, <code>user_id</code> which is the ID of the user being deactivated, and <code>by_admin</code> which is <code>True</code> if the request is made by a serve admin, and <code>False</code> otherwise.</p>
  282. <p>If multiple modules implement this callback, they will be considered in order. If a
  283. callback returns <code>True</code>, Synapse falls through to the next one. The value of the first
  284. callback that does not return <code>True</code> will be used. If this happens, Synapse will not call
  285. any of the subsequent implementations of this callback.</p>
  286. <h3 id="on_profile_update"><a class="header" href="#on_profile_update"><code>on_profile_update</code></a></h3>
  287. <p><em>First introduced in Synapse v1.54.0</em></p>
  288. <pre><code class="language-python">async def on_profile_update(
  289. user_id: str,
  290. new_profile: &quot;synapse.module_api.ProfileInfo&quot;,
  291. by_admin: bool,
  292. deactivation: bool,
  293. ) -&gt; None:
  294. </code></pre>
  295. <p>Called after updating a local user's profile. The update can be triggered either by the
  296. user themselves or a server admin. The update can also be triggered by a user being
  297. deactivated (in which case their display name is set to an empty string (<code>&quot;&quot;</code>) and the
  298. avatar URL is set to <code>None</code>). The module is passed the Matrix ID of the user whose profile
  299. has been updated, their new profile, as well as a <code>by_admin</code> boolean that is <code>True</code> if the
  300. update was triggered by a server admin (and <code>False</code> otherwise), and a <code>deactivated</code>
  301. boolean that is <code>True</code> if the update is a result of the user being deactivated.</p>
  302. <p>Note that the <code>by_admin</code> boolean is also <code>True</code> if the profile change happens as a result
  303. of the user logging in through Single Sign-On, or if a server admin updates their own
  304. profile.</p>
  305. <p>Per-room profile changes do not trigger this callback to be called. Synapse administrators
  306. wishing this callback to be called on every profile change are encouraged to disable
  307. per-room profiles globally using the <code>allow_per_room_profiles</code> configuration setting in
  308. Synapse's configuration file.
  309. This callback is not called when registering a user, even when setting it through the
  310. <a href="https://matrix-org.github.io/synapse/latest/modules/password_auth_provider_callbacks.html#get_displayname_for_registration"><code>get_displayname_for_registration</code></a>
  311. module callback.</p>
  312. <p>If multiple modules implement this callback, Synapse runs them all in order.</p>
  313. <h3 id="on_user_deactivation_status_changed"><a class="header" href="#on_user_deactivation_status_changed"><code>on_user_deactivation_status_changed</code></a></h3>
  314. <p><em>First introduced in Synapse v1.54.0</em></p>
  315. <pre><code class="language-python">async def on_user_deactivation_status_changed(
  316. user_id: str, deactivated: bool, by_admin: bool
  317. ) -&gt; None:
  318. </code></pre>
  319. <p>Called after deactivating a local user, or reactivating them through the admin API. The
  320. deactivation can be triggered either by the user themselves or a server admin. The module
  321. is passed the Matrix ID of the user whose status is changed, as well as a <code>deactivated</code>
  322. boolean that is <code>True</code> if the user is being deactivated and <code>False</code> if they're being
  323. reactivated, and a <code>by_admin</code> boolean that is <code>True</code> if the deactivation was triggered by
  324. a server admin (and <code>False</code> otherwise). This latter <code>by_admin</code> boolean is always <code>True</code>
  325. if the user is being reactivated, as this operation can only be performed through the
  326. admin API.</p>
  327. <p>If multiple modules implement this callback, Synapse runs them all in order.</p>
  328. <h3 id="on_threepid_bind"><a class="header" href="#on_threepid_bind"><code>on_threepid_bind</code></a></h3>
  329. <p><em>First introduced in Synapse v1.56.0</em></p>
  330. <pre><code class="language-python">async def on_threepid_bind(user_id: str, medium: str, address: str) -&gt; None:
  331. </code></pre>
  332. <p>Called after creating an association between a local user and a third-party identifier
  333. (email address, phone number). The module is given the Matrix ID of the user the
  334. association is for, as well as the medium (<code>email</code> or <code>msisdn</code>) and address of the
  335. third-party identifier.</p>
  336. <p>Note that this callback is <em>not</em> called after a successful association on an <em>identity
  337. server</em>.</p>
  338. <p>If multiple modules implement this callback, Synapse runs them all in order.</p>
  339. <h2 id="example"><a class="header" href="#example">Example</a></h2>
  340. <p>The example below is a module that implements the third-party rules callback
  341. <code>check_event_allowed</code> to censor incoming messages as dictated by a third-party service.</p>
  342. <pre><code class="language-python">from typing import Optional, Tuple
  343. from synapse.module_api import ModuleApi
  344. _DEFAULT_CENSOR_ENDPOINT = &quot;https://my-internal-service.local/censor-event&quot;
  345. class EventCensorer:
  346. def __init__(self, config: dict, api: ModuleApi):
  347. self.api = api
  348. self._endpoint = config.get(&quot;endpoint&quot;, _DEFAULT_CENSOR_ENDPOINT)
  349. self.api.register_third_party_rules_callbacks(
  350. check_event_allowed=self.check_event_allowed,
  351. )
  352. async def check_event_allowed(
  353. self,
  354. event: &quot;synapse.events.EventBase&quot;,
  355. state_events: &quot;synapse.types.StateMap&quot;,
  356. ) -&gt; Tuple[bool, Optional[dict]]:
  357. event_dict = event.get_dict()
  358. new_event_content = await self.api.http_client.post_json_get_json(
  359. uri=self._endpoint, post_json=event_dict,
  360. )
  361. event_dict[&quot;content&quot;] = new_event_content
  362. return event_dict
  363. </code></pre>
  364. </main>
  365. <nav class="nav-wrapper" aria-label="Page navigation">
  366. <!-- Mobile navigation buttons -->
  367. <a rel="prev" href="../modules/spam_checker_callbacks.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  368. <i class="fa fa-angle-left"></i>
  369. </a>
  370. <a rel="next" href="../modules/presence_router_callbacks.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  371. <i class="fa fa-angle-right"></i>
  372. </a>
  373. <div style="clear: both"></div>
  374. </nav>
  375. </div>
  376. </div>
  377. <nav class="nav-wide-wrapper" aria-label="Page navigation">
  378. <a rel="prev" href="../modules/spam_checker_callbacks.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
  379. <i class="fa fa-angle-left"></i>
  380. </a>
  381. <a rel="next" href="../modules/presence_router_callbacks.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
  382. <i class="fa fa-angle-right"></i>
  383. </a>
  384. </nav>
  385. </div>
  386. <script type="text/javascript">
  387. window.playground_copyable = true;
  388. </script>
  389. <script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
  390. <script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
  391. <script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
  392. <script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
  393. <script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
  394. <script src="../book.js" type="text/javascript" charset="utf-8"></script>
  395. <!-- Custom JS scripts -->
  396. <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script>
  397. <script type="text/javascript" src="../docs/website_files/version-picker.js"></script>
  398. <script type="text/javascript" src="../docs/website_files/version.js"></script>
  399. </body>
  400. </html>