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

rb.alias.aliasType

Represents a name by which a contact is known within a specific scope

Elements

The rb.alias.aliasType struct has 6 elements:

Name Type/Value Range/Length Description
typestring  Required. A name space 'scope' for the 'alias' value. The scope can be, for example, 'email', 'social', 'keys'. Application specific
aliasstring  Required. The name or identifier by which this contact is 'known' within this scope
contactIDnumber  Required. The contactID to which this alias record applies
ordernumber  Required. A numeric value which can be used to sort aliases within a specific scope. Application specific and could be used to prioritise specific names over others within the same scope. If not specified on create this value defaults to zero (0)
customDataMetaData  Optional. Application specific custom data associated with this alias
contactMetaData  Optional. Details of the contact' with which this alias record is associated. This is read only and only returned if allData requests this data set.

Whitebeam release 1.3.36
(loadtime : 194ms)