|
|
Whitebeam Template Reference Documentation
|
Schedule Template
event.linkContacts()
Associates an event with one or more contact IDs.
Syntax
number = rb.schedule.event.linkContacts(eventID, contacts)
Parameters
The 'event.linkContacts' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | eventID | number | integer, valid ID | Required. The ID of the event record to be attached to the list of contacts. | | contacts | array of numbers | | Required. An array of IDs of contact IDs to associate with the eventID. |
Results
The 'event.linkContacts' method returns number:
| Type/Value | Range/Length | Description |
| number |
| ID of the event, or -1 if the link failed
|
Remarks linkContacts() takes a list of contact IDs and 'associates' (or breaks an association) with one or more
records in the contact template. Each entry in the contact list make be either the ID or a contact record or
the the 0-(the ID), that is the negative of an ID: Where the ID is positive, the event is linked to that contact Where the ID is negaitve, the event is unlinked from that contact Note this method returns no error if the target is not currently linked or unlinked from a requested ID. An error is however raised if one
of the IDs is illegal (does not exist or is of the wrong type). |
|
|
(loadtime : 67ms) |
