|
|
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 | | roomID | number | | Required. ID of the room this contact wants to leave | | contactID | number | | Required. ID of the contact to 'unsubscribe' from this room | | key | string | | 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 |
|
|
(loadtime : 140ms) |
