Mercurial > prosody-modules

annotate mod_muc_notifications/README.markdown @ 4300:3f3b672b7616

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_vcard_muc: Pass room object around instead of JID, hopefully fixing traceback More efficient to pass the object around instead of using the JID and looking up the object when needed. It seems in some (undetermined) cases get_room_from_jid(room.jid) is nil.
author Matthew Wild <mwild1@gmail.com>
date Tue, 15 Dec 2020 10:49:11 +0000
parents 69219097aa85
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3498
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
1 ---
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
2 labels:
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
3 - 'Stage-alpha'
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
4 summary: 'Notify of MUC messages to not present members'
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
5 ...
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
6
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
7 Introduction
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
8 ============
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
9
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
10 This module listens to MUC messages and sends a notification to the
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
11 MUC members not present in the MUC at that moment.
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
12
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
13 By default, the notification will be a message with a simple text as body.
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
14
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
15 By sending this "out-of-MUC" notification, not-joined members will be able to
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
16 know that new messages are available.
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
17
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
18 Usage
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
19 =====
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
20
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
21 First copy the module to the prosody plugins directory.
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
22
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
23 Then add "muc\_notifications" to your modules\_enabled list in your
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
24 MUC component:
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
25
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
26 ```{.lua}
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
27 Component "conference.example.org" "muc"
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
28 modules_enabled = {
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
29 "muc_notifications",
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
30 }
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
31 ```
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
32
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
33 You may also want to enable "offline\_hints" module so the notification messages
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
34 sent by this module are not added to the offline storage for later delivery.
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
35
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
36 Configuration
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
37 =============
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
38
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
39 Option Description
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
40 --------------------------- ----------------------------------------------------------------------------------------------
69219097aa85 muc_notifications: notify non-present members of new messages
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
41 muc\_notification\_invite If set to `true`, the notification sent will take the form of a MUC invite. (default: `false`)