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

modifyIndividual()

Modifies an Individual entity

See Also

rb.contact.remove
rb.contact.link
rb.contact.createOU

Syntax

number = rb.contact.modifyIndividual(values, setPasswordType)

Parameters

The 'modifyIndividual' method takes 2 parameters:

Name Type/Value Range/Length Description
valuesstruct individualDatasee definition Required. New individual info
setPasswordTypenumber  Optional. 0/null: Do not set password
1: Set password
2: Set password hash

Available from version : 1.3.9


Results

The 'modifyIndividual' method returns number:

Type/Value Range/Length Description
number -1, or positive integer ID of the modified record, or -1 if the record couldn't be modified.

Remarks

Modify changes all of those properties which are set in the passed values object. Properties which are not set in the object will not be changed in the contact database. ID must be set for modify to succeed

Example

The following example gets the Individual information for "fred", and modifies the description string

	  var fred = rb.contact.individualInfo(-1, "fred")
	  if(fred != null){
	  fred.description = "A new description";
	  rb.contact.modifyIndividual(fred);
	  }
	
Whitebeam release 1.3.36
(loadtime : 194ms)