Matrix-Mirrors/anonymousland-synapse
1
0
Fork 0
mirror of https://git.anonymousland.org/anonymousland/synapse.git synced 2025-12-15 23:43:53 -05:00
Code Issues Projects Releases Packages Wiki Activity

Improve the modules doc (#10758)

Browse source 
* Split up the documentation in several files rather than one huge one
* Add examples for each callback category
* Other niceties like fixing https://github.com/matrix-org/synapse/issues/10632
* Add titles to callbacks so they're easier to find in the navigation panels and link to
This commit is contained in:
Brendan Abolivier 2021-09-08 19:14:54 +02:00 • committed by GitHub
parent 01df612e1e
commit 03caba6577
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 537 additions and 404 deletions
Download patch file Download diff file Expand all files Collapse all files

17
docs/modules/porting_legacy_module.md Normal file
View file

@ -0,0 +1,17 @@
# Porting an existing module that uses the old interface
In order to port a module that uses Synapse's old module interface, its author needs to:
* ensure the module's callbacks are all asynchronous.
* register their callbacks using one or more of the `register_[...]_callbacks` methods
from the `ModuleApi` class in the module's `__init__` method (see [this section](writing_a_module.html#registering-a-callback)
for more info).
Additionally, if the module is packaged with an additional web resource, the module
should register this resource in its `__init__` method using the `register_web_resource`
method from the `ModuleApi` class (see [this section](writing_a_module.html#registering-a-web-resource) for
more info).
The module's author should also update any example in the module's configuration to only
use the new `modules` section in Synapse's configuration file (see [this section](index.html#using-modules)
for more info).