Software /
code /
prosody-modules
Changeset
6180:8f52eb411737
mod_groups_internal: Use syntax closer to Lua in README
author | Rémi Bardon <remi@remibardon.name> |
---|---|
date | Fri, 31 Jan 2025 02:09:38 +0100 |
parents | 6179:5250e4cb0b1a |
children | 6181:9122d5a246c2 |
files | mod_groups_internal/README.md |
diffstat | 1 files changed, 17 insertions(+), 19 deletions(-) [+] |
line wrap: on
line diff
--- a/mod_groups_internal/README.md Fri Jan 31 02:50:23 2025 +0100 +++ b/mod_groups_internal/README.md Fri Jan 31 02:09:38 2025 +0100 @@ -76,7 +76,7 @@ 1. `group_id: string`: Node part of the group's JID. 2. `group_info: { name: string, muc_jid: string | nil }` -**Returns[^pseudo-lua]:** `true | nil, error: string` +**Returns:** `true | nil, error: string` #### `get_members(group_id)` {#get_members} @@ -86,7 +86,7 @@ 1. `group_id: string`: Node part of the group's JID. -**Returns[^pseudo-lua]:** `group_members: [string]` +**Returns:** `group_members: {string}` #### `exists(group_id)` {#exists} @@ -106,7 +106,7 @@ 1. `username: string`: Node part of the user's JID. -**Returns[^pseudo-lua]:** `user_groups: [string]` +**Returns:** `user_groups: {string}` #### `delete(group_id)` {#delete} @@ -116,7 +116,7 @@ 1. `group_id: string`: Node part of the group's JID. -**Returns[^pseudo-lua]:** `true | nil, error: string` +**Returns:** `true | nil, error: string` #### `add_member(group_id, username, delay_update)` {#add_member} @@ -171,7 +171,7 @@ 1. `group_id: string`: Node part of the group's JID. 2. `name: string`: Desired name of the group chat. -**Returns[^pseudo-lua]:** +**Returns:** ```lua muc: { @@ -194,7 +194,7 @@ 1. `group_id: string`: Node part of the group's JID. 2. `muc_id: string`: Node part of the MUC JID. -**Returns[^pseudo-lua]:** `true | nil, error: string` +**Returns:** `true | nil, error: string` #### `get_group_chats(group_id)` {#get_group_chats} @@ -208,17 +208,17 @@ 1. `group_id: string`: Node part of the group's JID. -**Returns[^pseudo-lua]:** +**Returns:** ```lua -group_chats: [ +group_chats: { { id: string, -- muc_id (node part of the MUC JID) jid: string, name: string, - deleted = boolean, + deleted: boolean, } -] +} | nil ``` @@ -230,17 +230,17 @@ 1. `group_id: string`: Node part of the group's JID. -**Returns[^pseudo-lua]:** `true | false, error: string` +**Returns:** `true | false, error: string` #### `groups()` {#groups} Returns info about all groups (for every `group_id` key, the value is the equivalent of calling `get_info(group_id)`). -**Returns[^pseudo-lua]:** +**Returns:** ```lua groups: { - [<group_id>]: { + <group_id>: { name: string, muc_jid: string | nil } @@ -265,7 +265,7 @@ group_info: { name: string, muc_jid: string | nil, - mucs: [string] | nil, + mucs: {string} | nil, }, } ``` @@ -284,7 +284,7 @@ group_info: { name: string, muc_jid: string | nil, - mucs: [string] | nil, + mucs: {string} | nil, }, } ``` @@ -300,7 +300,7 @@ group_id: string, group_info: { name: string, - mucs: [string], + mucs: {string}, }, muc: { jid: string, @@ -320,7 +320,7 @@ group_id: string, -- group_id (node part of the group's JID) group_info: { name: string, - mucs: [string], + mucs: {string}, }, muc: { id: string, -- muc_id (node part of the MUC JID) @@ -329,6 +329,4 @@ } ``` -[^pseudo-lua]: As "pseudo-Lua" code. `[…]` represents a list and `[…]` as a map key means `0..n` times the key (it's not just one element). - [`mod_groups`]: https://prosody.im/doc/modules/mod_groups "mod_groups – Prosody IM"