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

System Template

linkContacts() - Available since version 1.3.12

Link a specific file to one or more contact IDs

See Also

rb.file.get()   

Syntax

number = rb.file.linkContacts(fileID, contactIDs)

Parameters

The 'linkContacts' method takes 2 parameters:

Name Type/Value Range/Length Description
fileIDnumberValid fileID Required. Identifier of file to be removed from the catalogue.
contactIDsarray of numbersValid fileID Required. Identifier of file to be removed from the catalogue.

Results

The 'linkContacts' method returns number:

Type/Value Range/Length Description
number 0.. 0 if the file doesn't exist, 1 if the changes are successfully made

Remarks

This method links (or unlinks) a specific file (by ID) to a list of one or more contact IDs. The contacts can be OUs, Communities or Individuals. If a value in the contactID array is +ve then the contact is linked to the file. If it is -ve then the link is broken.

Note: the file must exist, the contacts do not have to exist. No error is reported if the file is already attached/detached from a contact. The method expresses an intent for contact associations.
Whitebeam release 1.3.36
(loadtime : 57ms)