This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IGroupUserMembers>() and is defined in Telligent.Evolution.Platform.dll
Events
Events.AfterCreate
Handler
void GroupUserAfterCreateEventHandler(GroupUserAfterCreateEventArgs e);
Events.AfterDelete
Handler
void GroupUserAfterDeleteEventHandler(GroupUserAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void GroupUserAfterUpdateEventHandler(GroupUserAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void GroupUserBeforeCreateEventHandler(GroupUserBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void GroupUserBeforeDeleteEventHandler(GroupUserBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void GroupUserBeforeUpdateEventHandler(GroupUserBeforeUpdateEventArgs e);
Methods
GroupUser Create(int groupId, int userId, GroupUserMembersCreateOptions options = null);
Adds a user to a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| userId | int | User Id | Required | ||
| options | GroupUserMembersCreateOptions | Optional parameter names are: GroupMembershipType, Message | Optional |
Return Type
AdditionalInfo Delete(int groupId, GroupUserMembersDeleteOptions options);
Removes a user from a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| options | GroupUserMembersDeleteOptions | Optional parameter names are: UserId, Username | Required |
Return Type
GroupUser Get(int groupId, GroupUserMembersGetOptions options);
Gets a group user membership
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| options | GroupUserMembersGetOptions | Optional parameter names are: UserId, Username | Required |
Return Type
UserInvitation InviteUser(int groupId, string email, string groupMembershipType, string message);
Invites a user to a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
string | Required | ||||
| groupMembershipType | string | Group membership type | Required | EffectiveMember, Manager, Member, None, Owner, PendingMember | |
| message | string | Message | Required |
Return Type
AdditionalInfo InviteUser(int groupId, int userId, string groupMembershipType, string message);
Invites a user to a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| userId | int | User Id | Required | ||
| groupMembershipType | string | Group membership type | Required | EffectiveMember, Manager, Member, None, Owner, PendingMember | |
| message | string | Message | Required |
Return Type
PagedList<GroupUser> List(int groupId, GroupUserMembersListOptions options = null);
Lists group user members
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| options | GroupUserMembersListOptions | Optional parameter names are: GroupId, UserId, MembershipType, IncludeRoleMembers, SortBy, SortOrder, PageSize, PageIndex. If left unspecified, sorting defaults to Username Ascending. | Optional |
Return Type
PagedList<GroupUser> List(GroupUserMembersListOptions options = null);
Lists group user members
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | GroupUserMembersListOptions | Optional parameter names are: GroupId, UserId, MembershipType, IncludeRoleMembers, SortBy, SortOrder, PageSize, PageIndex. If left unspecified, sorting defaults to Username Ascending. | Optional |