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

memberOf()

Given an Individual or OU returns all the entities of which the target is a member.

See Also

rb.contact.link
rb.contact.whosIn

Syntax

dataArray = rb.contact.memberOf(container)

Parameters

The 'memberOf' method takes 1 parameter:

Name Type/Value Range/Length Description
containernumberpositive integer > 0 Required. The ID of a valid Individual, OU, or Community.

Results

The 'memberOf' method returns an array of structure:

Type/Value Range/Length Description
struct data see definition Array of contact entities (Individuals. OUs and Communities) of which this contact entity is a member

Remarks

As well as any OUs or Communities of which this entity is directly or indirectly a member, memberOf() will always return a record for the individual or OU itself. This is orthogonal with the validate() method and the security model under which an entity is a valid container of itself for authentication and validation purposes. This means that memberOf will always return at least one record, even for isolated individuals who have not been linked to any OU or community.

Example

var friends = rb.contact.communityInfo(-1, "");
	  var members = rb.contact.memberOf(friends.ID);
	  for (var x in members)
	  rb.page.write(members[x].name+" is a member of "+friends.name+"<BR>");
	
Whitebeam release 1.3.36
(loadtime : 198ms)