Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
erikjohnston committed Oct 25, 2023
1 parent 5d8fd17 commit f607aeb
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions docs/modules/add_extra_fields_to_client_events_unsigned.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Add extra fields to client events unsigned section callbacks

_First introduced in Synapse v1.96.0_

This callback allows modules to add extra fields to the unsigned section of
events when they get sent down to clients.

These get called *every* time an event is to be sent to clients, so care should
be taken to ensure with respect to performance.

### API

To register the callback, use
`register_add_extra_fields_to_unsigned_client_event_callbacks` on the
`ModuleApi`.

The callback should be of the form

```python
async def add_field_to_unsigned(
event: EventBase,
) -> JsonDict:
```

where the extra fields to add to the event's unsigned section is returned.
(Modules must not attempt to modify the `event` directly).

0 comments on commit f607aeb

Please sign in to comment.