Groups (Component)

Almost all activities that occur in CommonSpot are associated with a user or a group of users (for example, you might have a group called 'webmasters'). The Groups object lets you create, add and delete members, obtain information about, and delete groups. A group's members can either be a user or a group. Also, as groups need administrators, one group can be specified as another group's administrator.

Methods marked below with [L] may be logged at the customer level (if transaction logging is licensed and enabled by the administrator)

Customization is not supported for this component.

Methods:

addAdministrators [L]	Adds users and groups as administrators for a group.
addMembers [L]	Adds members to a group. These new members can be users or other groups.
delete [L]	Deletes one or more groups.
deleteAdministrator [L]	Deletes a user or group from being a group's administrator.
deleteAdministrators [L]	Removes one or more users and groups from being administrators for a group.
deleteMember [L]	Deletes a member (either a user or group) from a group.
deleteMembers	Deletes one or more members (users and groups) from a group.
deleteMultiple	Deletes one or more groups.
deleteVisitorContextGroup [L]	Deletes the visitor context group with the passed groupID.
getAdministrators	Returns zero or more structures, each containing information about a group's administrators. This information includes the group or user ID, the name of the group or user, and if this administrator is a user or a group.
getCounts	Returns a structure containing information about groups; for example, the number of groups, the number of groups that do not have an administrator, and so on.
getExpiredUsers	Returns zero or more structures, each containing information about expired users, the groups they were in, and other related information.
getList	Returns zero or more structures, each containing information about the groups that meet the filter criteria described by this member's arguments.
getMembers	Returns zero or more structures, each containing information about a group's members. These members are users or other groups.
getNamesGivenIDs	Returns basic details of given list of users and/or group ids.
removeUsers [L]	Removes one or more users from one or more groups.
save [L]	Updates information for an existing group or creates a new one.
saveVisitorContextGroup [L]	Creates or updates a visitor context group.