|
|
Whitebeam Template Reference Documentation
|
Chat Template
linkContacts()
Syntax
number = rb.chat.linkContacts(target, contacts)
Parameters
The 'linkContacts' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | target | number | integer, valid room ID | Required. The ID of the room that is to be linked/unlinked from contact IDs. | | contacts | array of numbers | | Required. An array of IDs of contacts (and up to 1 OU) to associate with the room. |
Results
The 'linkContacts' method returns number:
| Type/Value | Range/Length | Description |
| number |
|
Each entry in the array is the ID of a contact record. If the ID is negative then unlink from the (+ve) value
contact record. Errors are ignored in this call. No error is caused by linking to a contact to which a
room is already linked, removing from a contact that is not currently linked to the room.
|
|
|
|
(loadtime : 224ms) |
