Developer Function: Server Script: groupMember
## Overview
This object reads "Group Member" information available in "[Server Script](/en/manual/table-management-server-script)". A collection of "groupMember objects" can be retrieved using the 「group.GetMembers」 method of the "[group](/en/manual/server-script-group) object".
## Properties
|No| Property Name | get | set | type | Description |
|--:|:--|:-:|:-:|:--|:--|
| 1| GroupId | ○ | | int | Group ID |
| 2| GroupName | ○ | | string | Group name<span style="color:red; vertical-align: super;">*1</span> |
| 3| DeptId | ○ | | int | Department ID |
| 4| DeptName | ○ | | string | Department name<span style="color:red; vertical-align: super;">*1</span> |
| 5| DeptCode | ○ | | string | Department code<span style="color:red; vertical-align: super;">*1</span> |
| 6| UserId | ○ | | int | User ID |
| 7| LoginId | ○ | | string | Login ID<span style="color:red; vertical-align: super;">*1</span> |
| 8| Name | ○ | | string | User name<span style="color:red; vertical-align: super;">*1</span> |
| 9| UserCode | ○ | | string | User code<span style="color:red; vertical-align: super;">*1</span> |
|10| TenantManager | ○ | | bool | True if the user is a tenant administrator<span style="color:red; vertical-align: super;">*1</span> |
|11| Disabled | ○ | | bool | True if disabled<span style="color:red; vertical-align: super;">*1</span> |
|12| Admin | ○ | | bool | True if the user has [group administration privileges](/manual/group-add-user) |
<span style="color:red">*1</span> Available in version 1.5.2.0 and later
Depending on whether the group member is a "[Department](/en/manual/dept)", "[Group](/en/manual/group)", or "[User](/en/manual/table-management-choices-text-users)", the GroupId, DeptId, and UserId properties are populated as shown in the table below.
||Member is a User|Member is a Department|Member is a Child Group|
|:-:|:-:|:-:|:-:|
|GroupId|0|0|Group ID|
|DeptId|0|Department ID|0|
|UserId|User ID|0|0|
## Examples
### Example for Version 1.5.1.0 and Earlier
The following example logs the department ID and user ID of each member belonging to group ID 1.
##### JavaScript
```js
let group = groups.Get(1);
for (let member of group.GetMembers()) {
context.Log(`${member.DeptId},${member.UserId}`);
}
```
### Example for Version 1.5.2.0 and Later
The following example retrieves member information for group ID 6 and differentiates the retrieved data based on whether the member is a user, department, or child group.
##### JavaScript
```js
// Retrieve the group object for group ID = 6
let group = groups.Get(6);
// Initialize output count counter
let cnt = 0;
// Process only if the group exists
if (group) {
// Iterate over the group member list
// GetMembers() returns user, department, and group members
for (let member of group.GetMembers()) {
// Determine member type: only one of UserId / DeptId / GroupId will be non-zero
if (member.UserId != 0) {
// UserId != 0: user member
context.Log(`
[User]
UserId : ${member.UserId} // User ID
LoginId : ${member.LoginId} // Login ID
Name : ${member.Name} // Display name
UserCode : ${member.UserCode} // User code
TenantManager : ${member.TenantManager} // Tenant administrator flag
Disabled : ${member.Disabled} // Disabled flag
Admin : ${member.Admin} // Group administrator flag
`);
} else if (member.DeptId != 0) {
// DeptId != 0: department member
context.Log(`
[Department]
DeptId : ${member.DeptId} // Department ID
DeptName : ${member.DeptName} // Department name
DeptCode : ${member.DeptCode} // Department code
`);
} else if (member.GroupId != 0) {
// GroupId != 0: group member (nested group)
context.Log(`
[Group]
GroupId : ${member.GroupId} // Group ID
GroupName : ${member.GroupName} // Group name
`);
}
// Separator line between members
context.Log('-----');
// Increment output count
cnt++;
}
}
// Output the total number of processed members
context.Log(`Output count: ${cnt}`);
```
## Supported Versions
|Supported Version|Details|
|---|---|
|1.5.2.0 and later|Added the following properties to the groupMember object:<br>GroupName, DeptName, DeptCode, LoginId, Name,<br>UserCode, TenantManager, Disabled|
## Related Information
<div id="ManualList"><ul><li><a href="/en/manual/table-management-choices-text-depts">Table Management: Editor: Item Detail Settings: Option List: Departments</a><span>08.13.2024 up</span></li>
<li><a href="/en/manual/table-management-choices-text-users">Table Management: Editor: Item Detail Settings: Option List: User</a><span>08.13.2024 up</span></li></ul></article>
<ul><li><a href="/en/manual/table-management-server-script">Table Management: Server Script</a><span>08.13.2024 up</span></li></ul></article>
<ul><li><a href="/en/manual/dept">Department Management Function</a><span>08.13.2024 up</span></li></ul></article>
<ul><li><a href="/en/manual/group">Group Management Function</a><span>10.08.2024 up</span></li></ul></article>
<ul><li><a href="/en/manual/server-script-group">Developer Function: Server Script: group</a><span>10.04.2024 up</span></li></ul></article></div><input id="SearchTextHidden" type="hidden" value="" />
