|
|
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 | | roomID | number | | Required. ID for the room from which to return messages | | messageID | number | | Optional, default = -1
Simple ID for each message. Message IDs are increased by each message added to a conversation | | direction | number | | Optional, default = 1
If -1 return messages with IDs less that 'messageID', if 1 then greater and if 0 return that specific message | | maxRows | number | positive integer | Optional, default = 0
Maximum number of rows to return | | firstIndex | number | positive integer | Optional, default = 0
Offset into message stream to return | | dateWindowOldest | number | | Optional. Date - specified as number of seconds since 1/1/1970. Don't return any messages older than this | | dateWindowNewest | number | | Optional. Date - specified as number of seconds since 1/1/1970. Don't return any messages newer than this date | | sortBy | string | | Optional, default = ^messageID
How to sort the results. Options are 'messageID' (for increasing order of message ID) or '^messageID', the reverse direction |
|
|
|
(loadtime : 67ms) |
