Browse Source

Clarify presence router docs. (#16529)

Patrick Cloke 6 months ago
parent
commit
d2eab22de7
2 changed files with 12 additions and 3 deletions
  1. 1 0
      changelog.d/16529.doc
  2. 11 3
      docs/modules/presence_router_callbacks.md

+ 1 - 0
changelog.d/16529.doc

@@ -0,0 +1 @@
+Improve documentation of presence router.

+ 11 - 3
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