diff options
| author | erikjohnston <erikjohnston@users.noreply.github.com> | 2023-12-12 17:29:11 +0000 |
|---|---|---|
| committer | erikjohnston <erikjohnston@users.noreply.github.com> | 2023-12-12 17:29:11 +0000 |
| commit | 001046b66e7cf9d27f0edda65c763a15c181fd26 (patch) | |
| tree | 6f49d264a9fc117153bb93ae080ba662d27849b2 /latest/modules | |
| parent | deploy: e108cde669fcc0a9f1def9d8771f962c9b0b312f (diff) | |
| download | synapse-001046b66e7cf9d27f0edda65c763a15c181fd26.tar.xz | |
deploy: 15733b0931ceaa72cf4175c44fe58128fa273bac
Diffstat (limited to 'latest/modules')
| -rw-r--r-- | latest/modules/account_data_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/account_validity_callbacks.html | 24 | ||||
| -rw-r--r-- | latest/modules/add_extra_fields_to_client_events_unsigned.html | 17 | ||||
| -rw-r--r-- | latest/modules/background_update_controller_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/index.html | 17 | ||||
| -rw-r--r-- | latest/modules/password_auth_provider_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/porting_legacy_module.html | 17 | ||||
| -rw-r--r-- | latest/modules/presence_router_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/spam_checker_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/third_party_rules_callbacks.html | 17 | ||||
| -rw-r--r-- | latest/modules/writing_a_module.html | 17 |
11 files changed, 183 insertions, 11 deletions
diff --git a/latest/modules/account_data_callbacks.html b/latest/modules/account_data_callbacks.html index 9004174bb1..b9968f15bc 100644 --- a/latest/modules/account_data_callbacks.html +++ b/latest/modules/account_data_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -276,5 +289,7 @@ class CustomAccountDataModule: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/account_validity_callbacks.html b/latest/modules/account_validity_callbacks.html index eb23bf6f0b..af8c027580 100644 --- a/latest/modules/account_validity_callbacks.html +++ b/latest/modules/account_validity_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -175,6 +188,13 @@ any of the subsequent implementations of this callback.</p> operations to keep track of them. (e.g. add them to a database table). The user is represented by their Matrix user ID.</p> <p>If multiple modules implement this callback, Synapse runs them all in order.</p> +<h3 id="on_user_login"><a class="header" href="#on_user_login"><code>on_user_login</code></a></h3> +<p><em>First introduced in Synapse v1.98.0</em></p> +<pre><code class="language-python">async def on_user_login(user_id: str, auth_provider_type: str, auth_provider_id: str) -> None +</code></pre> +<p>Called after successfully login or registration of a user for cases when module needs to perform extra operations after auth. +represented by their Matrix user ID.</p> +<p>If multiple modules implement this callback, Synapse runs them all in order.</p> </main> @@ -214,5 +234,7 @@ represented by their Matrix user ID.</p> <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/add_extra_fields_to_client_events_unsigned.html b/latest/modules/add_extra_fields_to_client_events_unsigned.html index b23940d4bd..f004a2601a 100644 --- a/latest/modules/add_extra_fields_to_client_events_unsigned.html +++ b/latest/modules/add_extra_fields_to_client_events_unsigned.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -206,5 +219,7 @@ section, the last-registered callback wins.</p> <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/background_update_controller_callbacks.html b/latest/modules/background_update_controller_callbacks.html index 62851e877b..83b5cd2e4e 100644 --- a/latest/modules/background_update_controller_callbacks.html +++ b/latest/modules/background_update_controller_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -232,5 +245,7 @@ ensure that progress is always made.</p> <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/index.html b/latest/modules/index.html index d56942176c..629c6997c6 100644 --- a/latest/modules/index.html +++ b/latest/modules/index.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -227,5 +240,7 @@ another part of Synapse's configuration file.</p> <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/password_auth_provider_callbacks.html b/latest/modules/password_auth_provider_callbacks.html index 941dc90d12..7b07acdfe1 100644 --- a/latest/modules/password_auth_provider_callbacks.html +++ b/latest/modules/password_auth_provider_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -424,5 +437,7 @@ class MyAuthProvider: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/porting_legacy_module.html b/latest/modules/porting_legacy_module.html index b19e5c6612..7d4b928be4 100644 --- a/latest/modules/porting_legacy_module.html +++ b/latest/modules/porting_legacy_module.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -202,5 +215,7 @@ for more info).</p> <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/presence_router_callbacks.html b/latest/modules/presence_router_callbacks.html index 1574797c03..1b0457de7c 100644 --- a/latest/modules/presence_router_callbacks.html +++ b/latest/modules/presence_router_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -273,5 +286,7 @@ class CustomPresenceRouter: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/spam_checker_callbacks.html b/latest/modules/spam_checker_callbacks.html index 4b5378feaa..2092387123 100644 --- a/latest/modules/spam_checker_callbacks.html +++ b/latest/modules/spam_checker_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -564,5 +577,7 @@ class ListSpamChecker: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/third_party_rules_callbacks.html b/latest/modules/third_party_rules_callbacks.html index d235c91239..c601154292 100644 --- a/latest/modules/third_party_rules_callbacks.html +++ b/latest/modules/third_party_rules_callbacks.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -433,5 +446,7 @@ class EventCensorer: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> diff --git a/latest/modules/writing_a_module.html b/latest/modules/writing_a_module.html index 5c0ac0de25..ac3ac5555f 100644 --- a/latest/modules/writing_a_module.html +++ b/latest/modules/writing_a_module.html @@ -28,6 +28,7 @@ <link rel="stylesheet" href="../docs/website_files/table-of-contents.css"> <link rel="stylesheet" href="../docs/website_files/remove-nav-buttons.css"> <link rel="stylesheet" href="../docs/website_files/indent-section-headers.css"> + <link rel="stylesheet" href="../docs/website_files/version-picker.css"> </head> <body> <!-- Provide site root to javascript --> @@ -103,6 +104,18 @@ <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"> <i class="fa fa-search"></i> </button> + <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> </div> <h1 class="menu-title">Synapse</h1> @@ -294,5 +307,7 @@ class MyModule: <!-- Custom JS scripts --> <script type="text/javascript" src="../docs/website_files/table-of-contents.js"></script> + <script type="text/javascript" src="../docs/website_files/version-picker.js"></script> + <script type="text/javascript" src="../docs/website_files/version.js"></script> </body> -</html> \ No newline at end of file +</html> |