Mercurial > prosody-modules

diff mod_muc_mam_markers/README.markdown @ 3499:a1fc677d0cc8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
muc_mam_markers: store chat markers in the Group Chat archives By enabling this module, messages containing XEP-0333 Chat Markers addressed to a Group Chat, will get stored in the archive.
author marc0s <marcos.devera@quobis.com>
date Fri, 29 Mar 2019 17:04:45 +0100
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_muc_mam_markers/README.markdown	Fri Mar 29 17:04:45 2019 +0100
@@ -0,0 +1,24 @@
+---
+labels:
+- 'Stage-alpha'
+summary: Save received chat markers into MUC archives'
+...
+
+Introduction
+============
+
+Chat markers (XEP-0333) specification states that markers _SHOULD_ be
+archived.  This is already happening in one to one conversations in
+the personal archives but not in Group Chats.  This module hooks the
+_muc-message-is-historic_ event to customize the `mod_muc_mam`
+behavior and have the chat markers archived.
+
+Usage
+=====
+
+First copy the module to the prosody plugins directory.
+
+Then add "muc\_mam\_markers" to your `modules\_enabled` list in your
+MUC component's definition.
+
+No configuration options are available.