Whitebeam Template Reference Documentation

Site Map
 
Home
 
Application Guide
Reference
  Installation
  Configuration
  XML Markup
  JavaScript Classes
  ROM
  Templates
  Environment
  Dev Process
  Tools
  External Links
  Example libraries
Community
Contact Whitebeam
To-Do
Download
Credits
Licence
Whitebeam Users
 
 
 

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
roomIDnumberpositive integer Optional, default = -1
The unique ID for this chat room.
typestring1-30 characters Optional. Application identifier for this type of room. Application specific.
namestring  Required. The 'name' field from the associated contact record. READ ONLY
descriptionstring  Required. Short (100 chars) summary of this record
customDataMetaData  Optional. Opaque storage of serialised JavaScript objects
archivebool  Optional, default = 0
If true then messages in this conversation are to be stored in the database
openbool  Optional, default = 0
True if new messages can be added to this conversation and new members can join
autoCleannumber  Optional, default = 0
0 to disable: Timeout (when no joined members) before room is auto-removed. Ignored if archive is TRUE.
maxMembersnumber  Optional, default = -1
Number of people that can join the new room. -1 indicates unlimited
maxCachenumber  Optional, default = 100
Maximum number of messages that can be returned by a 'poll' request
currentMembersnumber  Optional, default = 0
READ ONLY : The number of people currently in the conversation
contactsarray of numbers  Optional. READ ONLY : If 'allData & 1' then return list of all contacts to which this room is connected

Whitebeam release 1.3.36
(loadtime : 190ms)