GroupRoleMembers In-Process API Service

This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IGroupRoleMembers>() and is defined in Telligent.Evolution.Platform.dll

Events

Events.AfterCreate

Handler

void GroupRoleAfterCreateEventHandler(GroupRoleAfterCreateEventArgs e);

Events.AfterDelete

Handler

void GroupRoleAfterDeleteEventHandler(GroupRoleAfterDeleteEventArgs e);

Events.AfterUpdate

Handler

void GroupRoleAfterUpdateEventHandler(GroupRoleAfterUpdateEventArgs e);

Events.BeforeCreate

Handler

void GroupRoleBeforeCreateEventHandler(GroupRoleBeforeCreateEventArgs e);

Events.BeforeDelete

Handler

void GroupRoleBeforeDeleteEventHandler(GroupRoleBeforeDeleteEventArgs e);

Events.BeforeUpdate

Handler

void GroupRoleBeforeUpdateEventHandler(GroupRoleBeforeUpdateEventArgs e);

Methods

GroupRole Create(int groupId, int roleId, GroupRoleMembersCreateOptions options = null);

Adds accessing user to a given group role

Parameters

Name	Type	Description	Required
groupId	`int`	Group Id	Required
roleId	`int`	Role Id	Required
options	`GroupRoleMembersCreateOptions`	Optional parameter names are: GroupMembershipType	Optional

Return Type

GroupRole

AdditionalInfo Delete(int groupId, GroupRoleMembersDeleteOptions options);

Removes accessing user from a given group role

Parameters

Name	Type	Description	Required	Default	Options
groupId	`int`	Group Id	Required
options	`GroupRoleMembersDeleteOptions`	Optional parameter names are: RoleId, Rolename	Required

Return Type

AdditionalInfo

GroupRole Get(int groupId, GroupRoleMembersGetOptions options);

Gets a group role membership for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
groupId	`int`	Group Id	Required
options	`GroupRoleMembersGetOptions`	Optional parameter names are: RoleId, Rolename	Required

Return Type

GroupRole

PagedList<GroupRole> List(int groupId, GroupRoleMembersListOptions options = null);

Lists group role members

Parameters

Name	Type	Description	Required	Default	Options
groupId	`int`	Group Id	Required
options	`GroupRoleMembersListOptions`	Optional parameter names are: MembershipType, SortBy, SortOrder, PageSize, PageIndex. If left unspecified, sorting defaults to RoleName Ascending.	Optional

Return Type

PagedList<GroupRole>

Recommended