|
|
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 | | type | string | | Required. A name space 'scope' for the 'alias' value. The scope can be, for example, 'email', 'social', 'keys'. Application specific | | alias | string | | Optional. The name or identifier by which this contact is 'known' within this scope | | contactID | number | | Optional. The contactID to which this alias record applies | | order | number | | 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. | | customData | MetaData | | Optional. Application specific custom data associated with this name | | remove | bool | | Optional. If 'true' then 'modify' deletes the alias record for this individual. Otherwise it creates or modifies the existing record. |
|
|
|
(loadtime : 66ms) |
