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

Chat Template

flush()

Delete all archived and cached messages from a room

See Also

rb.chat.create, modify, remove()   

Syntax

number = rb.chat.flush(roomID)

Parameters

The 'flush' method takes 1 parameter:

Name Type/Value Range/Length Description
roomIDnumber  Required. Unique ID of the conversation from which to flush messages

Results

The 'flush' method returns number:

Type/Value Range/Length Description
number   Unique ID of the conversation that is successfully flushed. -1 if that room does not exist

Remarks

Remove all messages from a conversation

Whitebeam release 1.3.36
(loadtime : 185ms)