Function __global->edit_chatroom
Definitions
sources/chat2.php
- Edit a chatroom.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $id | AUTO_LINK | No | No | required parameter | N/A | N/A | The chatroom ID |
| $welcome | SHORT_TEXT | No | No | required parameter | N/A | N/A | The welcome message |
| $room_name | SHORT_TEXT | No | No | required parameter | N/A | N/A | The room name |
| $room_owner | ?MEMBER | No | No | required parameter | N/A | N/A | The room owner (null: none) |
| $allow2 | LONG_TEXT | No | No | required parameter | N/A | N/A | The comma-separated list of users that may access it (blank: no restriction) |
| $allow2_groups | LONG_TEXT | No | No | required parameter | N/A | N/A | The comma-separated list of usergroups that may access it (blank: no restriction) |
| $disallow2 | LONG_TEXT | No | No | required parameter | N/A | N/A | The comma-separated list of users that may NOT access it (blank: no restriction) |
| $disallow2_groups | LONG_TEXT | No | No | required parameter | N/A | N/A | The comma-separated list of usergroups that may NOT access it (blank: no restriction) |
| $room_language | LANGUAGE_NAME | No | No | required parameter | N/A | N/A | The room language |
Preview
Code (PHP)
/**
* Edit a chatroom.
*
* @param AUTO_LINK $id The chatroom ID
* @param SHORT_TEXT $welcome The welcome message
* @param SHORT_TEXT $room_name The room name
* @param ?MEMBER $room_owner The room owner (null: none)
* @param LONG_TEXT $allow2 The comma-separated list of users that may access it (blank: no restriction)
* @param LONG_TEXT $allow2_groups The comma-separated list of usergroups that may access it (blank: no restriction)
* @param LONG_TEXT $disallow2 The comma-separated list of users that may NOT access it (blank: no restriction)
* @param LONG_TEXT $disallow2_groups The comma-separated list of usergroups that may NOT access it (blank: no restriction)
* @param LANGUAGE_NAME $room_language The room language
*/
function edit_chatroom(int $id, string $welcome, string $room_name, ?int $room_owner, string $allow2, string $allow2_groups, string $disallow2, string $disallow2_groups, string $room_language)
* Edit a chatroom.
*
* @param AUTO_LINK $id The chatroom ID
* @param SHORT_TEXT $welcome The welcome message
* @param SHORT_TEXT $room_name The room name
* @param ?MEMBER $room_owner The room owner (null: none)
* @param LONG_TEXT $allow2 The comma-separated list of users that may access it (blank: no restriction)
* @param LONG_TEXT $allow2_groups The comma-separated list of usergroups that may access it (blank: no restriction)
* @param LONG_TEXT $disallow2 The comma-separated list of users that may NOT access it (blank: no restriction)
* @param LONG_TEXT $disallow2_groups The comma-separated list of usergroups that may NOT access it (blank: no restriction)
* @param LANGUAGE_NAME $room_language The room language
*/
function edit_chatroom(int $id, string $welcome, string $room_name, ?int $room_owner, string $allow2, string $allow2_groups, string $disallow2, string $disallow2_groups, string $room_language)
