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

bulkCommunityModify() - Available since version 1.3.4

Adds or removes matching contacts to/from the identified community

See Also

rb.contact.getrb.contact.countrb.contact.bulkRemove

Syntax

number = rb.contact.bulkCommunityModify(keywords, flags, community)

Parameters

The 'bulkCommunityModify' method takes 3 parameters:

Name Type/Value Range/Length Description
keywordsarray of stringsarray of 0-10 keyword strings, of < 128 characters each Required. A list of up to 10 keywords to be searched for. Keywords are additive (that is to say that searches will match any entry which contains any of the keywords
flagsstruct searchFlagssee definition Required. Flags, see definition of searchflags
communitynumber  Required. If positive then the community ID to which all matching individuals are to be added. If negative then the (-) community from which all matching individuals are to be removed.

Results

The 'bulkCommunityModify' method returns number:

Type/Value Range/Length Description
number -1, 0, or a positive integercount of contact records added or deleted from the database, or -1 to indicate that the search failed (invalid search parameters)

Remarks

Calling parameters are exactly the same as the get and count methods.

Restrictions apply. Only individuals may be added to/removed from a community using this method. If the search specification has searchOU or searchCommunity set to true then an exception is returned to the application

Use this call to add to or remove a community all contacts (individuals) that meet a specific search category.

The keywords array holds a list of all keywords to be searched for. Wildcards of % (representing any length of unspecified characters) and _ (representing a single unspecified character) can be used in the search. Only alphabetical characters and numbers may be used in a search.

Whitebeam release 1.3.36
(loadtime : 189ms)