diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2023-10-20 11:40:26 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-10-20 11:40:26 -0400 |
| commit | d2eab22de7543b62d5ac8d334160697ede37fabb (patch) | |
| tree | d7478efb6f75aee39f99933e338f56f1c078b1ee | |
| parent | Mark sync as limited if there is a gap in the timeline (#16485) (diff) | |
| download | synapse-d2eab22de7543b62d5ac8d334160697ede37fabb.tar.xz | |
Clarify presence router docs. (#16529)
| -rw-r--r-- | changelog.d/16529.doc | 1 | ||||
| -rw-r--r-- | docs/modules/presence_router_callbacks.md | 14 |
2 files changed, 12 insertions, 3 deletions
diff --git a/changelog.d/16529.doc b/changelog.d/16529.doc new file mode 100644 index 0000000000..0f8a87f293 --- /dev/null +++ b/changelog.d/16529.doc @@ -0,0 +1 @@ +Improve documentation of presence router. diff --git a/docs/modules/presence_router_callbacks.md b/docs/modules/presence_router_callbacks.md index d3da25cef4..b210f0e3cd 100644 --- a/docs/modules/presence_router_callbacks.md +++ b/docs/modules/presence_router_callbacks.md @@ -1,8 +1,16 @@ # Presence router callbacks -Presence router callbacks allow module developers to specify additional users (local or remote) -to receive certain presence updates from local users. Presence router callbacks can be -registered using the module API's `register_presence_router_callbacks` method. +Presence router callbacks allow module developers to define additional users +which receive presence updates from local users. The additional users +can be local or remote. + +For example, it could be used to direct all of `@alice:example.com` (a local user)'s +presence updates to `@bob:matrix.org` (a remote user), even though they don't share a +room. (Note that those presence updates might not make it to `@bob:matrix.org`'s client +unless a similar presence router is running on that homeserver.) + +Presence router callbacks can be registered using the module API's +`register_presence_router_callbacks` method. ## Callbacks |