Mercurial > prosody-modules

annotate mod_groups_internal/README.md @ 6152:8f52eb411737

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_groups_internal: Use syntax closer to Lua in README
author Rémi Bardon <remi@remibardon.name>
date Fri, 31 Jan 2025 02:09:38 +0100
parents 5250e4cb0b1a
children 9122d5a246c2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
1 ---
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
2 labels:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
3 - 'Stage-Beta'
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
4 summary: Equivalent of mod_groups but without a configuration file
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
5 ---
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
6
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
7 ## Introduction
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
8
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
9 This module is functionally similar to [`mod_groups`], but it differs by working without a configuration file (allowing changes without a restart of the server) and by permanently adding users to each other's contact lists. To paraphrase [`mod_groups`]:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
10
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
11 > `mod_groups_internal` was designed to allow administrators to create virtual groups of users that automatically see each other in their contact lists. There is no need for the user to authorise these contacts in their contact list - this is done automatically on the server.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
12 >
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
13 > As an example, if you have a team of people working together on a project, you can create a group for that team. They will automatically be added to each others' contact lists, and the list can easily be modified on the server at any time to add and remove people.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
14
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
15 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
16 On `user-deleted` events, `mod_groups_internal` will automatically remove the deleted user from every group they were part of.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
17 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
18
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
19 ## Setup
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
20
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
21 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
22 modules_enabled = {
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
23 -- Other modules
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
24 "groups_internal"; -- Enable mod_groups_internal
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
25 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
26 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
27
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
28 ## Configuration
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
29
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
30 ### `groups_muc_host` {#groups_muc_host}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
31
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
32 | Option | Default | Notes |
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
33 | ------ | ------- | ----- |
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
34 | `groups_muc_host` | `groups.<module.host>` | Host where the group chats will be created. |
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
35
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
36 ## Usage
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
37
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
38 ### Exposed functions
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
39
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
40 #### `create(group_info, create_default_muc, group_id)` {#create}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
41
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
42 Creates a new group, optionally creating a default MUC chat on [`groups_muc_host`](#groups_muc_host).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
43
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
44 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
45
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
46 1. `group_info: { name: string }`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
47 2. `create_default_muc: boolean | nil`: Whether or not to create the default MUC chat. Defaults to `false`.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
48 3. `group_id: string | nil`: The desired group JID node part. Defaults to [`util.id.short`](https://prosody.im/doc/developers/util/id) (9-chars URL-safe base64).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
49
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
50 **Returns:** `group_id: string | nil, error: string`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
51
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
52 #### `get_info(group_id)` {#get_info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
53
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
54 Retrieves information about a group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
55
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
56 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
57
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
58 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
59
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
60 **Returns:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
61
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
62 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
63 group_info: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
64 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
65 muc_jid: string | nil
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
66 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
67 | nil
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
68 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
69
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
70 #### `set_info(group_id, info)` {#set_info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
71
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
72 Allows one to change a group's name. If `muc_jid` is specified, this function will also update the group chat's name.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
73
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
74 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
75
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
76 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
77 2. `group_info: { name: string, muc_jid: string | nil }`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
78
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
79 **Returns:** `true | nil, error: string`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
80
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
81 #### `get_members(group_id)` {#get_members}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
82
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
83 Retrieves the list of members in a given group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
84
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
85 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
86
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
87 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
88
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
89 **Returns:** `group_members: {string}`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
90
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
91 #### `exists(group_id)` {#exists}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
92
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
93 Returns whether or not a group exists.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
94
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
95 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
96
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
97 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
98
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
99 **Returns:** `group_exists: boolean`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
100
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
101 #### `get_user_groups(username)` {#get_user_groups}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
102
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
103 Lists which groups a given user is a part of.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
104
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
105 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
106
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
107 1. `username: string`: Node part of the user's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
108
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
109 **Returns:** `user_groups: {string}`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
110
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
111 #### `delete(group_id)` {#delete}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
112
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
113 Deletes a given group and its associated group chats.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
114
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
115 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
116
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
117 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
118
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
119 **Returns:** `true | nil, error: string`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
120
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
121 #### `add_member(group_id, username, delay_update)` {#add_member}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
122
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
123 Adds a member to a given group, optionally delaying subscriptions until [`sync`](#sync) is called.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
124
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
125 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
126 This function emits a [`group-user-added`](#group-user-added) event on successful execution.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
127 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
128
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
129 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
130
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
131 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
132 2. `delay_update: boolean | nil`: Do not update subscriptions until [`sync`](#sync) is called. Defaults to `false`.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
133
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
134 **Returns:** `true | nil, error: string`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
135
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
136 #### `remove_member(group_id, username)` {#remove_member}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
137
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
138 Removes a member from a given group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
139
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
140 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
141 This function emits a [`group-user-removed`](#group-user-removed) event on successful execution.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
142 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
143
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
144 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
145
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
146 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
147 2. `username: string`: Node part of the user's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
148
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
149 **Returns:** `true | nil, error: string`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
150
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
151 #### `sync(group_id)` {#sync}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
152
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
153 Updates group subscriptions (used to apply pending changes from [`add_member`](#add_member)).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
154
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
155 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
156
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
157 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
158
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
159 **Returns:** `nil`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
160
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
161 #### `add_group_chat(group_id, name)` {#add_group_chat}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
162
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
163 Creates a new group chat for a given group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
164
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
165 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
166 Its JID will be `<`[`util.id.short`](https://prosody.im/doc/developers/util/id)`>@<`[`option:groups_muc_host`](#groups_muc_host)`>`.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
167 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
168
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
169 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
170
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
171 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
172 2. `name: string`: Desired name of the group chat.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
173
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
174 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
175
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
176 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
177 muc: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
178 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
179 name: string,
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
180 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
181 | nil, error: string
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
182 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
183
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
184 #### `remove_group_chat(group_id, muc_id)` {#remove_group_chat}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
185
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
186 Removes a group chat for a given group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
187
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
188 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
189 This function emits a [`group-chat-removed`](#group-chat-removed) event on successful execution.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
190 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
191
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
192 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
193
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
194 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
195 2. `muc_id: string`: Node part of the MUC JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
196
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
197 **Returns:** `true | nil, error: string`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
198
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
199 #### `get_group_chats(group_id)` {#get_group_chats}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
200
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
201 Lists group chats associated to a given group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
202
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
203 ::: {.alert .alert-warning}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
204 Make sure to check the `deleted` property on each chat as this function might return information about deleted chats.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
205 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
206
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
207 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
208
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
209 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
210
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
211 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
212
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
213 ```lua
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
214 group_chats: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
215 {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
216 id: string, -- muc_id (node part of the MUC JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
217 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
218 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
219 deleted: boolean,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
220 }
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
221 }
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
222 | nil
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
223 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
224
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
225 #### `emit_member_events(group_id)` {#emit_member_events}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
226
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
227 Emits [`group-user-added`](#group-user-added) events for every member of a group.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
228
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
229 **Parameters:**
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
230
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
231 1. `group_id: string`: Node part of the group's JID.
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
232
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
233 **Returns:** `true | false, error: string`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
234
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
235 #### `groups()` {#groups}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
236
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
237 Returns info about all groups (for every `group_id` key, the value is the equivalent of calling `get_info(group_id)`).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
238
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
239 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
240
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
241 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
242 groups: {
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
243 <group_id>: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
244 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
245 muc_jid: string | nil
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
246 }
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
247 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
248 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
249
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
250 (Where `<group_id>` is a
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
251
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
252 ### Emitted events {#events}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
253
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
254 #### `group-user-added` {#group-user-added}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
255
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
256 Emitted on successful [`add_member`](#add_member) and on [`emit_member_events`](#emit_member_events).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
257
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
258 Payload structure:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
259
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
260 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
261 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
262 id: string, -- group_id (node part of the group's JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
263 user: string, -- username (node part of the user's JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
264 host: string, -- <module.host>
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
265 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
266 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
267 muc_jid: string | nil,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
268 mucs: {string} | nil,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
269 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
270 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
271 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
272
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
273 #### `group-user-removed` {#group-user-removed}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
274
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
275 Emitted on successful [`remove_member`](#remove_member).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
276
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
277 Payload structure:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
278
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
279 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
280 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
281 id: string, -- group_id (node part of the group's JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
282 user: string, -- username (node part of the user's JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
283 host: string, -- <module.host>
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
284 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
285 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
286 muc_jid: string | nil,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
287 mucs: {string} | nil,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
288 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
289 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
290 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
291
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
292 #### `group-chat-added` {#group-chat-added}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
293
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
294 Emitted on successful [`add_group_chat`](#add_group_chat).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
295
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
296 Payload structure:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
297
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
298 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
299 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
300 group_id: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
301 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
302 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
303 mucs: {string},
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
304 },
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
305 muc: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
306 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
307 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
308 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
309 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
310 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
311
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
312 #### `group-chat-removed` {#group-chat-removed}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
313
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
314 Emitted on successful [`remove_group_chat`](#remove_group_chat).
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
315
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
316 Payload structure:
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
317
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
318 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
319 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
320 group_id: string, -- group_id (node part of the group's JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
321 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
322 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
323 mucs: {string},
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
324 },
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
325 muc: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
326 id: string, -- muc_id (node part of the MUC JID)
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
327 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
328 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
329 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
330 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
331
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
332 [`mod_groups`]: https://prosody.im/doc/modules/mod_groups "mod_groups – Prosody IM"