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

Contact Template

unlinkItemContacts() - Available since version 0.9.36

Remove all contact records from a catalogue item.

Syntax

number = rb.contact.unlinkItemContacts(item, type)

Parameters

The 'unlinkItemContacts' method takes 2 parameters:

Name Type/Value Range/Length Description
itemnumber  Required. The Catalogue Item ID from which all contacts are to be removed.
typestring  Optional. Type of things to be removed. Set to 'INDIVIDUAL', 'COMMUNITY' or 'OU'. If not specified then removes all linked items.

Results

The 'unlinkItemContacts' method returns number:

Type/Value Range/Length Description
number  Returns 1 if successful -1 otherwise.

Remarks

unlinkItemContacts() is used to un-associate all contact records currently associated with a specific catalogue item

Note This method is new to release 0.9.36.
Whitebeam release 1.3.36
(loadtime : 82ms)