|
Whitebeam Template Reference Documentation
|
Contact Template
createCommunity()
Creates a community definition.
See Also
rb.contact.individualInfo rb.contact.modifyCommunity rb.contact.link rb.contact.remove Syntax
number = rb.contact.createCommunity(values)
Parameters
The 'createCommunity' method takes 1 parameter:
Results
The 'createCommunity' method returns number:
Type/Value | Range/Length | Description |
number |
-1, or positive integer | Community ID of the created community, or -1 if the community couldn't be created.
|
Remarks If no uName is supplied in the passed data structure then a long machine generated text string is inserted into this field to guarantee uniqueness A common reason for failure of the create operation is attempting to set a duplicate uName value already existing in another Individual, Community, or OU entry. Example The following creates a new community with uName "friends":
var friends = new Object;
friends.name = "Friends";
friends.uName = "friends";
friends.description = "Friends of the site";
var newID = rb.contact.createCommunity(friends);
if(newID < 0)
rb.page.write("Create community failed, friends already exists");
|
|
(loadtime : 120ms) |