diff options
author | Joas Schilling <coding@schilljs.com> | 2023-08-25 12:35:56 +0200 |
---|---|---|
committer | Joas Schilling <coding@schilljs.com> | 2023-08-25 13:09:42 +0200 |
commit | 335f7d60217ae8a11d0108ecf969600561ac6ba1 (patch) | |
tree | 233c37f3c3950049c0a754347218aea8108aacb8 /docs | |
parent | c027cd4aeb5deef8b8912d0c600c0d8ae3c5e27e (diff) |
fix(occ): Fix OCC documentation with shortcuts, required values and descriptions of options
Signed-off-by: Joas Schilling <coding@schilljs.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/occ.md | 275 |
1 files changed, 138 insertions, 137 deletions
diff --git a/docs/occ.md b/docs/occ.md index f2d8753ad..555ed52f0 100644 --- a/docs/occ.md +++ b/docs/occ.md @@ -10,16 +10,16 @@ Install a new bot on the server | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `name` | The name under which the messages will be posted | yes | no | `NULL` | -| `secret` | Secret used to validate API calls | yes | no | `NULL` | -| `url` | Webhook endpoint to post messages to | yes | no | `NULL` | +| `name` | The name under which the messages will be posted | yes | no | *Required* | +| `secret` | Secret used to validate API calls | yes | no | *Required* | +| `url` | Webhook endpoint to post messages to | yes | no | *Required* | | `description` | Optional description shown in the admin settings | no | no | `NULL` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | -| `--no-setup` | Prevent moderators from setting up the bot in a conversation | no | no | no | false` | -| `--feature|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | array ()` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | +| `--no-setup` | Prevent moderators from setting up the bot in a conversation | no | no | no | `false` | +| `--feature\|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | *Required* | ## talk:bot:list @@ -33,9 +33,9 @@ List all installed bots of the server or a conversation |---|---|---|---|---| | `token` | Conversation token to limit the bot list for | no | no | `NULL` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:bot:remove @@ -47,12 +47,12 @@ Remove a bot from a conversation | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `bot-id` | The ID of the bot to remove in a conversation | yes | no | `NULL` | +| `bot-id` | The ID of the bot to remove in a conversation | yes | no | *Required* | | `token` | Conversation tokens to remove bot up for | no | yes | `array ()` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:bot:state @@ -64,13 +64,13 @@ Change the state or feature list for a bot | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `bot-id` | Bot ID to change the state for | yes | no | `NULL` | -| `state` | New state for the bot (0 = disabled, 1 = enabled, 2 = no setup via GUI) | yes | no | `NULL` | +| `bot-id` | Bot ID to change the state for | yes | no | *Required* | +| `state` | New state for the bot (0 = disabled, 1 = enabled, 2 = no setup via GUI) | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | -| `--feature|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | array ()` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | +| `--feature\|-f` | Specify the list of features for the bot - webhook: The bot receives posted chat messages as webhooks - response: The bot can post messages and reactions as a response - none: When all features should be disabled for the bot | yes | yes | yes | *Required* | ## talk:bot:setup @@ -82,12 +82,12 @@ Add a bot to a conversation | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `bot-id` | The ID of the bot to set up in a conversation | yes | no | `NULL` | +| `bot-id` | The ID of the bot to set up in a conversation | yes | no | *Required* | | `token` | Conversation tokens to set the bot up for | no | yes | `array ()` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:bot:uninstall @@ -95,15 +95,16 @@ Uninstall a bot from the server ### Usage -* `talk:bot:uninstall [--output [OUTPUT]] [--] <id>` +* `talk:bot:uninstall [--output [OUTPUT]] [--url URL] [--] [<id>]` | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `id` | The ID of the bot | yes | no | `NULL` | +| `id` | The ID of the bot | no | no | `NULL` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | +| `--url` | The URL of the bot (required when no ID is given, ignored otherwise) | yes | yes | no | *Required* | ## talk:command:add @@ -115,15 +116,15 @@ Add a new command | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `cmd` | The command as used in the chat "/help" => "help" | yes | no | `NULL` | -| `name` | Name of the user posting the response | yes | no | `NULL` | -| `script` | Script to execute (Must be using absolute paths only) | yes | no | `NULL` | -| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | `NULL` | -| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | `NULL` | +| `cmd` | The command as used in the chat "/help" => "help" | yes | no | *Required* | +| `name` | Name of the user posting the response | yes | no | *Required* | +| `script` | Script to execute (Must be using absolute paths only) | yes | no | *Required* | +| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | *Required* | +| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:command:add-samples @@ -143,7 +144,7 @@ Remove an existing command | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `command-id` | | yes | no | `NULL` | +| `command-id` | | yes | no | *Required* | ## talk:command:list @@ -157,9 +158,9 @@ List all available commands |---|---|---|---|---| | `app` | Only list the commands of a specific app, "custom" to list all custom commands | no | no | `NULL` | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:command:update @@ -171,16 +172,16 @@ Add a new command | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `command-id` | | yes | no | `NULL` | -| `cmd` | The command as used in the chat "/help" => "help" | yes | no | `NULL` | -| `name` | Name of the user posting the response | yes | no | `NULL` | -| `script` | Script to execute (Must be using absolute paths only) | yes | no | `NULL` | -| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | `NULL` | -| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | `NULL` | - -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| `command-id` | | yes | no | *Required* | +| `cmd` | The command as used in the chat "/help" => "help" | yes | no | *Required* | +| `name` | Name of the user posting the response | yes | no | *Required* | +| `script` | Script to execute (Must be using absolute paths only) | yes | no | *Required* | +| `response` | Who should see the response: 0 - No one, 1 - User, 2 - All | yes | no | *Required* | +| `enabled` | Who can use this command: 0 - Disabled, 1 - Moderators, 2 - Users, 3 - Guests | yes | no | *Required* | + +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:monitor:calls @@ -190,9 +191,9 @@ Prints a list with conversations that have an active call as well as their parti * `talk:monitor:calls [--output [OUTPUT]]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:active-calls @@ -202,9 +203,9 @@ Allows you to check if calls are currently in process * `talk:active-calls [--output [OUTPUT]]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:monitor:room @@ -216,12 +217,12 @@ Prints the number of attendees, active sessions and participant in the call. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room to monitor | yes | no | `NULL` | +| `token` | Token of the room to monitor | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | -| `--separator` | Separator for the CSV list when output=csv is used | yes | yes | no | ','` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | +| `--separator` | Separator for the CSV list when output=csv is used | yes | yes | no | *Required* | ## talk:room:add @@ -233,12 +234,12 @@ Adds users to a room | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room to add users to | yes | no | `NULL` | +| `token` | Token of the room to add users to | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--user` | Invites the given users to the room | yes | yes | yes | array ()` | -| `--group` | Invites all members of the given groups to the room | yes | yes | yes | array ()` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--user` | Invites the given users to the room | yes | yes | yes | *Required* | +| `--group` | Invites all members of the given groups to the room | yes | yes | yes | *Required* | ## talk:room:create @@ -250,20 +251,20 @@ Create a new room | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `name` | The name of the room to create | yes | no | `NULL` | - -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--description` | The description of the room to create | yes | yes | no | NULL` | -| `--user` | Invites the given users to the room to create | yes | yes | yes | array ()` | -| `--group` | Invites all members of the given group to the room to create | yes | yes | yes | array ()` | -| `--public` | Creates the room as public room if set | no | no | no | false` | -| `--readonly` | Creates the room with read-only access only if set | no | no | no | false` | -| `--listable` | Creates the room with the given listable scope | yes | yes | no | NULL` | -| `--password` | Protects the room to create with the given password | yes | yes | no | NULL` | -| `--owner` | Sets the given user as owner of the room to create | yes | yes | no | NULL` | -| `--moderator` | Promotes the given users to moderators | yes | yes | yes | array ()` | -| `--message-expiration` | Seconds to expire a message after sent. If zero will disable the expire message duration. | yes | yes | no | NULL` | +| `name` | The name of the room to create | yes | no | *Required* | + +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--description` | The description of the room to create | yes | yes | no | *Required* | +| `--user` | Invites the given users to the room to create | yes | yes | yes | *Required* | +| `--group` | Invites all members of the given group to the room to create | yes | yes | yes | *Required* | +| `--public` | Creates the room as public room if set | no | no | no | `false` | +| `--readonly` | Creates the room with read-only access only if set | no | no | no | `false` | +| `--listable` | Creates the room with the given listable scope | yes | yes | no | *Required* | +| `--password` | Protects the room to create with the given password | yes | yes | no | *Required* | +| `--owner` | Sets the given user as owner of the room to create | yes | yes | no | *Required* | +| `--moderator` | Promotes the given users to moderators | yes | yes | yes | *Required* | +| `--message-expiration` | Seconds to expire a message after sent. If zero will disable the expire message duration. | yes | yes | no | *Required* | ## talk:room:delete @@ -275,7 +276,7 @@ Deletes a room | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room to delete | yes | no | `NULL` | +| `token` | Token of the room to delete | yes | no | *Required* | ## talk:room:demote @@ -287,8 +288,8 @@ Demotes participants of a room to regular users | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room in which users should be demoted | yes | no | `NULL` | -| `participant` | Demotes the given participants of the room to regular users | yes | yes | `array ()` | +| `token` | Token of the room in which users should be demoted | yes | no | *Required* | +| `participant` | Demotes the given participants of the room to regular users | yes | yes | *Required* | ## talk:room:promote @@ -300,8 +301,8 @@ Promotes participants of a room to moderators | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room in which users should be promoted | yes | no | `NULL` | -| `participant` | Promotes the given participants of the room to moderators | yes | yes | `array ()` | +| `token` | Token of the room in which users should be promoted | yes | no | *Required* | +| `participant` | Promotes the given participants of the room to moderators | yes | yes | *Required* | ## talk:room:remove @@ -313,8 +314,8 @@ Remove users from a room | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | Token of the room to remove users from | yes | no | `NULL` | -| `participant` | Removes the given participants from the room | yes | yes | `array ()` | +| `token` | Token of the room to remove users from | yes | no | *Required* | +| `participant` | Removes the given participants from the room | yes | yes | *Required* | ## talk:room:update @@ -326,18 +327,18 @@ Updates a room | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `token` | The token of the room to update | yes | no | `NULL` | +| `token` | The token of the room to update | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--name` | Sets a new name for the room | yes | yes | no | NULL` | -| `--description` | Sets a new description for the room | yes | yes | no | NULL` | -| `--public` | Modifies the room to be a public room (value 1) or private room (value 0) | yes | yes | no | NULL` | -| `--readonly` | Modifies the room to be read-only (value 1) or read-write (value 0) | yes | yes | no | NULL` | -| `--listable` | Modifies the room's listable scope | yes | yes | no | NULL` | -| `--password` | Sets a new password for the room; pass an empty value to remove password protection | yes | yes | no | NULL` | -| `--owner` | Sets the given user as owner of the room; pass an empty value to remove the owner | yes | yes | no | NULL` | -| `--message-expiration` | Seconds to expire a message after sent. If zero will disable the expire message duration. | yes | yes | no | NULL` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--name` | Sets a new name for the room | yes | yes | no | *Required* | +| `--description` | Sets a new description for the room | yes | yes | no | *Required* | +| `--public` | Modifies the room to be a public room (value 1) or private room (value 0) | yes | yes | no | *Required* | +| `--readonly` | Modifies the room to be read-only (value 1) or read-write (value 0) | yes | yes | no | *Required* | +| `--listable` | Modifies the room's listable scope | yes | yes | no | *Required* | +| `--password` | Sets a new password for the room; pass an empty value to remove password protection | yes | yes | no | *Required* | +| `--owner` | Sets the given user as owner of the room; pass an empty value to remove the owner | yes | yes | no | *Required* | +| `--message-expiration` | Seconds to expire a message after sent. If zero will disable the expire message duration. | yes | yes | no | *Required* | ## talk:signaling:add @@ -349,12 +350,12 @@ Add an external signaling server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `server` | A server string, ex. wss://signaling.example.org | yes | no | `NULL` | -| `secret` | A shared secret string. | yes | no | `NULL` | +| `server` | A server string, ex. wss://signaling.example.org | yes | no | *Required* | +| `secret` | A shared secret string. | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--verify` | Validate SSL certificate if set. | no | no | no | false` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--verify` | Validate SSL certificate if set. | no | no | no | `false` | ## talk:signaling:delete @@ -366,7 +367,7 @@ Remove an existing signaling server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `server` | An external signaling server string, ex. wss://signaling.example.org | yes | no | `NULL` | +| `server` | An external signaling server string, ex. wss://signaling.example.org | yes | no | *Required* | ## talk:signaling:list @@ -376,9 +377,9 @@ List external signaling servers. * `talk:signaling:list [--output [OUTPUT]]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:stun:add @@ -390,7 +391,7 @@ Add a new STUN server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `server` | A domain name and port number separated by the colons, ex. stun.nextcloud.com:443 | yes | no | `NULL` | +| `server` | A domain name and port number separated by the colons, ex. stun.nextcloud.com:443 | yes | no | *Required* | ## talk:stun:delete @@ -402,7 +403,7 @@ Remove an existing STUN server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `server` | A domain name and port number separated by the colons, ex. stun.nextcloud.com:443 | yes | no | `NULL` | +| `server` | A domain name and port number separated by the colons, ex. stun.nextcloud.com:443 | yes | no | *Required* | ## talk:stun:list @@ -412,9 +413,9 @@ List STUN servers. * `talk:stun:list [--output [OUTPUT]]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:turn:add @@ -426,14 +427,14 @@ Add a TURN server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `schemes` | Schemes, can be turn or turns or turn,turns. | yes | no | `NULL` | -| `server` | A domain name, ex. turn.nextcloud.com | yes | no | `NULL` | -| `protocols` | Protocols, can be udp or tcp or udp,tcp. | yes | no | `NULL` | +| `schemes` | Schemes, can be turn or turns or turn,turns. | yes | no | *Required* | +| `server` | A domain name, ex. turn.nextcloud.com | yes | no | *Required* | +| `protocols` | Protocols, can be udp or tcp or udp,tcp. | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--secret` | A shard secret string | yes | yes | no | NULL` | -| `--generate-secret` | Generate secret if set. | no | no | no | false` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--secret` | A shard secret string | yes | yes | no | *Required* | +| `--generate-secret` | Generate secret if set. | no | no | no | `false` | ## talk:turn:delete @@ -445,9 +446,9 @@ Remove an existing TURN server. | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `schemes` | Schemes, can be turn or turns or turn,turns | yes | no | `NULL` | -| `server` | A domain name, ex. turn.nextcloud.com | yes | no | `NULL` | -| `protocols` | Protocols, can be udp or tcp or udp,tcp | yes | no | `NULL` | +| `schemes` | Schemes, can be turn or turns or turn,turns | yes | no | *Required* | +| `server` | A domain name, ex. turn.nextcloud.com | yes | no | *Required* | +| `protocols` | Protocols, can be udp or tcp or udp,tcp | yes | no | *Required* | ## talk:turn:list @@ -457,9 +458,9 @@ List TURN servers. * `talk:turn:list [--output [OUTPUT]]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | 'plain'` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--output` | Output format (plain, json or json_pretty, default is plain) | yes | no | no | `'plain'` | ## talk:user:remove @@ -469,10 +470,10 @@ Remove a user from all their rooms * `talk:user:remove [--user USER] [--private-only]` -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--user` | Remove the given users from all rooms | yes | yes | yes | array ()` | -| `--private-only` | Only remove the user from private rooms, retaining membership in public and open conversations as well as one-to-ones | no | no | no | false` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--user` | Remove the given users from all rooms | yes | yes | yes | *Required* | +| `--private-only` | Only remove the user from private rooms, retaining membership in public and open conversations as well as one-to-ones | no | no | no | `false` | ## talk:user:transfer-ownership @@ -484,11 +485,11 @@ Adds the destination-user with the same participant type to all (not one-to-one) | Arguments | Description | Is required | Is array | Default | |---|---|---|---|---| -| `source-user` | Owner of conversations which shall be moved | yes | no | `NULL` | -| `destination-user` | User who will be the new owner of the conversations | yes | no | `NULL` | +| `source-user` | Owner of conversations which shall be moved | yes | no | *Required* | +| `destination-user` | User who will be the new owner of the conversations | yes | no | *Required* | -| Options | Accept value | Is value required | Is multiple | Default | -|---|---|---|---|---| -| `--include-non-moderator` | Also include conversations where the source-user is a normal user | no | no | no | false` | -| `--remove-source-user` | Remove the source-user from the conversations | no | no | no | false` | +| Options | Description | Accept value | Is value required | Is multiple | Default | +|---|---|---|---|---|---| +| `--include-non-moderator` | Also include conversations where the source-user is a normal user | no | no | no | `false` | +| `--remove-source-user` | Remove the source-user from the conversations | no | no | no | `false` | |