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

leave()

Iterate over audit records

See Also

rb.chat.create, modify, remove()   

Syntax

number = rb.chat.leave(roomID, contactID, key)

Parameters

The 'leave' method takes 3 parameters:

Name Type/Value Range/Length Description
roomIDnumber  Required. ID of the room this contact wants to leave
contactIDnumber  Required. ID of the contact to 'unsubscribe' from this room
keystring  Required. Key for this member (returned by 'join'). Must match in order to leave the session.

Results

The 'leave' method returns number:

Type/Value Range/Length Description
number   Create an iterator over a specified sub-set of conversations for this client

Remarks

Iterate over conversations

Whitebeam release 1.3.36
(loadtime : 181ms)