prosody-modules
45c5603a6c07
mod_muc_markers/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_markers/README.markdown @ 3972:45c5603a6c07

mod_muc_markers: New module for server-side receipt tracking in MUCs
author Matthew Wild <mwild1@gmail.com>
date Mon, 13 Apr 2020 15:48:58 +0100
child 4024:95882b487ed2
comparison
equal deleted inserted replaced
3971:ae5ac41c391d 3972:45c5603a6c07
1 # Introduction
2
3 This module adds an internal Prosody API to retrieve the last received message by MUC occupants.
4
5 ## Requirements
6
7 The clients must support XEP-0333, and the users to be tracked must be affiliated with the room.
8
9 Currently due to lack of clarity about which id to use in acknowledgements in XEP-0333, this module
10 rewrites the id attribute of stanzas to match the stanza (archive) id assigned by the MUC server.
11
12 Oh yeah, and mod_muc_mam is required (or another module that adds a stanza-id), otherwise this module
13 won't do anything.
14
15 # Configuring
16
17 ## Enabling
18
19 ``` {.lua}
20 Component "rooms.example.net" "muc"
21 modules_enabled = {
22 "muc_markers";
23 "muc_mam";
24 }
25 ```
26
27 ## Settings
28
29 There are no configuration options for this module.
30
31 # Developers
32
33 ## Example usage
34
35 ```
36 local muc_markers = module:depends("muc_markers");
37
38 function something()
39 local last_received_id = muc_markers.get_user_read_marker("user@localhost", "room@conference.localhost");
40 end
41 ```