|
|
Whitebeam Template Reference Documentation
|
Contact Template
linkCatItem()
Associates an entity (Community OU or individual) with a catalogue Item.
Syntax
number = rb.contact.linkCatItem(target, node)
Parameters
The 'linkCatItem' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | target | number | integer, valid ID | Required. The ID of the OU or individual to be attached to a new parent (higher up the organisational heirarchy) | | node | number | | Required. The Catalogue Item ID to be associated with the target contact. |
Results
The 'linkCatItem' method returns number:
| Type/Value | Range/Length | Description |
| number |
| ID of the Item, or -1 if the link failed |
Remarks link() is used to associate individuals with both parent OUs or communities. Allowable combinations are: - An individual may be linked to a parent OU (in which case it inherits membership of that OU, its parents and community memberships).
- An individual may be linked directly to a community
- An OU may be linked to a parent OU (in which case all direct and indirect children become indirect members of the parent OU, its parents and any communities of which it is a member).
- An OU may be linked to a community (in which case all direct and indirect children become members of the community by inheritance as long as they remain linked to the OU)
|
|
|
(loadtime : 87ms) |
