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.chatRoomQuery

Search parameters for conversations

Elements

The rb.chat.chatRoomQuery struct has 9 elements:

Name Type/Value Range/Length Description
roomIDnumberpositive integer Optional, default = -1
The unique ID of a specific conversation
typestring1-30 characters Optional. Wild-card type match against type
namestring  Optional. Wild-card type match against name
maxRowsnumberpositive integer Optional, default = 0
Maximum number of rows to return
firstIndexnumberpositive integer Optional, default = 0
Offset into message stream to return
archivebool  Optional. If specified then only return conversations in this state
openbool  Optional. If specified then only return conversations in this state
isInContactarray of numbers  Optional.

List of contact IDs to which rooms must be linked in order to be visible to non-administrators

allDatanumberpositive integer Optional, default = 0
Bitmap. allData:1 - if set then return array of contacts

Whitebeam release 1.3.36
(loadtime : 197ms)