Mercurial > prosody-modules

annotate mod_groups_internal/README.md @ 6154:62ff93af69d5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_groups_internal: Remove broken links
author Rémi Bardon <remi@remibardon.name>
date Fri, 31 Jan 2025 02:13:19 +0100
parents 9122d5a246c2
children d0a117e11cb8
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
6153
9122d5a246c2 mod_groups_internal: Update groups_muc_host config documentation
Rémi Bardon <remi@remibardon.name>
parents: 6152
diff changeset
30 | Option | Type | Default | Notes |
9122d5a246c2 mod_groups_internal: Update groups_muc_host config documentation
Rémi Bardon <remi@remibardon.name>
parents: 6152
diff changeset
31 | ------ | ---- | ------- | ----- |
6154
62ff93af69d5 mod_groups_internal: Remove broken links
Rémi Bardon <remi@remibardon.name>
parents: 6153
diff changeset
32 | `groups_muc_host` | string? | nil | Host where the group chats will be created. |
6149
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 ## Usage
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 ### Exposed functions
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 #### `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
39
6154
62ff93af69d5 mod_groups_internal: Remove broken links
Rémi Bardon <remi@remibardon.name>
parents: 6153
diff changeset
40 Creates a new group, optionally creating a default MUC chat on [`groups_muc_host`](#configuration).
6149
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 **Parameters:**
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 1. `group_info: { name: string }`
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
45 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
46 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
47
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
48 **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
49
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
50 #### `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
51
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
52 Retrieves information about a group.
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 **Parameters:**
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 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
57
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
58 **Returns:**
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 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
61 group_info: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
62 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
63 muc_jid: string | nil
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
64 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
65 | nil
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
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
68 #### `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
69
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
70 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
71
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
72 **Parameters:**
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 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
75 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
76
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
77 **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
78
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
79 #### `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
80
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
81 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
82
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
83 **Parameters:**
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 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
86
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
87 **Returns:** `group_members: {string}`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
88
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
89 #### `exists(group_id)` {#exists}
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 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
92
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
93 **Parameters:**
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 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
96
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
97 **Returns:** `group_exists: boolean`
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 #### `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
100
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
101 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
102
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
103 **Parameters:**
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 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
106
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
107 **Returns:** `user_groups: {string}`
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
108
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
109 #### `delete(group_id)` {#delete}
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 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
112
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
113 **Parameters:**
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 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
116
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
117 **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
118
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
119 #### `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
120
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
121 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
122
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
123 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
124 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
125 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
126
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
127 **Parameters:**
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 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
130 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
131
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
132 **Returns:** `true | nil, error: string`
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 #### `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
135
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
136 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
137
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
138 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
139 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
140 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
141
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
142 **Parameters:**
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 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
145 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
146
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
147 **Returns:** `true | nil, error: string`
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 #### `sync(group_id)` {#sync}
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 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
152
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
153 **Parameters:**
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 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
156
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
157 **Returns:** `nil`
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 #### `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
160
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
161 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
162
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
163 ::: {.alert .alert-info}
6154
62ff93af69d5 mod_groups_internal: Remove broken links
Rémi Bardon <remi@remibardon.name>
parents: 6153
diff changeset
164 Its JID will be `<`[`util.id.short`](https://prosody.im/doc/developers/util/id)`>@<`[`option:groups_muc_host`](#configuration)`>`.
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
165 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
166
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
167 **Parameters:**
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 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
170 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
171
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
172 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
173
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
174 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
175 muc: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
176 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
177 name: string,
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
178 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
179 | nil, error: string
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
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
182 #### `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
183
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
184 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
185
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
186 ::: {.alert .alert-info}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
187 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
188 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
189
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
190 **Parameters:**
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 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
193 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
194
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
195 **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
196
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
197 #### `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
198
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
199 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
200
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
201 ::: {.alert .alert-warning}
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
202 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
203 :::
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
204
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
205 **Parameters:**
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 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
208
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
209 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
210
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
211 ```lua
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
212 group_chats: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
213 {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
214 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
215 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
216 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
217 deleted: boolean,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
218 }
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
219 }
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
220 | nil
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
221 ```
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
222
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
223 #### `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
224
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
225 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
226
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
227 **Parameters:**
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 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
230
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
231 **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
232
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
233 #### `groups()` {#groups}
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 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
236
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
237 **Returns:**
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
238
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
239 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
240 groups: {
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
241 <group_id>: {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
242 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
243 muc_jid: string | nil
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
244 }
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
245 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
246 ```
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 (Where `<group_id>` is a
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 ### Emitted events {#events}
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 #### `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
253
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
254 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
255
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
256 Payload structure:
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 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
259 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
260 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
261 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
262 host: string, -- <module.host>
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
263 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
264 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
265 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
266 mucs: {string} | nil,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
267 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
268 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
269 ```
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 #### `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
272
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
273 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
274
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
275 Payload structure:
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 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
278 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
279 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
280 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
281 host: string, -- <module.host>
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
282 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
283 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
284 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
285 mucs: {string} | nil,
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
286 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
287 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
288 ```
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 #### `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
291
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
292 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
293
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
294 Payload structure:
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 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
297 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
298 group_id: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
299 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
300 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
301 mucs: {string},
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
302 },
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
303 muc: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
304 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
305 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
306 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
307 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
308 ```
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 #### `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
311
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
312 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
313
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
314 Payload structure:
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 ```lua
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
317 {
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
318 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
319 group_info: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
320 name: string,
6152
8f52eb411737 mod_groups_internal: Use syntax closer to Lua in README
Rémi Bardon <remi@remibardon.name>
parents: 6151
diff changeset
321 mucs: {string},
6151
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
322 },
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
323 muc: {
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
324 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
325 jid: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6149
diff changeset
326 },
6149
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
327 }
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
328 ```
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 [`mod_groups`]: https://prosody.im/doc/modules/mod_groups "mod_groups – Prosody IM"