Mercurial > prosody-modules
view mod_muc_batched_probe/README.markdown @ 5907:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
parents | d56b3c0195a8 |
children |
line wrap: on
line source
# mod_muc_batched_probe This module allows you to probe the presences of multiple MUC occupants or members. XEP-0045 makes provision for MUC presence probes, which allows an entity to probe for the presence information of a MUC occupant (or offline member). See here: https://xmpp.org/extensions/xep-0045.html#bizrules-presence This module creates the possibility to probe with a single IQ stanza the presence information of multiple JIDs, instead of having to send out a presence probe stanza per JID. The IQ stanza needs to look as follows: ``` <iq from="hag66@shakespeare.lit/pda" id="zb8q41f4" to="chat.shakespeare.lit" type="get"> <query xmlns="http://jabber.org/protocol/muc#user"> <item jid="hecate@shakespeare.lit"/> <item jid="crone1@shakespeare.lit"/> <item jid="wiccarocks@shakespeare.lit"/> <item jid="hag66@shakespeare.lit"/> </query> </iq> ``` ## Configuration Under your MUC component, add `muc_batched_probe` to `modules_enabled` ``` Component "conference.example.org" "muc" modules_enabled = { "muc_batched_probe"; } ``` ## Client Support Converse.js has a plugin which supports this feature. https://www.npmjs.com/package/@converse-plugins/muc-presence-probe