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
rb.alias1.3.34
rb.contact0.9.0Usage

Methods

rb.contact.communityInfo() Returns community information.
rb.contact.createCommunity() Creates a community definition.
rb.contact.createOU() Creates an OU entity
rb.contact.createIndividual() Creates and Individual contact entity.
rb.contact.remove() Deletes an entity (individual or OU) or a community.
rb.contact.individualInfo() Returns information on a named individual in the contacts database.
rb.contact.link() Associates an entity (OU or individual) with a different parent OU or a community.
rb.contact.linkList() Associates an entity (OU or individual) with a different parent OU or a community.
rb.contact.linkCatNode() Associates an entity (Community OU or individual) with a catalogue node
rb.contact.linkCatItem() Associates an entity (Community OU or individual) with a catalogue Item.
rb.contact.OUInfo() Returns OU information.
rb.contact.memberOf() Given an Individual or OU returns all the entities of which the target is a member.
rb.contact.modifyCommunity() Modifies community information.
rb.contact.modifyOU() Modifies an OU entity
rb.contact.modifyIndividual() Modifies an Individual entity
rb.contact.get() Searches for individuals, OUs, or communities in the contacts database.
rb.contact.setPassword() Sets the password for an Individual
rb.contact.validate() Validates access control for an individual
rb.contact.count() Counts the number of entities that would be returned by a get() call
rb.contact.unlinkCatNode() Disassociates an entity (Community OU or individual) with a catalogue node
rb.contact.unlinkCatItem() Disassociates an entity (Community OU or individual) with a catalogue Item.
rb.contact.unlinkContacts() Bulk remove contact records from a community or OU
rb.contact.unlinkItemContacts() Remove all contact records from a catalogue item.
rb.contact.unlinkNodeContacts() Remove all contact records from a catalogue node.
rb.contact.unlink() Disassociates an entity (OU or individual) from a parent OU or a community
rb.contact.whosIn() Given a community or OU returns all the individuals and OUs that are linked to it.
rb.contact.bulkRemove() Deletes contacts that match the search criteria
rb.contact.bulkCommunityModify() Adds or removes matching contacts to/from the identified community
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.contact.location Represents a geographical location
rb.contact.searchLocation Allows a geolocation search within a specific radius of a [long,lat] point
rb.contact.data Superset of information available from all contact entity types
rb.contact.OUData OU Specific contact information
rb.contact.individualData Individual Specific contact information
rb.contact.communityData Community specific information
rb.contact.searchFlags Flags controlling contact search operations
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'
Whitebeam release 1.3.36
(loadtime : 76ms)