This commit is contained in:
babolivier 2021-11-29 16:57:36 +00:00
parent 485ea9b1f5
commit 623cd1e99b
4 changed files with 14 additions and 14 deletions

View file

@ -233,14 +233,14 @@ configuration file takes priority.</p>
<p>Modules <strong>must</strong> register their web resources in their <code>__init__</code> method.</p> <p>Modules <strong>must</strong> register their web resources in their <code>__init__</code> method.</p>
<h2 id="registering-a-callback"><a class="header" href="#registering-a-callback">Registering a callback</a></h2> <h2 id="registering-a-callback"><a class="header" href="#registering-a-callback">Registering a callback</a></h2>
<p>Modules can use Synapse's module API to register callbacks. Callbacks are functions that <p>Modules can use Synapse's module API to register callbacks. Callbacks are functions that
Synapse will call when performing specific actions. Callbacks must be asynchronous, and Synapse will call when performing specific actions. Callbacks must be asynchronous (unless
are split in categories. A single module may implement callbacks from multiple categories, specified otherwise), and are split in categories. A single module may implement callbacks
and is under no obligation to implement all callbacks from the categories it registers from multiple categories, and is under no obligation to implement all callbacks from the
callbacks for.</p> categories it registers callbacks for.</p>
<p>Modules can register callbacks using one of the module API's <code>register_[...]_callbacks</code> <p>Modules can register callbacks using one of the module API's <code>register_[...]_callbacks</code>
methods. The callback functions are passed to these methods as keyword arguments, with methods. The callback functions are passed to these methods as keyword arguments, with
the callback name as the argument name and the function as its value. This is demonstrated the callback name as the argument name and the function as its value. A
in the example below. A <code>register_[...]_callbacks</code> method exists for each category.</p> <code>register_[...]_callbacks</code> method exists for each category.</p>
<p>Callbacks for each category can be found on their respective page of the <p>Callbacks for each category can be found on their respective page of the
<a href="https://matrix-org.github.io/synapse">Synapse documentation website</a>.</p> <a href="https://matrix-org.github.io/synapse">Synapse documentation website</a>.</p>

View file

@ -7861,14 +7861,14 @@ configuration file takes priority.</p>
<p>Modules <strong>must</strong> register their web resources in their <code>__init__</code> method.</p> <p>Modules <strong>must</strong> register their web resources in their <code>__init__</code> method.</p>
<h2 id="registering-a-callback"><a class="header" href="#registering-a-callback">Registering a callback</a></h2> <h2 id="registering-a-callback"><a class="header" href="#registering-a-callback">Registering a callback</a></h2>
<p>Modules can use Synapse's module API to register callbacks. Callbacks are functions that <p>Modules can use Synapse's module API to register callbacks. Callbacks are functions that
Synapse will call when performing specific actions. Callbacks must be asynchronous, and Synapse will call when performing specific actions. Callbacks must be asynchronous (unless
are split in categories. A single module may implement callbacks from multiple categories, specified otherwise), and are split in categories. A single module may implement callbacks
and is under no obligation to implement all callbacks from the categories it registers from multiple categories, and is under no obligation to implement all callbacks from the
callbacks for.</p> categories it registers callbacks for.</p>
<p>Modules can register callbacks using one of the module API's <code>register_[...]_callbacks</code> <p>Modules can register callbacks using one of the module API's <code>register_[...]_callbacks</code>
methods. The callback functions are passed to these methods as keyword arguments, with methods. The callback functions are passed to these methods as keyword arguments, with
the callback name as the argument name and the function as its value. This is demonstrated the callback name as the argument name and the function as its value. A
in the example below. A <code>register_[...]_callbacks</code> method exists for each category.</p> <code>register_[...]_callbacks</code> method exists for each category.</p>
<p>Callbacks for each category can be found on their respective page of the <p>Callbacks for each category can be found on their respective page of the
<a href="https://matrix-org.github.io/synapse">Synapse documentation website</a>.</p> <a href="https://matrix-org.github.io/synapse">Synapse documentation website</a>.</p>
<div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="spam-checker-callbacks"><a class="header" href="#spam-checker-callbacks">Spam checker callbacks</a></h1> <div id="chapter_begin" style="break-before: page; page-break-before: always;"></div><h1 id="spam-checker-callbacks"><a class="header" href="#spam-checker-callbacks">Spam checker callbacks</a></h1>

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long