Function __global->get_chatters_in_room
Definitions
sources/chat.php
- Get the people who have posted a message in the specified room within the last x minutes (defaults to five). Note that this function performs no pruning- the chat lobby will do that. It does do an activity time-range select though.
- Visibility: public
- Is abstract?: No
- Is static?: No
- Is final?: No
- Returns: array
Parameters
| Name | Type | Passed by reference? | Variadic? | Default | Set | Range | Description |
|---|---|---|---|---|---|---|---|
| $room_id | ?AUTO_LINK | No | No | required parameter | N/A | N/A | The room ID (null: lobby) |
Returns
- A map of members in the room. Member ID=>List of Chatter names (may be multiple because of Guest users)
- Type: array
- Set: N/A
- Range: N/A
Preview
Code (PHP)
/**
* Get the people who have posted a message in the specified room within the last x minutes (defaults to five). Note that this function performs no pruning- the chat lobby will do that. It does do an activity time-range select though.
*
* @param ?AUTO_LINK $room_id The room ID (null: lobby)
* @return array A map of members in the room. Member ID=>List of Chatter names (may be multiple because of Guest users)
*/
function get_chatters_in_room(?int $room_id) : array
* Get the people who have posted a message in the specified room within the last x minutes (defaults to five). Note that this function performs no pruning- the chat lobby will do that. It does do an activity time-range select though.
*
* @param ?AUTO_LINK $room_id The room ID (null: lobby)
* @return array A map of members in the room. Member ID=>List of Chatter names (may be multiple because of Guest users)
*/
function get_chatters_in_room(?int $room_id) : array
