Represents a user group, which collects user accounts into a group for easier permissions management. In this way,
groups essentially serve the same purpose that they do in Unix or Windows.
Note that this isn't for working with social groups. For that type, see
SocialGroup
.
Type Template
<...>
<ID>xs:long</ID>
<objectType>xs:int</objectType>
<creationDate>xs:dateTime</creationDate>
<description>xs:string</description>
<memberCount>xs:int</memberCount>
<modificationDate>xs:dateTime</modificationDate>
<name>xs:string</name>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| creationDate
|
- Setting
- Sets the creation date of the group. In most cases, the creation date will default to when
the group was entered into the system. However, the date needs to be set manually when
importing data. In other words, skin authors should ignore this since it only intended
for system maintenance.
- Getting
- Returns the date that the group was created.
|
| description
|
- Setting
- Sets the description of the group. The description often summarizes a group's function, such
as 'Administrators of the XYZ community'. This method is restricted to those with group
administration permission.
- Getting
- Returns the description of the group. The description often summarizes a group's function,
such as 'Administrators of the XYZ community'.
|
| ID
|
- Setting
- Set the unique id of this object.
- Getting
|
| memberCount
|
- Setting
- Sets the number of user accounts in this group.
- Getting
- Returns the number of user accounts in this group.
|
| modificationDate
|
- Setting
- Sets the date the group was last modified. Skin authors should ignore this since it
only intended for system maintenance.
- Getting
- Returns the date that the group was last modified.
|
| name
|
- Setting
- Sets the name of the group. For example, 'XYZ Admins'. This method is restricted to those
with group administration permission.
- Getting
- Returns the name of the group. For example, 'XYZ Admins'.
|
| objectType
|
- Setting
- Sets the object type of the jive object.
- Getting
|