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

Query structure to represent message

Elements

The rb.chat.messageQuery struct has 8 elements:

Name Type/Value Range/Length Description
roomIDnumber  Required. ID for the room from which to return messages
messageIDnumber  Optional, default = -1
Simple ID for each message. Message IDs are increased by each message added to a conversation
directionnumber  Optional, default = 1
If -1 return messages with IDs less that 'messageID', if 1 then greater and if 0 return that specific message
maxRowsnumberpositive integer Optional, default = 0
Maximum number of rows to return
firstIndexnumberpositive integer Optional, default = 0
Offset into message stream to return
dateWindowOldestnumber  Optional. Date - specified as number of seconds since 1/1/1970. Don't return any messages older than this
dateWindowNewestnumber  Optional. Date - specified as number of seconds since 1/1/1970. Don't return any messages newer than this date
sortBystring  Optional, default = ^messageID
How to sort the results. Options are 'messageID' (for increasing order of message ID) or '^messageID', the reverse direction

Whitebeam release 1.3.36
(loadtime : 185ms)