diff --git a/develop/modules/media_repository_callbacks.html b/develop/modules/media_repository_callbacks.html index acec306142..1f75a9c6f2 100644 --- a/develop/modules/media_repository_callbacks.html +++ b/develop/modules/media_repository_callbacks.html @@ -168,6 +168,10 @@ using the module API's register_media_repository_callbacks method.<

First introduced in Synapse v1.132.0

async def get_media_config_for_user(user_id: str) -> Optional[JsonDict]
+

+Caution: This callback is currently experimental . The method signature or behaviour +may change without notice. +

Called when processing a request from a client for the media config endpoint.

The arguments passed to this callback are:

@@ -185,6 +189,10 @@ any of the subsequent implementations of this callback.

First introduced in Synapse v1.132.0

async def is_user_allowed_to_upload_media_of_size(user_id: str, size: int) -> bool
+

+Caution: This callback is currently experimental . The method signature or behaviour +may change without notice. +

Called before media is accepted for upload from a user, in case the module needs to enforce a different limit for the particular user.

The arguments passed to this callback are:

diff --git a/develop/modules/ratelimit_callbacks.html b/develop/modules/ratelimit_callbacks.html index 6eec50c3d0..b2fa8fd400 100644 --- a/develop/modules/ratelimit_callbacks.html +++ b/develop/modules/ratelimit_callbacks.html @@ -168,6 +168,10 @@ Synapse is running. Ratelimit callbacks can be registered using the module API's

First introduced in Synapse v1.132.0

async def get_ratelimit_override_for_user(user: str, limiter_name: str) -> Optional[synapse.module_api.RatelimitOverride]
+

+Caution: This callback is currently experimental . The method signature or behaviour +may change without notice. +

Called when constructing a ratelimiter of a particular type for a user. The module can return a messages_per_second and burst_count to be used, or None if the default settings are adequate. The user is represented by their Matrix user ID diff --git a/develop/modules/spam_checker_callbacks.html b/develop/modules/spam_checker_callbacks.html index 78222b6eb2..ae1e86a5d8 100644 --- a/develop/modules/spam_checker_callbacks.html +++ b/develop/modules/spam_checker_callbacks.html @@ -386,6 +386,10 @@ this callback.

First introduced in Synapse v1.132.0

async def user_may_send_state_event(user_id: str, room_id: str, event_type: str, state_key: str, content: JsonDict) -> Union["synapse.module_api.NOT_SPAM", "synapse.module_api.errors.Codes"]
+

+Caution: This callback is currently experimental . The method signature or behaviour +may change without notice. +

Called when processing a request to send state events to a room.

The arguments passed to this callback are: