Enables scripted content fragments to use group members
Methods
Create
Adds accessing user to a given group role
Velocity
#set($groupRoleResponse = $core_v2_groupRoleMember.Create($groupId, $roleId, "%{ GroupMembershipType = $groupMembershipTypeArg }"))JavaScript
var groupRoleResponse = core_v2_groupRoleMember.Create(groupId, roleId, { GroupMembershipType: groupMembershipTypeArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Group Id | Required | ||
| roleId | Int32 | Role Id | Required | ||
| GroupMembershipType | String | Group Membership Type | Optional | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
Returns
Delete
Removes accessing user from a given group role
Velocity
#set($additionalInfoResponse = $core_v2_groupRoleMember.Delete($groupId, "%{ RoleId = $roleIdArg, Rolename = $rolenameArg }"))JavaScript
var additionalInfoResponse = core_v2_groupRoleMember.Delete(groupId, { RoleId: roleIdArg, Rolename: rolenameArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Group Id | Required | ||
| RoleId | Int32 | Either RoleId or Rolename is required | Optional | ||
| Rolename | String | Either RoleId or Rolename is required | Optional |
Returns
Get
Gets a group role membership for the accessing user
Velocity
#set($groupRoleResponse = $core_v2_groupRoleMember.Get($groupId, "%{ RoleId = $roleIdArg, Rolename = $rolenameArg }"))JavaScript
var groupRoleResponse = core_v2_groupRoleMember.Get(groupId, { RoleId: roleIdArg, Rolename: rolenameArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Group Id | Required | ||
| RoleId | Int32 | Either RoleId or Rolename is required | Optional | ||
| Rolename | String | Either RoleId or Rolename is required | Optional |
Returns
List
Lists group role members
Velocity
#set($pagedListResponse = $core_v2_groupRoleMember.List($groupId, "%{ MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))JavaScript
var pagedListResponse = core_v2_groupRoleMember.List(groupId, { MembershipType: membershipTypeArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | Int32 | Group Id | Required | ||
| MembershipType | String | Used to filter the results to just members of the type specified | Optional | Manager, Member, Owner, PendingMember | |
| PageIndex | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | String | Sort By | Optional | GroupName | GroupName, GroupSortOrder, MembershipType, RoleAddedDate, RoleName |
| SortOrder | String | Sort Order | Optional | Ascending | Ascending, Descending |