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.aliasTypeOp

Represents a change to the set of aliases by which a contact is known

Elements

The rb.alias.aliasTypeOp 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  Optional. The name or identifier by which this contact is 'known' within this scope
contactIDnumber  Optional. The contactID to which this alias record applies
ordernumber  Optional, default = 0
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.
customDataMetaData  Optional. Application specific custom data associated with this name
removebool  Optional. If 'true' then 'modify' deletes the alias record for this individual. Otherwise it creates or modifies the existing record.

Whitebeam release 1.3.36
(loadtime : 209ms)