|
|
Whitebeam Template Reference Documentation
|
rb.chat.chatRoom
An interactive chat room
Elements
The rb.chat.chatRoom struct has 12 elements:
| Name | Type/Value | Range/Length | Description | | roomID | number | positive integer | Optional, default = -1
The unique ID for this chat room. | | type | string | 1-30 characters | Optional. Application identifier for this type of room. Application specific. | | name | string | | Required. The 'name' field from the associated contact record. READ ONLY | | description | string | | Required. Short (100 chars) summary of this record | | customData | MetaData | | Optional. Opaque storage of serialised JavaScript objects | | archive | bool | | Optional, default = 0
If true then messages in this conversation are to be stored in the database | | open | bool | | Optional, default = 0
True if new messages can be added to this conversation and new members can join | | autoClean | number | | Optional, default = 0
0 to disable: Timeout (when no joined members) before room is auto-removed. Ignored if archive is TRUE. | | maxMembers | number | | Optional, default = -1
Number of people that can join the new room. -1 indicates unlimited | | maxCache | number | | Optional, default = 100
Maximum number of messages that can be returned by a 'poll' request | | currentMembers | number | | Optional, default = 0
READ ONLY : The number of people currently in the conversation | | contacts | array of numbers | | Optional. READ ONLY : If 'allData & 1' then return list of all contacts to which this room is connected |
|
|
|
(loadtime : 244ms) |
