From 9284fce98bc0eefa36246ef67139e83b693c1e42 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Fri, 20 Oct 2023 10:15:24 -0400 Subject: [PATCH] Clarify presence router docs. --- docs/modules/presence_router_callbacks.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/modules/presence_router_callbacks.md b/docs/modules/presence_router_callbacks.md index d3da25cef413..896ea6187216 100644 --- a/docs/modules/presence_router_callbacks.md +++ b/docs/modules/presence_router_callbacks.md @@ -1,8 +1,14 @@ # 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 updates presence updates from local users. The additional users +can be local or remote. + +For example, it could be used to have `alice` receive all presence updates from +`bob` even though they don't share a room. + +Presence router callbacks can be registered using the module API's +`register_presence_router_callbacks` method. ## Callbacks