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 Object Description
(chat Template)

The rb.chat object provides a store for interactive discussions in which multiple participant at separate browsers share an on-screen conversation.

Conversations may optionally be archived to the database.

Methods

rb.chat.create() Create a new conversation
rb.chat.linkContacts() undefined
rb.chat.modify() Modify an existing chat room configuration
rb.chat.remove() Permanently remove a conversation
rb.chat.flush() Delete all archived and cached messages from a room
rb.chat.get() Iterate over audit records
rb.chat.getActive() Iterate over audit records
rb.chat.getMessage() Iterate over audit records
rb.chat.join() Return unique key for this contact for this conversation
rb.chat.leave() Iterate over audit records
rb.chat.post() Post new message to the conversation
rb.chat.poll() Return poll data
rb.chat.changeUserStatus() Change status of user

Aggregate Types

rb.chat.chatRoom An interactive chat room
rb.chat.chatRoomActive A minimal report of a currently active chatRoom
rb.chat.chatRoomQuery Search parameters for conversations
rb.chat.message Structure used to represent a message
rb.chat.messageQuery Query structure to represent message
rb.chat.member Structure used to represent a member that is part of the conversation
Whitebeam release 1.3.36
(loadtime : 185ms)