summary refs log tree commit diff
path: root/docs/modules/third_party_rules_callbacks.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/modules/third_party_rules_callbacks.md81
1 files changed, 0 insertions, 81 deletions
diff --git a/docs/modules/third_party_rules_callbacks.md b/docs/modules/third_party_rules_callbacks.md

index b97e28db11..b4162a317d 100644 --- a/docs/modules/third_party_rules_callbacks.md +++ b/docs/modules/third_party_rules_callbacks.md
@@ -86,26 +86,6 @@ room creation will be forbidden as soon as one of the callbacks raises an except this happens, Synapse will not call any of the subsequent implementations of this callback. -### `check_threepid_can_be_invited` - -_First introduced in Synapse v1.39.0_ - -```python -async def check_threepid_can_be_invited( - medium: str, - address: str, - state_events: "synapse.types.StateMap", -) -> bool: -``` - -Called when processing an invite via a third-party identifier (i.e. email or phone number). -The module must return a boolean indicating whether the invite can go through. - -If multiple modules implement this callback, they will be considered in order. If a -callback returns `True`, Synapse falls through to the next one. The value of the first -callback that does not return `True` will be used. If this happens, Synapse will not call -any of the subsequent implementations of this callback. - ### `check_visibility_can_be_modified` _First introduced in Synapse v1.39.0_ @@ -254,67 +234,6 @@ admin API. If multiple modules implement this callback, Synapse runs them all in order. -### `on_threepid_bind` - -_First introduced in Synapse v1.56.0_ - -**<span style="color:red"> -This callback is deprecated in favour of the `on_add_user_third_party_identifier` callback, which -features the same functionality. The only difference is in name. -</span>** - -```python -async def on_threepid_bind(user_id: str, medium: str, address: str) -> None: -``` - -Called after creating an association between a local user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier. - -Note that this callback is _not_ called after a successful association on an _identity -server_. - -If multiple modules implement this callback, Synapse runs them all in order. - -### `on_add_user_third_party_identifier` - -_First introduced in Synapse v1.79.0_ - -```python -async def on_add_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: -``` - -Called after successfully creating an association between a user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier (i.e. an email address). - -Note that this callback is _not_ called if a user attempts to bind their third-party identifier -to an identity server (via a call to [`POST -/_matrix/client/v3/account/3pid/bind`](https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidbind)). - -If multiple modules implement this callback, Synapse runs them all in order. - -### `on_remove_user_third_party_identifier` - -_First introduced in Synapse v1.79.0_ - -```python -async def on_remove_user_third_party_identifier(user_id: str, medium: str, address: str) -> None: -``` - -Called after successfully removing an association between a user and a third-party identifier -(email address, phone number). The module is given the Matrix ID of the user the -association is for, as well as the medium (`email` or `msisdn`) and address of the -third-party identifier (i.e. an email address). - -Note that this callback is _not_ called if a user attempts to unbind their third-party -identifier from an identity server (via a call to [`POST -/_matrix/client/v3/account/3pid/unbind`](https://spec.matrix.org/v1.5/client-server-api/#post_matrixclientv3account3pidunbind)). - -If multiple modules implement this callback, Synapse runs them all in order. - ## Example The example below is a module that implements the third-party rules callback