Mercurial > prosody-modules
comparison mod_muc_hats_adhoc/README.markdown @ 3948:11825788a452
mod_muc_hats_adhoc: Ad-hoc commands for adding/removing MUC hats
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 19 Mar 2020 14:51:44 +0000 |
| parents | |
| children | f02885673215 |
comparison
equal
deleted
inserted
replaced
| 3947:1f90e333b1d8 | 3948:11825788a452 |
|---|---|
| 1 --- | |
| 2 summary: API for managing MUC hats | |
| 3 --- | |
| 4 | |
| 5 # Introduction | |
| 6 | |
| 7 This module provides an internal API (i.e. to other modules) to manage | |
| 8 'hats' for users in MUC rooms. | |
| 9 | |
| 10 Hats (first defined in XEP-0317, currently deferred) are additional identifiers | |
| 11 that can be attached to users in a group chat. For example in an educational | |
| 12 context, you may have a 'Teacher' hat that allows students to identify their | |
| 13 teachers. | |
| 14 | |
| 15 Hats consist of a machine-readable unique identifier (a URI), and optionally | |
| 16 a human-readable label. | |
| 17 | |
| 18 This module provides ad-hoc commands for MUC service admins to add/remove hats | |
| 19 to/from users in MUC rooms. It depends (automatically) on mod_muc_hats_api. | |
| 20 | |
| 21 ## Configuration | |
| 22 | |
| 23 ``` | |
| 24 Component "conference.example.com" "muc" | |
| 25 modules_enabled = { "muc_hats_adhoc" } | |
| 26 ``` | |
| 27 | |
| 28 ## Usage | |
| 29 | |
| 30 To successfully use the module you will need to use an XMPP client that is | |
| 31 capable of sending commands to a specific host (e.g. via the service discovery | |
| 32 browser in Gajim, Psi/Psi+ and other clients), and you'll find the commands | |
| 33 on the MUC host. | |
| 34 | |
| 35 Also note that the display of hats in clients is currently non-existent, but | |
| 36 will hopefully improve after XEP-0317 is resurrected or replaced. | |
| 37 |