From 281964e616979c6fb4edd4fb9661bc9905c2db3f Mon Sep 17 00:00:00 2001 From: reivilibre Date: Tue, 18 Apr 2023 08:53:52 +0000 Subject: deploy: ce007103030e281098cf4dccffed44581a32bd13 --- v1.82/modules/porting_legacy_module.html | 206 +++++++++++++++++++++++++++++++ 1 file changed, 206 insertions(+) create mode 100644 v1.82/modules/porting_legacy_module.html (limited to 'v1.82/modules/porting_legacy_module.html') diff --git a/v1.82/modules/porting_legacy_module.html b/v1.82/modules/porting_legacy_module.html new file mode 100644 index 0000000000..df9463345f --- /dev/null +++ b/v1.82/modules/porting_legacy_module.html @@ -0,0 +1,206 @@ + + + + + + Porting a legacy module to the new interface - Synapse + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + + +
+
+ +
+ +
+ +

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 +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 for +more info).

+

There is no longer a get_db_schema_files callback provided for password auth provider modules. Any +changes to the database should now be made by the module using the module API class.

+

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 +for more info).

+ +
+ + +
+
+ + + +
+ + + + + + + + + + + + + \ No newline at end of file -- cgit 1.5.1