Mercurial > prosody-modules

comparison mod_muc_markers/README.markdown @ 4024:95882b487ed2

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_markers: Allow configuration of which marker to track, default to displayed
author Matthew Wild <mwild1@gmail.com>
date Tue, 19 May 2020 14:06:42 +0100
parents 45c5603a6c07
children 83f89ffe427b
comparison
equal deleted inserted replaced
4023:7e2db4d61f6c 4024:95882b487ed2
1 # Introduction 1 # Introduction
2 2
3 This module adds an internal Prosody API to retrieve the last received message by MUC occupants. 3 This module adds an internal Prosody API to retrieve the last displayed message by MUC occupants.
4 4
5 ## Requirements 5 ## Requirements
6 6
7 The clients must support XEP-0333, and the users to be tracked must be affiliated with the room. 7 The clients must support XEP-0333, and the users to be tracked must be affiliated with the room.
8 8
24 } 24 }
25 ``` 25 ```
26 26
27 ## Settings 27 ## Settings
28 28
29 There are no configuration options for this module. 29 | Name | Description | Default |
30 |-----------------|--------------------------------------------------------------|------------|
31 | muc_marker_type | The type of marker to track (displayed/received/acknowledged)| "displayed"|
30 32
31 # Developers 33 # Developers
32 34
33 ## Example usage 35 ## Example usage
34 36
35 ``` 37 ```
36 local muc_markers = module:depends("muc_markers"); 38 local muc_markers = module:depends("muc_markers");
37 39
38 function something() 40 function something()
39 local last_received_id = muc_markers.get_user_read_marker("user@localhost", "room@conference.localhost"); 41 local last_displayed_id = muc_markers.get_user_read_marker("user@localhost", "room@conference.localhost");
40 end 42 end
41 ``` 43 ```