mod_muc_mam_markers/README.markdown
author Matthew Wild <mwild1@gmail.com>
Sat, 24 Sep 2022 09:26:26 +0100
changeset 5063 5f1120c284c5
parent 3503 a1fc677d0cc8
permissions -rw-r--r--
mod_cloud_notify_extensions: Add note about dependency Noting here because people might not click through to see it on the mod_cloud_notify_encrypted page.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3503
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     1
---
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     2
labels:
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     3
- 'Stage-alpha'
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     4
summary: Save received chat markers into MUC archives'
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     5
...
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     6
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     7
Introduction
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     8
============
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
     9
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    10
Chat markers (XEP-0333) specification states that markers _SHOULD_ be
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    11
archived.  This is already happening in one to one conversations in
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    12
the personal archives but not in Group Chats.  This module hooks the
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    13
_muc-message-is-historic_ event to customize the `mod_muc_mam`
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    14
behavior and have the chat markers archived.
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    15
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    16
Usage
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    17
=====
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    18
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    19
First copy the module to the prosody plugins directory.
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    20
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    21
Then add "muc\_mam\_markers" to your `modules\_enabled` list in your
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    22
MUC component's definition.
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    23
a1fc677d0cc8 muc_mam_markers: store chat markers in the Group Chat archives
marc0s <marcos.devera@quobis.com>
parents:
diff changeset
    24
No configuration options are available.