Mercurial > prosody-modules

comparison mod_muc_offline_delivery/README.md @ 4339:3b7847c9bd26

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_deliver_offline: New module for delivery of MUC messages to offline users
author Matthew Wild <mwild1@gmail.com>
date Fri, 15 Jan 2021 18:57:12 +0000
parents
children
comparison
equal deleted inserted replaced
4338:0227fb4d1b40 4339:3b7847c9bd26
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: 'Support for sending MUC messages to offline users'
5 ...
6
7 Introduction
8 ============
9
10 This module implements support for sending messages in a MUC to affiliated users
11 who are not in the room. This is a custom extension by Tigase to allow push notifications
12 from MUCs to users who are not currently connected.
13
14 It is planned that this will evolve to a XEP in the near future.
15
16 The protocol is described below. It is implemented in the Siskin client for iOS.
17
18 Details
19 =======
20
21 Add to modules_enabled under your MUC component (i.e. **not** the global modules_enabled
22 list). There are no configuration options.
23
24 Compatibility
25 =============
26
27 Requires Prosody trunk (0.12) for the API introduced in commit 336cba957c88.
28
29 Protocol
30 ========
31
32 To enable this feature, a client must fetch the registration form from a MUC,
33 as per XEP-0045. The form will include the usual field for nickname (this is
34 required), and also a boolean field named `{http://tigase.org/protocol/muc}offline`.
35
36 Submit the form with that field set to true, and the MUC will forward messages
37 to your bare JID when you are not connected to the room. Two things to note:
38
39 1. This will achieve nothing unless your server is capable of handling these
40 messages correctly.
41 2. Messages are only sent when you are not in the room. This includes other
42 resources of the same account.