|
|
Whitebeam Template Reference Documentation
|
Contact Template
count()
Counts the number of entities that would be returned by a get() call
See Also
rb.contact.get Syntax
number = rb.contact.count(keywords, flags)
Parameters
The 'count' method takes 2 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 |
Results
The 'count' method returns number:
| Type/Value | Range/Length | Description |
| number |
-1, 0, or a positive integer | count of entities matching search criteria, or -1 to indicate that the call failed. |
Remarks Calling parameters are exactly the same as the get call.
Use this call to determine how to display contact information based on the number of
individuals to display.
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. These characters may be introduced by the integration partners implicitly or typed in by the user. This will mean however that these characters may not themselves be searched for. Only alphabetical characters and numbers may be used in a search.
|
|
|
(loadtime : 99ms) |
