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

remove()

Deletes an entity (individual or OU) or a community.

See Also

rb.contact.get
rb.contact.createCommunity
rb.contact.createOU
rb.contact.createIndividual

Syntax

number = rb.contact.remove(ID)

Parameters

The 'remove' method takes 1 parameter:

Name Type/Value Range/Length Description
IDnumberInteger Required. The ID of the community, or OU, or individual, as returned by a previous create or get call

Results

The 'remove' method returns number:

Type/Value Range/Length Description
number -1, or positive integerID of the entity deleted or -1 if the delete failed because an entity with the given IIID didn't exist

Remarks

An OU may not be removed if it has children, and a community may not be removed if it is non-empty.

Example

The following code deletes the user named "fred"
	  var fred = rb.contact.individualInfo(-1, "fred");

	  if(newID != null && (user = individualInfo(-1, "fred")))
	  rb.contact.link(user.ID, mega.ID);
	
Whitebeam release 1.3.36
(loadtime : 193ms)