diff options
| author | anoadragon453 <anoadragon453@users.noreply.github.com> | 2023-02-27 14:20:07 +0000 |
|---|---|---|
| committer | anoadragon453 <anoadragon453@users.noreply.github.com> | 2023-02-27 14:20:07 +0000 |
| commit | 69a3dc72acb1c50de791786234451afff5768176 (patch) | |
| tree | 9a436cc21fad72ce6b77df8ee9cf3a868acb1149 /develop/upgrade.html | |
| parent | deploy: 1a1738eca233ee26e214ef810e2833f9483edf04 (diff) | |
| download | synapse-69a3dc72acb1c50de791786234451afff5768176.tar.xz | |
deploy: b40657314e03583f45ad49504711698a70735313
Diffstat (limited to '')
| -rw-r--r-- | develop/upgrade.html | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/develop/upgrade.html b/develop/upgrade.html index 674c9790c3..b60bd2edf0 100644 --- a/develop/upgrade.html +++ b/develop/upgrade.html @@ -231,6 +231,24 @@ dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb </code></pre> </li> </ul> +<h1 id="upgrading-to-v1790"><a class="header" href="#upgrading-to-v1790">Upgrading to v1.79.0</a></h1> +<h2 id="the-on_threepid_bind-module-callback-method-has-been-deprecated"><a class="header" href="#the-on_threepid_bind-module-callback-method-has-been-deprecated">The <code>on_threepid_bind</code> module callback method has been deprecated</a></h2> +<p>Synapse v1.79.0 deprecates the +<a href="modules/third_party_rules_callbacks.html#on_threepid_bind"><code>on_threepid_bind</code></a> +"third-party rules" Synapse module callback method in favour of a new module method, +<a href="modules/third_party_rules_callbacks.html#on_add_user_third_party_identifier"><code>on_add_user_third_party_identifier</code></a>. +<code>on_threepid_bind</code> will be removed in a future version of Synapse. You should check whether any Synapse +modules in use in your deployment are making use of <code>on_threepid_bind</code>, and update them where possible.</p> +<p>The arguments and functionality of the new method are the same.</p> +<p>The justification behind the name change is that the old method's name, <code>on_threepid_bind</code>, was +misleading. A user is considered to "bind" their third-party ID to their Matrix ID only if they +do so via an <a href="https://spec.matrix.org/latest/identity-service-api/">identity server</a> +(so that users on other homeservers may find them). But this method was not called in that case - +it was only called when a user added a third-party identifier on the local homeserver.</p> +<p>Module developers may also be interested in the related +<a href="modules/third_party_rules_callbacks.html#on_remove_user_third_party_identifier"><code>on_remove_user_third_party_identifier</code></a> +module callback method that was also added in Synapse v1.79.0. This new method is called when a +user removes a third-party identifier from their account.</p> <h1 id="upgrading-to-v1780"><a class="header" href="#upgrading-to-v1780">Upgrading to v1.78.0</a></h1> <h2 id="deprecate-the-_synapseadminv1mediaserver_namedelete-admin-api"><a class="header" href="#deprecate-the-_synapseadminv1mediaserver_namedelete-admin-api">Deprecate the <code>/_synapse/admin/v1/media/<server_name>/delete</code> admin API</a></h2> <p>Synapse 1.78.0 replaces the <code>/_synapse/admin/v1/media/<server_name>/delete</code> |