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

lookup()

Return the contact record with the specific alias, or 'null' if no contact is known by that alias.

See Also

rb.alias.get()   

Syntax

aliasType = rb.alias.lookup(type, alias, allData)

Parameters

The 'lookup' method takes 3 parameters:

Name Type/Value Range/Length Description
typestring  Required. The namespace in which the alias resides
aliasstring  Required. The unique (within namespace) name we're looking for
allDatanumber  Optional, default = 0

Specifies the amount of data to be included in the response for a particular arc.

'0' : return everything except 'customData'

1 :include customData
2 :Basic contact information
4 :Include contact's customData

Note each of these values represents a different set of data. You can select any or all data for a specific query. So for example a value of (1+4) would return audit information plus a basic copy of the entity that is the subject of that record


Results

The 'lookup' method returns structure:

Type/Value Range/Length Description
struct aliasType see definition Lookup a specific contact record by an alias

Remarks

Lookup the contact list for a contact with the specificied alias. If the record is not found then null is returned. The amount of data returned can be varied by the 'allData' parameter

Whitebeam release 1.3.36
(loadtime : 182ms)