prosody-modules
d56b3c0195a8
mod_muc_batched_probe/README.markdown

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Comparison

mod_muc_batched_probe/README.markdown @ 4000:d56b3c0195a8

mod_muc_batched_probe: New module
author JC Brand <jc@opkode.com>
date Wed, 29 Apr 2020 13:00:22 +0200
comparison
equal deleted inserted replaced
3999:22784f001b7f 4000:d56b3c0195a8
1 # mod_muc_batched_probe
2
3 This module allows you to probe the presences of multiple MUC occupants or members.
4
5 XEP-0045 makes provision for MUC presence probes, which allows an entity to
6 probe for the presence information of a MUC occupant (or offline member).
7
8 See here: https://xmpp.org/extensions/xep-0045.html#bizrules-presence
9
10 This module creates the possibility to probe with a single IQ stanza the
11 presence information of multiple JIDs, instead of having to send out a presence
12 probe stanza per JID.
13
14 The IQ stanza needs to look as follows:
15
16 ```
17 <iq from="hag66@shakespeare.lit/pda"
18 id="zb8q41f4"
19 to="chat.shakespeare.lit"
20 type="get">
21
22 <query xmlns="http://jabber.org/protocol/muc#user">
23 <item jid="hecate@shakespeare.lit"/>
24 <item jid="crone1@shakespeare.lit"/>
25 <item jid="wiccarocks@shakespeare.lit"/>
26 <item jid="hag66@shakespeare.lit"/>
27 </query>
28 </iq>
29 ```
30
31
32
33 ## Configuration
34
35 Under your MUC component, add `muc_batched_probe` to `modules_enabled`
36
37 ```
38 Component "conference.example.org" "muc"
39 modules_enabled = {
40 "muc_batched_probe";
41 }
42 ```
43
44
45 ## Client Support
46
47 Converse.js has a plugin which supports this feature.
48
49 https://www.npmjs.com/package/@converse-plugins/muc-presence-probe