Mercurial > prosody-modules
annotate mod_muc_hats_api/README.markdown @ 5845:83ee752f148c
mod_push2: empty table instead of nil when not present
author | Stephen Paul Weber <singpolyma@singpolyma.net> |
---|---|
date | Sun, 25 Feb 2024 19:10:30 -0500 |
parents | e9e41e75c5a0 |
children |
rev | line source |
---|---|
3947
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 summary: API for managing MUC hats |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 --- |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 # Introduction |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 This module provides an internal API (i.e. to other modules) to manage |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 'hats' for users in MUC rooms. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 |
3950
e9e41e75c5a0
mod_muc_hats_*/README: Linkify XEP references
Kim Alvefur <zash@zash.se>
parents:
3947
diff
changeset
|
10 Hats (first defined in [XEP-0317], currently deferred) are additional identifiers |
3947
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 that can be attached to users in a group chat. For example in an educational |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 context, you may have a 'Teacher' hat that allows students to identify their |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 teachers. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 Hats consist of a machine-readable unique identifier (a URI), and optionally |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 a human-readable label. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 |
3950
e9e41e75c5a0
mod_muc_hats_*/README: Linkify XEP references
Kim Alvefur <zash@zash.se>
parents:
3947
diff
changeset
|
18 [XEP-0317] suggests a protocol for users to manage their own hats, but though the |
3947
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 API in this module allows for both user-managed and system-managed hats, there is |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 currently no protocol implemented for users to manage their own hats, which is |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 rarely desired in real-world implementations. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 The rest of this documentation is designed for developers who use this module. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 ## Data model |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 ### User |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
29 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
30 { |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
31 "hats": { |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
32 "urn:uuid:164c41a2-7461-4cff-bdae-3f93078a6607": { |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
33 "active": false |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
34 }, |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
35 "http://example.com/hats/foo": { |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
36 "active": true, |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
37 "required": true, |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
38 "title": "Awesome" |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
39 } |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
40 } |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
41 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
42 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
43 | Field | Type | Description | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
44 |-------|--------|--------------------------------------------------------------| |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
45 | hats | object | An object where mapping hat ids (key) to attachments (value) | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
46 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
47 Hat IDs must be a URI that uniquely identifies the hat. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
48 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
49 ### Attachment |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
50 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
51 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
52 { |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
53 "active": true, |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
54 "required": true, |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
55 "title": "My Awesome Hat" |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
56 } |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
57 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
58 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
59 | Field | Type | Description | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
60 |----------|---------|-------------------------------------------------------------| |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
61 | active | boolean | If true, indicates the user is currently displaying the hat | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
62 | required | boolean | If true, indicates the user is not able to remove the hat | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
63 | title | string | A human-readable display name or label for the hat | |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
64 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
65 All fields are optional, omitted boolean values are equivalent to false. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
66 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
67 ## API |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
68 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
69 All methods return 'nil, err' on failure as standard throughout the Prosody codebase. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
70 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
71 Example of using this module from another module: |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
72 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
73 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
74 local muc_hats = module:depends("muc_hats_api"); |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
75 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
76 muc_hats.add_user_hat("user@localhost", "room@conference.localhost", "urn:uuid:164c41a2-7461-4cff-bdae-3f93078a6607", { active = true }); |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
77 ``` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
78 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
79 Note that the module only works when loaded on a MUC host, which generally means any |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
80 module that uses it must also be loaded on the MUC host that it is managing. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
81 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
82 ### add_user_hat |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
83 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
84 `add_user_hat(user_jid, room_jid, hat_id, attachment)` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
85 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
86 Adds the identified hat to a user's... wardrobe? The user must already |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
87 have an affiliation with the room (i.e. member, admin or owner). |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
88 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
89 If `attachment` is omitted, it defaults to `{}`. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
90 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
91 #### Error cases |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
92 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
93 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
94 : Supplied room JID was not found on the current host |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
95 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
96 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
97 : Supplied user JID was not affiliated with the room |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
98 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
99 ### remove_user_hat |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
100 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
101 `remove_user_hat(user_jid, room_jid, hat_id)` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
102 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
103 If the identified hat is currently available to the user, it is removed. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
104 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
105 #### Error cases |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
106 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
107 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
108 : Supplied room JID was not found on the current host |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
109 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
110 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
111 : Supplied user JID was not affiliated with the room |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
112 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
113 ### set_user_hats |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
114 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
115 `set_user_hats(user_jid, room_jid, hats)` |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
116 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
117 Ensures the listed hats are the hats available to a user, automatically |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
118 adding/removing as necessary. |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
119 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
120 The `hats` parameter should be an object mapping hat ids (keys) to attachment |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
121 objects (values). |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
122 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
123 #### Error cases |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
124 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
125 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
126 : Supplied room JID was not found on the current host |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
127 |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
128 item-not-found |
1f90e333b1d8
mod_muc_hats_api: New API-only module for managing user hats in MUCs
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
129 : Supplied user JID was not affiliated with the room |