Groups.getMembers (Method)
Returns zero or more structures, each containing information about a group's members. These members are users or other groups.
Returns:
Groups_GetMembers_Result (query)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| Description | PlainText | If the 'Type' member is 'User', this member contains the user's full Name (FirstName LastName). If 'Type' is 'Group', this member contains the group's description. |
| EmailAddress | EmailAddress | The email address of the user, empty string if a group. |
| FirstName | PlainText | If the 'Type' member is 'User', this member contains the user's first name. If 'Type' is 'Group', this member contains an empty string. |
| GroupType | GroupType_EmptyString | Normal or Visitor Context for groups, or empty string for users. |
| ID | UserGroupIDorOrphan | The ID of the user or group that is a member of this group. |
| LastName | PlainText | If the 'Type' member is 'User', this member contains the user's last name. If 'Type' is 'Group', this member contains an empty string. |
| MiddleName | PlainText | If the 'Type' member is 'User', this member contains the user's middle name or empty string if there is no middle name. If 'Type' is 'Group', this member contains an empty string. |
| Name | PlainText_NonNull | The member's name. The 'Type' member is 'User', this member contains the user ID (ssmith). If 'Type' is 'Group', this member contains the group's name. |
| Type | UserGroupType | A string indicating if this group member is a user or a group. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| groupIDList | GroupIDList_2 | Required | Comma delimited list of group's IDs other than 0 (Anonymous) or 1 (Authenticated Users). |
| type | UsersGroupsExtendedFilter | Optional. Defaults to 'All'. | A string indicating the types of records to return; for example, 'Users', 'Groups', 'RecurseUsers', 'RecurseGroups' or 'All'. 'RecurseUsers' tells CommonSpot that it should only return information for users contained in the specified group and any child groups. 'RecurseGroups' tells CommonSpot that it should only return information for a group contained within the specified groups and any of its child groups. |
| searchField | UserGroupSearchField | Optional. Defaults to 'LastName'. | Names the kind of members for which CommonSpot searches; for example, GroupDescription, GroupName, UserFirstName, and UserLastName. |
| searchOperator | SearchOperator_EmptyString | Optional. Defaults to an empty string. | A search operator or an empty string. Values for this argument can be 'Begins With', 'Contains', 'Ends With', or 'Equals'. |
| searchString | PlainText | Optional. Defaults to an empty string. | The value for which CommonSpot searches. |
| excludeList | UserGroupIDList_EmptyString | Optional. Defaults to an empty string. | A comma-delimited list of one or IDs of the groups that CommonSpot excludes from the search. An empty string tells CommonSpot that it should not exclude any groups. |
Context:
| License Requirements | None |
| Permission Requirements | Contributor |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | Transaction logging is disabled for this method |
| Customization | Customization is not supported for this method. |
Error Codes:
| Code | Error Message |
|---|---|
| 24000 | |
| 40012 | If you specify a search string, you must also specify a search operator. |
Notes:
None