|
|
Whitebeam Object Definition
|
Member.searchFlags
Flags controlling contact search operations
Elements
The Member.searchFlags struct has 7 elements:
| Name | Type/Value | Range/Length | Description | | rootID | number | integer | Optional, default = 0
0, meaning search the whole membership tree, or a valid OU ID, meaning search only for entities under that OU or in that community | | allLevels | bool | 0,1 | Optional, default = 1
0: Search only among immediate children of rootID 1: search whole tree below rootID | | searchKeywords | bool | 0,1 | Optional, default = 0
If 1, search the user defined keywords. | | searchName | bool | 0,1 | Optional, default = 1
If 1, search for the keyword within the Name field | | firstIndex | number | 0, or positive integer | Optional, default = 0
Skip the first n results (used in multiple page sequences to skip previously fetched results) | | isIn | array of numbers | 0-20 valid IDs | Optional. If this array exists and is populated, then only members which are within any of the specified Communities, IDs or Individuals are returned | | inAll | bool | true | false | Optional, default = 0
If set and true, then returned members must be in all containers specified in the isIn array, otherwise members in any container will be returned |
|
|
|
(loadtime : 10ms) |
