mirror of
https://github.com/element-hq/synapse.git
synced 2024-12-15 17:51:10 +00:00
Deprecate user_may_create_room_with_invites (#11206)
This commit is contained in:
parent
bfd7a9b65c
commit
e320f5dba3
3 changed files with 14 additions and 36 deletions
1
changelog.d/11206.removal
Normal file
1
changelog.d/11206.removal
Normal file
|
@ -0,0 +1 @@
|
||||||
|
The `user_may_create_room_with_invites` module callback is now deprecated. Please refer to the [upgrade notes](https://matrix-org.github.io/synapse/develop/upgrade#upgrading-to-v1470) for more information.
|
|
@ -123,42 +123,6 @@ callback returns `True`, Synapse falls through to the next one. The value of the
|
||||||
callback that does not return `True` will be used. If this happens, Synapse will not call
|
callback that does not return `True` will be used. If this happens, Synapse will not call
|
||||||
any of the subsequent implementations of this callback.
|
any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_create_room_with_invites`
|
|
||||||
|
|
||||||
_First introduced in Synapse v1.44.0_
|
|
||||||
|
|
||||||
```python
|
|
||||||
async def user_may_create_room_with_invites(
|
|
||||||
user: str,
|
|
||||||
invites: List[str],
|
|
||||||
threepid_invites: List[Dict[str, str]],
|
|
||||||
) -> bool
|
|
||||||
```
|
|
||||||
|
|
||||||
Called when processing a room creation request (right after `user_may_create_room`).
|
|
||||||
The module is given the Matrix user ID of the user trying to create a room, as well as a
|
|
||||||
list of Matrix users to invite and a list of third-party identifiers (3PID, e.g. email
|
|
||||||
addresses) to invite.
|
|
||||||
|
|
||||||
An invited Matrix user to invite is represented by their Matrix user IDs, and an invited
|
|
||||||
3PIDs is represented by a dict that includes the 3PID medium (e.g. "email") through its
|
|
||||||
`medium` key and its address (e.g. "alice@example.com") through its `address` key.
|
|
||||||
|
|
||||||
See [the Matrix specification](https://matrix.org/docs/spec/appendices#pid-types) for more
|
|
||||||
information regarding third-party identifiers.
|
|
||||||
|
|
||||||
If no invite and/or 3PID invite were specified in the room creation request, the
|
|
||||||
corresponding list(s) will be empty.
|
|
||||||
|
|
||||||
**Note**: This callback is not called when a room is cloned (e.g. during a room upgrade)
|
|
||||||
since no invites are sent when cloning a room. To cover this case, modules also need to
|
|
||||||
implement `user_may_create_room`.
|
|
||||||
|
|
||||||
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.
|
|
||||||
|
|
||||||
### `user_may_create_room_alias`
|
### `user_may_create_room_alias`
|
||||||
|
|
||||||
_First introduced in Synapse v1.37.0_
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
|
@ -85,6 +85,19 @@ process, for example:
|
||||||
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
|
||||||
```
|
```
|
||||||
|
|
||||||
|
# Upgrading to v1.47.0
|
||||||
|
|
||||||
|
## Deprecation of the `user_may_create_room_with_invites` module callback
|
||||||
|
|
||||||
|
The `user_may_create_room_with_invites` is deprecated and will be removed in a future
|
||||||
|
version of Synapse. Modules implementing this callback can instead implement
|
||||||
|
[`user_may_invite`](https://matrix-org.github.io/synapse/latest/modules/spam_checker_callbacks.html#user_may_invite)
|
||||||
|
and use the [`get_room_state`](https://github.com/matrix-org/synapse/blob/872f23b95fa980a61b0866c1475e84491991fa20/synapse/module_api/__init__.py#L869-L876)
|
||||||
|
module API method to infer whether the invite is happening in the context of creating a
|
||||||
|
room.
|
||||||
|
|
||||||
|
We plan to remove this callback in January 2022.
|
||||||
|
|
||||||
# Upgrading to v1.45.0
|
# Upgrading to v1.45.0
|
||||||
|
|
||||||
## Changes required to media storage provider modules when reading from the Synapse configuration object
|
## Changes required to media storage provider modules when reading from the Synapse configuration object
|
||||||
|
|
Loading…
Reference in a new issue