Whitebeam Template Reference Documentation
- Available since version 1.3.4
Adds or removes matching contacts to/from the identified community
number = rb.contact.bulkCommunityModify(keywords, flags, community)
The 'bulkCommunityModify' method takes 3 parameters:
|Name ||Type/Value ||Range/Length ||Description |
|keywords||array of strings||array 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|
|flags||struct searchFlags||see definition ||Required. Flags, see definition of searchflags|
|community||number|| ||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.|
The 'bulkCommunityModify' method returns number:
|Type/Value ||Range/Length ||Description |
||-1, 0, or a positive integer||count of contact records added or deleted from the database, or -1 to indicate that the search failed (invalid search parameters)
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.
(loadtime : 189ms)