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

communityInfo()

Returns community information.

See Also

rb.contact.createCommunity
rb.contact.modifyCommunity
rb.contact.get

Syntax

communityData = rb.contact.communityInfo(ID, uName)

Parameters

The 'communityInfo' method takes 2 parameters:

Name Type/Value Range/Length Description
IDnumberpositive integer Required. Either -1, meaning return the community with Unique Name uName, or a valid community ID as returned from a previous createCommunity() or get() call
uNamestring1-31 characters Optional. If ID == -1, then the community with the given uName is returned, otherwise this field is ignored and may be empty.

Results

The 'communityInfo' method returns structure:

Type/Value Range/Length Description
struct communityData see definitionThe community information. If no community which matches the parameters exists, then an undefined object will be returned.

Remarks

The communityInfo is typically used to verify that a community exists.

Example

The following gets the community with uName "mycommunity" and prints out the description:
	  Info = rb.contact.communityInfo(-1, "mycommunity");
	  if(Info != null)
	  rb.page.write("Community description is "+Info.description);
Whitebeam release 1.3.36
(loadtime : 65ms)