diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2020-10-07 12:03:26 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-07 12:03:26 +0100 |
| commit | 4f0637346a194a3343b4fea6cf38c1548e56648d (patch) | |
| tree | f0aec40f179e6cb5648df8797e4c15e791e37ec6 /docs/spam_checker.md | |
| parent | Remove docs/sphinx and related references (#8480) (diff) | |
| download | synapse-4f0637346a194a3343b4fea6cf38c1548e56648d.tar.xz | |
Combine `SpamCheckerApi` with the more generic `ModuleApi`. (#8464)
Lots of different module apis is not easy to maintain. Rather than adding yet another ModuleApi(hs, hs.get_auth_handler()) incantation, first add an hs.get_module_api() method and use it where possible.
Diffstat (limited to 'docs/spam_checker.md')
| -rw-r--r-- | docs/spam_checker.md | 9 |
1 files changed, 3 insertions, 6 deletions
diff --git a/docs/spam_checker.md b/docs/spam_checker.md index eb10e115f9..7fc08f1b70 100644 --- a/docs/spam_checker.md +++ b/docs/spam_checker.md @@ -11,7 +11,7 @@ able to be imported by the running Synapse. The Python class is instantiated with two objects: * Any configuration (see below). -* An instance of `synapse.spam_checker_api.SpamCheckerApi`. +* An instance of `synapse.module_api.ModuleApi`. It then implements methods which return a boolean to alter behavior in Synapse. @@ -26,11 +26,8 @@ well as some specific methods: The details of the each of these methods (as well as their inputs and outputs) are documented in the `synapse.events.spamcheck.SpamChecker` class. -The `SpamCheckerApi` class provides a way for the custom spam checker class to -call back into the homeserver internals. It currently implements the following -methods: - -* `get_state_events_in_room` +The `ModuleApi` class provides a way for the custom spam checker class to +call back into the homeserver internals. ### Example |