group
Overview¶
This object is used to read "Group" information in "Server Script". It is obtained using the Get method of the "groups object".
Properties¶
| No | Property name | get | set | type | Description |
|---|---|---|---|---|---|
| 1 | GroupId | Yes | No | int | Group ID |
| 2 | GroupName | Yes | No | string | Group name |
| 3 | Body | Yes | No | string | Contents |
| 4 | Disabled | Yes | No | bool | Disabled |
Columns you cannot view
From version 1.5.10.0, the values of columns that the user running the server script cannot view are null (the properties themselves remain). By default, only tenant managers can view Disabled.
You can change which columns can be viewed in Column.json. For details, see "Extended Column".
Methods¶
| No | Name | Description |
|---|---|---|
| 1 | GetMembers | Get the "groupMember object" in the "Group". |
| 2 | GroupChildren | Get the "group object" of the "Child Group" in the "Group". |
| 3 | ContainsDept | Return true if the "Group" contains a "Dept". |
| 4 | ContainsUser | Return true if the "Group" contains a "User". |
| 5 | ContainsChild | Return true if the "Group" contains a "Child Group". |
Usage Examples¶
In the example below, a "group object" with group ID 1 is obtained from the "groups object" and the department IDs and user IDs of the members are output to the log while "group members" are enumerated.
JavaScript¶
let group = groups.Get(307);
for (let member of group.GetMembers()) {
context.Log(`${member.DeptId},${member.UserId}`);
}
Supported Versions¶
| Supported versions | Body |
|---|---|
| 1.5.10.0 and later | Changed the values of columns that the user cannot view to null |
Related Information¶
- Group Management Function
- Manage Table: Server Script
- Developer's Guide: Server Script: group.GetMembers
- Developer's Guide: Server Script: group.GetChildren
- Developer's Guide: Server Script: group.ContainsDept
- Manage Table: Editor: Column Advanced Settings: Option List: Department
- Developer's Guide: Server Script: group.ContainsUser
- Manage Table: Editor: Column Advanced Settings: Option List: User
- Developer's Guide: Server Script: group.ContainsChild