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

Commit

Permalink
Clarify presence router docs. (#16529)
Browse files Browse the repository at this point in the history
  • Loading branch information
clokep authored Oct 20, 2023
1 parent e9069c9 commit d2eab22
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 3 deletions.
1 change: 1 addition & 0 deletions changelog.d/16529.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve documentation of presence router.
14 changes: 11 additions & 3 deletions docs/modules/presence_router_callbacks.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down

0 comments on commit d2eab22

Please sign in to comment.