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

index 472d957180..d0db863ff8 100644 --- a/docs/modules/spam_checker_callbacks.md +++ b/docs/modules/spam_checker_callbacks.md
@@ -18,6 +18,17 @@ async def check_event_for_spam(event: "synapse.events.EventBase") -> Union[bool, Called when receiving an event from a client or via federation. The callback must return either: + - on `Decision.ALLOW`, the action is permitted. + - on `Decision.DENY`, the action is rejected with a default error message/code. + - on `Codes`, the action is rejected with a specific error message/code. In case + of doubt, use `Codes.FORBIDDEN`. + - (deprecated) on `False`, behave as `Decision.ALLOW`. Deprecated as methods in + this API are inconsistent, some expect `True` for `ALLOW` and others `True` + for `DENY`. + - (deprecated) on `True`, behave as `Decision.DENY`. Deprecated as methods in + this API are inconsistent, some expect `True` for `ALLOW` and others `True` + for `DENY`. + - an error message string, to indicate the event must be rejected because of spam and give a rejection reason to forward to clients; - the boolean `True`, to indicate that the event is spammy, but not provide further details; or