prosody-modules
6d5a19bdd718
mod_groups_internal/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_groups_internal/README.md @ 6202:6d5a19bdd718

mod_openid, mod_json_streams: Remove modules depending on obsolete net.httpserver API These have not been updated for a long time and do not work with Prosody versions from recent years, which is a good indication they are not being used.
author Matthew Wild <mwild1@gmail.com>
date Fri, 14 Feb 2025 14:59:14 +0000
parent 6183:d0a117e11cb8
child 6211:750d64c47ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6177
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
6181
9122d5a246c2 mod_groups_internal: Update groups_muc_host config documentation
Rémi Bardon <remi@remibardon.name>
parents: 6180
diff changeset
30 | Option | Type | Default | Notes |
9122d5a246c2 mod_groups_internal: Update groups_muc_host config documentation
Rémi Bardon <remi@remibardon.name>
parents: 6180
diff changeset
31 | ------ | ---- | ------- | ----- |
6182
62ff93af69d5 mod_groups_internal: Remove broken links
Rémi Bardon <remi@remibardon.name>
parents: 6181
diff changeset
32 | `groups_muc_host` | string? | nil | Host where the group chats will be created. |
6177
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
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
38 - #### `create(group_info, create_default_muc, group_id)` {#create}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
39
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
40 Creates a new group, optionally creating a default MUC chat on [`groups_muc_host`](#configuration).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
41
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
42 **Parameters:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
43
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
44 1. `group_info: { name: string }`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
45 2. `create_default_muc: boolean | nil`: Whether or not to create the default MUC chat. Defaults to `false`.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
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).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
47
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
48 **Returns:** `group_id: string | nil, error: string`
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
49
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
50 - #### `get_info(group_id)` {#get_info}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
51
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
52 Retrieves information about a group.
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
53
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
54 **Parameters:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
55
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
56 1. `group_id: string`: Node part of the group's JID.
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
57
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
58 **Returns:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
59
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
60 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
61 group_info: {
6179
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6177
diff changeset
62 name: string,
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6177
diff changeset
63 muc_jid: string | nil
5250e4cb0b1a mod_groups_internal: Replace tabs by spaces in README
Rémi Bardon <remi@remibardon.name>
parents: 6177
diff changeset
64 }
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
65 | nil
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
66 ```
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
67
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
68 - #### `set_info(group_id, info)` {#set_info}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
69
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
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.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
71
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
72 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
73
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
74 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
75 2. `group_info: { name: string, muc_jid: string | nil }`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
76
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
77 **Returns:** `true | nil, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
78
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
79 - #### `get_members(group_id)` {#get_members}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
80
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
81 Retrieves the list of members in a given group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
82
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
83 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
84
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
85 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
86
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
87 **Returns:** `group_members: {string}`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
88
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
89 - #### `exists(group_id)` {#exists}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
90
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
91 Returns whether or not a group exists.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
92
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
93 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
94
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
95 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
96
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
97 **Returns:** `group_exists: boolean`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
98
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
99 - #### `get_user_groups(username)` {#get_user_groups}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
100
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
101 Lists which groups a given user is a part of.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
102
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
103 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
104
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
105 1. `username: string`: Node part of the user's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
106
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
107 **Returns:** `user_groups: {string}`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
108
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
109 - #### `delete(group_id)` {#delete}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
110
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
111 Deletes a given group and its associated group chats.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
112
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
113 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
114
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
115 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
116
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
117 **Returns:** `true | nil, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
118
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
119 - #### `add_member(group_id, username, delay_update)` {#add_member}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
120
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
121 Adds a member to a given group, optionally delaying subscriptions until [`sync`](#sync) is called.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
122
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
123 ::: {.alert .alert-info}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
124 This function emits a [`group-user-added`](#group-user-added) event on successful execution.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
125 :::
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
126
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
127 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
128
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
129 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
130 2. `delay_update: boolean | nil`: Do not update subscriptions until [`sync`](#sync) is called. Defaults to `false`.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
131
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
132 **Returns:** `true | nil, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
133
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
134 - #### `remove_member(group_id, username)` {#remove_member}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
135
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
136 Removes a member from a given group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
137
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
138 ::: {.alert .alert-info}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
139 This function emits a [`group-user-removed`](#group-user-removed) event on successful execution.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
140 :::
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
141
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
142 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
143
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
144 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
145 2. `username: string`: Node part of the user's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
146
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
147 **Returns:** `true | nil, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
148
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
149 - #### `sync(group_id)` {#sync}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
150
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
151 Updates group subscriptions (used to apply pending changes from [`add_member`](#add_member)).
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
152
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
153 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
154
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
155 1. `group_id: string`: Node part of the group's JID.
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
156
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
157 **Returns:** `nil`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
158
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
159 - #### `add_group_chat(group_id, name)` {#add_group_chat}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
160
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
161 Creates a new group chat for a given group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
162
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
163 ::: {.alert .alert-info}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
164 Its JID will be `<`[`util.id.short`](https://prosody.im/doc/developers/util/id)`>@<`[`option:groups_muc_host`](#configuration)`>`.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
165 :::
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
166
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
167 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
168
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
169 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
170 2. `name: string`: Desired name of the group chat.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
171
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
172 **Returns:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
173
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
174 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
175 muc: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
176 jid: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
177 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
178 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
179 | nil, error: string
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
180 ```
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
181
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
182 - #### `remove_group_chat(group_id, muc_id)` {#remove_group_chat}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
184 Removes a group chat for a given group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
185
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
186 ::: {.alert .alert-info}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
187 This function emits a [`group-chat-removed`](#group-chat-removed) event on successful execution.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
188 :::
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
189
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
190 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
191
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
192 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
193 2. `muc_id: string`: Node part of the MUC JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
194
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
195 **Returns:** `true | nil, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
196
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
197 - #### `get_group_chats(group_id)` {#get_group_chats}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
198
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
199 Lists group chats associated to a given group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
200
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
201 ::: {.alert .alert-warning}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
202 Make sure to check the `deleted` property on each chat as this function might return information about deleted chats.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
203 :::
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
204
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
205 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
206
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
207 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
208
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
209 **Returns:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
210
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
211 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
212 group_chats: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
213 {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
214 id: string, -- muc_id (node part of the MUC JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
215 jid: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
216 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
217 deleted: boolean,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
218 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
219 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
220 | nil
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
221 ```
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
222
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
223 - #### `emit_member_events(group_id)` {#emit_member_events}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
224
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
225 Emits [`group-user-added`](#group-user-added) events for every member of a group.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
226
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
227 **Parameters:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
228
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
229 1. `group_id: string`: Node part of the group's JID.
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
230
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
231 **Returns:** `true | false, error: string`
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
232
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
233 - #### `groups()` {#groups}
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
234
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
235 Returns info about all groups (for every `group_id` key, the value is the equivalent of calling `get_info(group_id)`).
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
236
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
237 **Returns:**
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
238
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
239 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
240 groups: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
241 <group_id>: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
242 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
243 muc_jid: string | nil
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
244 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
245 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
246 ```
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
247
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
248 (Where `<group_id>` is a
6177
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
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
252 - #### `group-user-added` {#group-user-added}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
253
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
254 Emitted on successful [`add_member`](#add_member) and on [`emit_member_events`](#emit_member_events).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
255
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
256 **Payload structure:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
257
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
258 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
259 {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
260 id: string, -- group_id (node part of the group's JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
261 user: string, -- username (node part of the user's JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
262 host: string, -- <module.host>
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
263 group_info: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
264 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
265 muc_jid: string | nil,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
266 mucs: {string} | nil,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
267 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
268 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
269 ```
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
270
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
271 - #### `group-user-removed` {#group-user-removed}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
272
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
273 Emitted on successful [`remove_member`](#remove_member).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
274
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
275 **Payload structure:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
276
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
277 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
278 {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
279 id: string, -- group_id (node part of the group's JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
280 user: string, -- username (node part of the user's JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
281 host: string, -- <module.host>
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
282 group_info: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
283 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
284 muc_jid: string | nil,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
285 mucs: {string} | nil,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
286 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
287 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
288 ```
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
289
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
290 - #### `group-chat-added` {#group-chat-added}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
291
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
292 Emitted on successful [`add_group_chat`](#add_group_chat).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
293
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
294 **Payload structure:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
295
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
296 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
297 {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
298 group_id: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
299 group_info: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
300 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
301 mucs: {string},
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
302 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
303 muc: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
304 jid: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
305 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
306 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
307 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
308 ```
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
309
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
310 - #### `group-chat-removed` {#group-chat-removed}
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
311
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
312 Emitted on successful [`remove_group_chat`](#remove_group_chat).
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
313
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
314 **Payload structure:**
6177
ce0579449dba mod_groups_internal: Rename README.markdown to README.md
Rémi Bardon <remi@remibardon.name>
parents:
diff changeset
315
6183
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
316 ```lua
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
317 {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
318 group_id: string, -- group_id (node part of the group's JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
319 group_info: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
320 name: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
321 mucs: {string},
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
322 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
323 muc: {
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
324 id: string, -- muc_id (node part of the MUC JID)
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
325 jid: string,
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
326 },
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
327 }
d0a117e11cb8 mod_groups_internal: Improve Markdown structure of documentation
Rémi Bardon <remi@remibardon.name>
parents: 6182
diff changeset
328 ```
6177
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"