Enables scripted content fragments to use group members
Methods
Create
Adds a user to a group
Velocity
#set($groupUserResponse = $core_v2_groupUserMember.Create($groupId, $userId, "%{ GroupMembershipType = $groupMembershipTypeArg, Message = $messageArg }"))
JavaScript
var groupUserResponse = core_v2_groupUserMember.Create(groupId, userId, { GroupMembershipType: groupMembershipTypeArg, Message: messageArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
userId | Int32 | User Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
GroupMembershipType | String | Group Membership Type | Optional | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
Message | String | Ignored unless GroupMembershipType is PendingMember | Optional |
Returns
Delete
Removes a user from a group
Velocity
#set($additionalInfoResponse = $core_v2_groupUserMember.Delete($groupId, "%{ UserId = $userIdArg, Username = $usernameArg }"))
JavaScript
var additionalInfoResponse = core_v2_groupUserMember.Delete(groupId, { UserId: userIdArg, Username: usernameArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
UserId | Int32 | Either UserId or Username is required | Optional | ||
Username | String | Either UserId or Username is required | Optional |
Returns
Get
Gets a group user membership
Velocity
#set($groupUserResponse = $core_v2_groupUserMember.Get($groupId, "%{ UserId = $userIdArg, Username = $usernameArg }"))
JavaScript
var groupUserResponse = core_v2_groupUserMember.Get(groupId, { UserId: userIdArg, Username: usernameArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
UserId | Int32 | Either UserId or Username is required | Optional | ||
Username | String | Either UserId or Username is required | Optional |
Returns
InviteUser
InviteUser Overload 1
Invites a user to a group
Velocity
#set($userInvitationResponse = $core_v2_groupUserMember.InviteUser($groupId, $email, $groupMembershipType, $message))
JavaScript
var userInvitationResponse = core_v2_groupUserMember.InviteUser(groupId, email, groupMembershipType, message);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
String | Email Address | Required | |||
groupMembershipType | String | Group Membership Type | Required | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
message | String | Message | Required |
InviteUser Overload 2
Invites a user to a group
Velocity
#set($userInvitationResponse = $core_v2_groupUserMember.InviteUser($groupId, $userId, $groupMembershipType, $message))
JavaScript
var userInvitationResponse = core_v2_groupUserMember.InviteUser(groupId, userId, groupMembershipType, message);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
userId | Int32 | User Id | Required | ||
groupMembershipType | String | Group Membership Type | Required | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
message | String | Message | Required |
Returns
List
List Overload 1
Lists group user members
Velocity
#set($pagedListResponse = $core_v2_groupUserMember.List("%{ GroupId = $groupIdArg, IncludeRoleMembers = $includeRoleMembersArg, MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, UsernameFilter = $usernameFilterArg }"))
JavaScript
var pagedListResponse = core_v2_groupUserMember.List({ GroupId: groupIdArg, IncludeRoleMembers: includeRoleMembersArg, MembershipType: membershipTypeArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserId: userIdArg, UsernameFilter: usernameFilterArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
GroupId | Int32 | Either GroupId or UserId is required | Optional | ||
IncludeRoleMembers | Boolean | When making a users request can optionally include users who are also role members instead of just direct members. | Optional | False | |
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 | DisplayName, GroupName, GroupSortOrder, MembershipDate, MembershipType, Score:SCORE_ID, UserEmail, UserJoinedDate, UserLastActiveDate, Username, UserPosts |
SortOrder | String | Sort Order | Optional | Ascending | Ascending, Descending |
UserId | Int32 | Either GroupId or UserId is required | Optional | ||
UsernameFilter | String | Used to filter the results to members matching the specified username filter. | Optional |
List Overload 2
Lists group user members
Velocity
#set($pagedListResponse = $core_v2_groupUserMember.List($groupId, "%{ IncludeRoleMembers = $includeRoleMembersArg, MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, UsernameFilter = $usernameFilterArg }"))
JavaScript
var pagedListResponse = core_v2_groupUserMember.List(groupId, { IncludeRoleMembers: includeRoleMembersArg, MembershipType: membershipTypeArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserId: userIdArg, UsernameFilter: usernameFilterArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
IncludeRoleMembers | Boolean | When making a users request can optionally include users who are also role members instead of just direct members. | Optional | False | |
MembershipType | String | Used to filter the results to just members of the type specified | Optional | EffectiveMember, Manager, Member, None, 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 | DisplayName, GroupName, GroupSortOrder, MembershipDate, MembershipType, Score:SCORE_ID, UserEmail, UserJoinedDate, UserLastActiveDate, Username, UserPosts |
SortOrder | String | Sort Order | Optional | Ascending | Ascending, Descending |
UserId | Int32 | User Id | Optional | ||
UsernameFilter | String | Search for user in a group. GroupId is required. | Optional |
Returns
ListEffectiveGroupMembers
Lists effective group members
Velocity
#set($pagedListResponse = $core_v2_groupUserMember.ListEffectiveGroupMembers($groupId, "%{ MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserNameFilter = $userNameFilterArg }"))
JavaScript
var pagedListResponse = core_v2_groupUserMember.ListEffectiveGroupMembers(groupId, { MembershipType: membershipTypeArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserNameFilter: userNameFilterArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
MembershipType | String | Membership Type | Optional | None | EffectiveMember, Manager, Member, None, 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 | Score:SCORE_ID | DisplayName, Score:SCORE_ID |
SortOrder | String | Sort Order | Optional | Descending | Ascending, Descending |
UserNameFilter | String | User Name Filter | Optional |