diff options
| author | Andrew Morgan <1342360+anoadragon453@users.noreply.github.com> | 2023-02-22 16:05:34 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-02-22 16:05:34 +0000 |
| commit | 91f8de7b5601495589d47f236d5c5cc264078424 (patch) | |
| tree | d38dc3c115fa5266b01c16ec03b791af0add8eb8 | |
| parent | Remove unused `room_alias` field from `/createRoom` response (#15093) (diff) | |
| download | synapse-91f8de7b5601495589d47f236d5c5cc264078424.tar.xz | |
Clarify the workers that the ThirdPartyRules' `on_new_event` callback will run on (#15071)
| -rw-r--r-- | changelog.d/15071.doc | 1 | ||||
| -rw-r--r-- | docs/modules/third_party_rules_callbacks.md | 3 |
2 files changed, 4 insertions, 0 deletions
diff --git a/changelog.d/15071.doc b/changelog.d/15071.doc new file mode 100644 index 0000000000..7fbaba3e8c --- /dev/null +++ b/changelog.d/15071.doc @@ -0,0 +1 @@ +Clarify which worker processes the ThirdPartyRules' [`on_new_event`](https://matrix-org.github.io/synapse/v1.78/modules/third_party_rules_callbacks.html#on_new_event) module API callback runs on. \ No newline at end of file diff --git a/docs/modules/third_party_rules_callbacks.md b/docs/modules/third_party_rules_callbacks.md index e1a5b6524f..888e43bd10 100644 --- a/docs/modules/third_party_rules_callbacks.md +++ b/docs/modules/third_party_rules_callbacks.md @@ -146,6 +146,9 @@ Note that this callback is called when the event has already been processed and into the room, which means this callback cannot be used to deny persisting the event. To deny an incoming event, see [`check_event_for_spam`](spam_checker_callbacks.md#check_event_for_spam) instead. +For any given event, this callback will be called on every worker process, even if that worker will not end up +acting on that event. This callback will not be called for events that are marked as rejected. + If multiple modules implement this callback, Synapse runs them all in order. ### `check_can_shutdown_room` |