|
|
Whitebeam Template Reference Documentation
|
Chat Template
join()
Return unique key for this contact for this conversation
See Also
rb.chat.() Syntax
string = rb.chat.join(roomID, contactID, flags, name)
Parameters
The 'join' method takes 4 parameters:
| Name | Type/Value | Range/Length | Description | | roomID | number | | Required. Room to which this contact wishes to join | | contactID | number | | Required. If >0 then join this contact ID to the conversation (eg new member) | | flags | number | | Required. Bit map value. The following bits are reservered for the template :
- 0: If set - allowed to post
- 1: If set may request to post
- 2: Room moderator
- 3: Room admin
| | name | string | | Required. Name used to represent this member to other people in the conversation. Usually contact name |
Results
The 'join' method returns string:
| Type/Value | Range/Length | Description |
| string |
|
Key for this contact in this conversation
|
Remarks Request join conversation. A contact ID must request to join a conversation. In response the
chat template returns a unique key to be presented with the contact ID for each poll request. Several error values can be returned instead of a key : - 'full' : the room is full
- 'noexist' : the room doesn't exist
|
|
|
(loadtime : 96ms) |
