rb.alias Object Description
(contact Template)

The rb.alias object provides a simple way of providing alternate 'names' for contact records. In this context name is any unique (within a name space) string that references exactly one contact.

An alias can be used in a number of ways to uniquely identify a contact:

• with a set of email addresses
• with a set of social media identifiers
• with a 'foreign key' from a third party application for integration purposes
• as part of an authentication strategy that goes beyond the password provided by the contact template.

The template provides the following capabilities:

• add/modify an alias to a contact
• remove an alias from a contact
• read the set of aliases stored against a specific contact
• search for the contact with a specific 'alias'

An 'alias' must be unique within a specific name space. That is:

name-space.alias

must be unique.

Methods

rb.alias.modify()	Make a set of changes to the stored aliases
rb.alias.get()	Iterate over alias records
rb.alias.count()	Count matching alias records
rb.alias.lookup()	Return the contact record with the specific alias, or 'null' if no contact is known by that alias.

Aggregate Types

rb.alias.aliasType	Represents a name by which a contact is known within a specific scope
rb.alias.aliasTypeOp	Represents a change to the set of aliases by which a contact is known
rb.alias.aliasQueryData	Flags used in 'rb.alias.get'