Document the version of Synapse each module callback was introduced in (#11132)
* Mention callbacks introduced in v1.37.0 According to the documentation introduced in https://github.com/matrix-org/synapse/pull/10062 * Mention callbacks introduced in v1.39.0 According to https://github.com/matrix-org/synapse/pull/10386 and https://github.com/matrix-org/synapse/pull/9884 * Mention callbacks introduced in v1.42.0 According to https://github.com/matrix-org/synapse/pull/10524 * Mention callbacks introduced in v1.44.0 and v1.45.0 As per https://github.com/matrix-org/synapse/pull/10898, https://github.com/matrix-org/synapse/pull/10910 and https://github.com/matrix-org/synapse/pull/10894 * Mention callbacks introduced in v1.46.0 According to https://github.com/matrix-org/synapse/pull/10548
This commit is contained in:
parent
0dd0c40329
commit
78d5896d19
|
@ -0,0 +1 @@
|
||||||
|
Document the version of Synapse each module callback was introduced in.
|
|
@ -9,6 +9,8 @@ The available account validity callbacks are:
|
||||||
|
|
||||||
### `is_user_expired`
|
### `is_user_expired`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def is_user_expired(user: str) -> Optional[bool]
|
async def is_user_expired(user: str) -> Optional[bool]
|
||||||
```
|
```
|
||||||
|
@ -29,6 +31,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `on_user_registration`
|
### `on_user_registration`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def on_user_registration(user: str) -> None
|
async def on_user_registration(user: str) -> None
|
||||||
```
|
```
|
||||||
|
|
|
@ -8,6 +8,8 @@ registered by using the Module API's `register_password_auth_provider_callbacks`
|
||||||
|
|
||||||
### `auth_checkers`
|
### `auth_checkers`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.46.0_
|
||||||
|
|
||||||
```
|
```
|
||||||
auth_checkers: Dict[Tuple[str,Tuple], Callable]
|
auth_checkers: Dict[Tuple[str,Tuple], Callable]
|
||||||
```
|
```
|
||||||
|
@ -55,6 +57,8 @@ authentication fails.
|
||||||
|
|
||||||
### `check_3pid_auth`
|
### `check_3pid_auth`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.46.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_3pid_auth(
|
async def check_3pid_auth(
|
||||||
medium: str,
|
medium: str,
|
||||||
|
@ -86,6 +90,8 @@ the authentication is denied.
|
||||||
|
|
||||||
### `on_logged_out`
|
### `on_logged_out`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.46.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def on_logged_out(
|
async def on_logged_out(
|
||||||
user_id: str,
|
user_id: str,
|
||||||
|
|
|
@ -10,6 +10,8 @@ The available presence router callbacks are:
|
||||||
|
|
||||||
### `get_users_for_states`
|
### `get_users_for_states`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.42.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def get_users_for_states(
|
async def get_users_for_states(
|
||||||
state_updates: Iterable["synapse.api.UserPresenceState"],
|
state_updates: Iterable["synapse.api.UserPresenceState"],
|
||||||
|
@ -30,6 +32,8 @@ Synapse concatenates the sets associated with this key from each dictionary.
|
||||||
|
|
||||||
### `get_interested_users`
|
### `get_interested_users`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.42.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def get_interested_users(
|
async def get_interested_users(
|
||||||
user_id: str
|
user_id: str
|
||||||
|
|
|
@ -10,6 +10,8 @@ The available spam checker callbacks are:
|
||||||
|
|
||||||
### `check_event_for_spam`
|
### `check_event_for_spam`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_event_for_spam(event: "synapse.events.EventBase") -> Union[bool, str]
|
async def check_event_for_spam(event: "synapse.events.EventBase") -> Union[bool, str]
|
||||||
```
|
```
|
||||||
|
@ -26,6 +28,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_join_room`
|
### `user_may_join_room`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_join_room(user: str, room: str, is_invited: bool) -> bool
|
async def user_may_join_room(user: str, room: str, is_invited: bool) -> bool
|
||||||
```
|
```
|
||||||
|
@ -46,6 +50,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_invite`
|
### `user_may_invite`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_invite(inviter: str, invitee: str, room_id: str) -> bool
|
async def user_may_invite(inviter: str, invitee: str, room_id: str) -> bool
|
||||||
```
|
```
|
||||||
|
@ -61,6 +67,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_send_3pid_invite`
|
### `user_may_send_3pid_invite`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.45.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_send_3pid_invite(
|
async def user_may_send_3pid_invite(
|
||||||
inviter: str,
|
inviter: str,
|
||||||
|
@ -101,6 +109,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_create_room`
|
### `user_may_create_room`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_create_room(user: str) -> bool
|
async def user_may_create_room(user: str) -> bool
|
||||||
```
|
```
|
||||||
|
@ -115,6 +125,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_create_room_with_invites`
|
### `user_may_create_room_with_invites`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.44.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_create_room_with_invites(
|
async def user_may_create_room_with_invites(
|
||||||
user: str,
|
user: str,
|
||||||
|
@ -149,6 +161,8 @@ 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_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_create_room_alias(user: str, room_alias: "synapse.types.RoomAlias") -> bool
|
async def user_may_create_room_alias(user: str, room_alias: "synapse.types.RoomAlias") -> bool
|
||||||
```
|
```
|
||||||
|
@ -164,6 +178,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `user_may_publish_room`
|
### `user_may_publish_room`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def user_may_publish_room(user: str, room_id: str) -> bool
|
async def user_may_publish_room(user: str, room_id: str) -> bool
|
||||||
```
|
```
|
||||||
|
@ -179,6 +195,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `check_username_for_spam`
|
### `check_username_for_spam`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_username_for_spam(user_profile: Dict[str, str]) -> bool
|
async def check_username_for_spam(user_profile: Dict[str, str]) -> bool
|
||||||
```
|
```
|
||||||
|
@ -201,6 +219,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `check_registration_for_spam`
|
### `check_registration_for_spam`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_registration_for_spam(
|
async def check_registration_for_spam(
|
||||||
email_threepid: Optional[dict],
|
email_threepid: Optional[dict],
|
||||||
|
@ -232,6 +252,8 @@ this callback.
|
||||||
|
|
||||||
### `check_media_file_for_spam`
|
### `check_media_file_for_spam`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.37.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_media_file_for_spam(
|
async def check_media_file_for_spam(
|
||||||
file_wrapper: "synapse.rest.media.v1.media_storage.ReadableFileWrapper",
|
file_wrapper: "synapse.rest.media.v1.media_storage.ReadableFileWrapper",
|
||||||
|
|
|
@ -10,6 +10,8 @@ The available third party rules callbacks are:
|
||||||
|
|
||||||
### `check_event_allowed`
|
### `check_event_allowed`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_event_allowed(
|
async def check_event_allowed(
|
||||||
event: "synapse.events.EventBase",
|
event: "synapse.events.EventBase",
|
||||||
|
@ -51,6 +53,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `on_create_room`
|
### `on_create_room`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def on_create_room(
|
async def on_create_room(
|
||||||
requester: "synapse.types.Requester",
|
requester: "synapse.types.Requester",
|
||||||
|
@ -76,6 +80,8 @@ callback.
|
||||||
|
|
||||||
### `check_threepid_can_be_invited`
|
### `check_threepid_can_be_invited`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_threepid_can_be_invited(
|
async def check_threepid_can_be_invited(
|
||||||
medium: str,
|
medium: str,
|
||||||
|
@ -94,6 +100,8 @@ any of the subsequent implementations of this callback.
|
||||||
|
|
||||||
### `check_visibility_can_be_modified`
|
### `check_visibility_can_be_modified`
|
||||||
|
|
||||||
|
_First introduced in Synapse v1.39.0_
|
||||||
|
|
||||||
```python
|
```python
|
||||||
async def check_visibility_can_be_modified(
|
async def check_visibility_can_be_modified(
|
||||||
room_id: str,
|
room_id: str,
|
||||||
|
|
Loading…
Reference in New Issue