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
parent: 3972:45c5603a6c07
child: 4337:83f89ffe427b
--- a/mod_muc_markers/README.markdown	Sun May 17 22:38:55 2020 +0200
+++ b/mod_muc_markers/README.markdown	Tue May 19 14:06:42 2020 +0100
@@ -1,6 +1,6 @@
 # Introduction
 
-This module adds an internal Prosody API to retrieve the last received message by MUC occupants.
+This module adds an internal Prosody API to retrieve the last displayed message by MUC occupants.
 
 ## Requirements
 
@@ -26,7 +26,9 @@
 
 ## Settings
 
-There are no configuration options for this module.
+| Name            | Description                                                  | Default    |
+|-----------------|--------------------------------------------------------------|------------|
+| muc_marker_type | The type of marker to track (displayed/received/acknowledged)| "displayed"|
 
 # Developers
 
@@ -36,6 +38,6 @@
 local muc_markers = module:depends("muc_markers");
 
 function something()
-	local last_received_id = muc_markers.get_user_read_marker("user@localhost", "room@conference.localhost");
+	local last_displayed_id = muc_markers.get_user_read_marker("user@localhost", "room@conference.localhost");
 end
 ```