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

individualInfo()

Returns information on a named individual in the contacts database.

See Also

rb.contact.createIndividual
rb.contact.modifyIndividual

Syntax

individualData = rb.contact.individualInfo(ID, uName)

Parameters

The 'individualInfo' method takes 2 parameters:

Name Type/Value Range/Length Description
IDnumber-1, or positive integer Required. Either -1, meaning return the individual with Unique Name uName, or a valid OU ID as returned from a previous createIndividual() or get() call
uNamestring1-31 characters Optional. If ID == -1, then the individual with the given uName is returned, otherwise this field is ignored and may be empty.

Results

The 'individualInfo' method returns structure:

Type/Value Range/Length Description
struct individualData see definitionIndividual info.
If no individual matching the parameters exists, then an undef type will be returned instead of the struct.

Example

The following gets the user record with uName "fred" and prints out the full name:
	  fred = rb.contact.individualInfo(-1, "fred");
	  if(fred != null)
	  rb.page.write("Name is "+fred.name);
Whitebeam release 1.3.36
(loadtime : 87ms)