This commit is contained in:
reivilibre 2021-11-01 15:46:26 +00:00
parent 58d50be301
commit 2e585f0be7
4 changed files with 14 additions and 2 deletions

View file

@ -215,6 +215,12 @@ servers are using the same module, with the same configuration.</p>
event with new data by returning the new event's data as a dictionary. In order to do event with new data by returning the new event's data as a dictionary. In order to do
that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a
dictionary, and modify the returned dictionary accordingly.</p> dictionary, and modify the returned dictionary accordingly.</p>
<p>If <code>check_event_allowed</code> raises an exception, the module is assumed to have failed.
The event will not be accepted but is not treated as explicitly rejected, either.
An HTTP request causing the module check will likely result in a 500 Internal
Server Error.</p>
<p>When the boolean returned by the module is <code>False</code>, the event is rejected.
(Module developers should not use exceptions for rejection.)</p>
<p>Note that replacing the event only works for events sent by local users, not for events <p>Note that replacing the event only works for events sent by local users, not for events
received over federation.</p> received over federation.</p>
<p>If multiple modules implement this callback, they will be considered in order. If a <p>If multiple modules implement this callback, they will be considered in order. If a

View file

@ -8052,6 +8052,12 @@ servers are using the same module, with the same configuration.</p>
event with new data by returning the new event's data as a dictionary. In order to do event with new data by returning the new event's data as a dictionary. In order to do
that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a that, it is recommended the module calls <code>event.get_dict()</code> to get the current event as a
dictionary, and modify the returned dictionary accordingly.</p> dictionary, and modify the returned dictionary accordingly.</p>
<p>If <code>check_event_allowed</code> raises an exception, the module is assumed to have failed.
The event will not be accepted but is not treated as explicitly rejected, either.
An HTTP request causing the module check will likely result in a 500 Internal
Server Error.</p>
<p>When the boolean returned by the module is <code>False</code>, the event is rejected.
(Module developers should not use exceptions for rejection.)</p>
<p>Note that replacing the event only works for events sent by local users, not for events <p>Note that replacing the event only works for events sent by local users, not for events
received over federation.</p> received over federation.</p>
<p>If multiple modules implement this callback, they will be considered in order. If a <p>If multiple modules implement this callback, they will be considered in order. If a

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long