Mercurial > prosody-modules

comparison 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
comparison
equal deleted inserted replaced
6153:9122d5a246c2 6154:62ff93af69d5
27 27
28 ## Configuration 28 ## Configuration
29 29
30 | Option | Type | Default | Notes | 30 | Option | Type | Default | Notes |
31 | ------ | ---- | ------- | ----- | 31 | ------ | ---- | ------- | ----- |
32 | `groups_muc_host` | string | nil | Host where the group chats will be created. | 32 | `groups_muc_host` | string? | nil | Host where the group chats will be created. |
33 33
34 ## Usage 34 ## Usage
35 35
36 ### Exposed functions 36 ### Exposed functions
37 37
38 #### `create(group_info, create_default_muc, group_id)` {#create} 38 #### `create(group_info, create_default_muc, group_id)` {#create}
39 39
40 Creates a new group, optionally creating a default MUC chat on [`groups_muc_host`](#groups_muc_host). 40 Creates a new group, optionally creating a default MUC chat on [`groups_muc_host`](#configuration).
41 41
42 **Parameters:** 42 **Parameters:**
43 43
44 1. `group_info: { name: string }` 44 1. `group_info: { name: string }`
45 2. `create_default_muc: boolean | nil`: Whether or not to create the default MUC chat. Defaults to `false`. 45 2. `create_default_muc: boolean | nil`: Whether or not to create the default MUC chat. Defaults to `false`.
159 #### `add_group_chat(group_id, name)` {#add_group_chat} 159 #### `add_group_chat(group_id, name)` {#add_group_chat}
160 160
161 Creates a new group chat for a given group. 161 Creates a new group chat for a given group.
162 162
163 ::: {.alert .alert-info} 163 ::: {.alert .alert-info}
164 Its JID will be `<`[`util.id.short`](https://prosody.im/doc/developers/util/id)`>@<`[`option:groups_muc_host`](#groups_muc_host)`>`. 164 Its JID will be `<`[`util.id.short`](https://prosody.im/doc/developers/util/id)`>@<`[`option:groups_muc_host`](#configuration)`>`.
165 ::: 165 :::
166 166
167 **Parameters:** 167 **Parameters:**
168 168
169 1. `group_id: string`: Node part of the group's JID. 169 1. `group_id: string`: Node part of the group's JID.