Methods
Create
Adds a user to a group
Usage
#set($groupUserResponse = $core_v2_groupUserMember.Create($groupId, $userId, "%{GroupMembershipType = $groupMembershipTypeArg, Message = $messageArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| userId | int | User Id | Required | | |
| GroupMembershipType | string | Group Membership Type | Optional | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
| Message | string | Ignored unless GroupMembershipType is PendingMember | Optional | | |
Return Type
GroupUser
Delete
Removes a user from a group
Usage
#set($additionalInfoResponse = $core_v2_groupUserMember.Delete($groupId, "%{UserId = $userIdArg, Username = $usernameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| UserId | int | Either UserId or Username is required | Optional | | |
| Username | string | Either UserId or Username is required | Optional | | |
Return Type
AdditionalInfo
Get
Gets a group user membership
Usage
#set($groupUserResponse = $core_v2_groupUserMember.Get($groupId, "%{UserId = $userIdArg, Username = $usernameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| UserId | int | Either UserId or Username is required | Optional | | |
| Username | string | Either UserId or Username is required | Optional | | |
Return Type
GroupUser
InviteUser
Invites a user to a group
Usage
#set($userInvitationResponse = $core_v2_groupUserMember.InviteUser($groupId, $email, $groupMembershipType, $message))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| email | string | Email Address | Required | | |
| groupMembershipType | string | Group Membership Type | Required | Member | EffectiveMember, Manager, Member, None, Owner, PendingMember |
| message | string | Message | Required | | |
Return Type
UserInvitation
List
Lists group user members
Usage
#set($pagedListResponse = $core_v2_groupUserMember.List("%{GroupId = $groupIdArg, IncludeRoleMembers = $includeRoleMembersArg, MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| GroupId | int | Either GroupId or UserId is required | Optional | | |
| IncludeRoleMembers | bool | 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 | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | string | Sort By | Optional | GroupName | GroupName, GroupSortOrder, MembershipDate, MembershipType, Score:SCORE_ID, UserEmail, UserJoinedDate, UserLastActiveDate, Username, UserPosts |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
| UserId | int | Either GroupId or UserId is required | Optional | | |
Return Type
PagedList<GroupUser>
List
Lists group user members
Usage
#set($pagedListResponse = $core_v2_groupUserMember.List($groupId, "%{IncludeRoleMembers = $includeRoleMembersArg, MembershipType = $membershipTypeArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| IncludeRoleMembers | bool | 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 | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | string | Sort By | Optional | GroupName | GroupName, GroupSortOrder, MembershipDate, MembershipType, Score:SCORE_ID, UserEmail, UserJoinedDate, UserLastActiveDate, Username, UserPosts |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
| UserId | int | User Id | Optional | | |
Return Type
PagedList<GroupUser>
ListEffectiveGroupMembers
Lists effective group members
Usage
#set($pagedListResponse = $core_v2_groupUserMember.ListEffectiveGroupMembers($groupId, "%{PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|
| groupId | int | Group Id | Required | | |
| PageIndex | int | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
| PageSize | int | Specify the number of results to return per page. | Optional | 20 | |
| SortBy | string | Sort By | Optional | Score:SCORE_ID | Score:SCORE_ID |
| SortOrder | string | Sort Order | Optional | Descending | Ascending, Descending |
Return Type
PagedList<GroupUser>