GroupRoleMembers In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:32:50 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:32:50

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 In-Process API Event Argument|GroupRoleAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void GroupRoleAfterDeleteEventHandler([[GroupRoleAfterDeleteEventArgs In-Process API Event Argument|GroupRoleAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void GroupRoleAfterUpdateEventHandler([[GroupRoleAfterUpdateEventArgs In-Process API Event Argument|GroupRoleAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void GroupRoleBeforeCreateEventHandler([[GroupRoleBeforeCreateEventArgs In-Process API Event Argument|GroupRoleBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void GroupRoleBeforeDeleteEventHandler([[GroupRoleBeforeDeleteEventArgs In-Process API Event Argument|GroupRoleBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void GroupRoleBeforeUpdateEventHandler([[GroupRoleBeforeUpdateEventArgs In-Process API Event Argument|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 In-Process API Supplementary Type\|GroupRoleMembersCreateOptions]]`	Optional parameter names are: GroupMembershipType	Optional

Return Type

[[GroupRole In-Process API Supplementary 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 In-Process API Supplementary Type\|GroupRoleMembersDeleteOptions]]`	Optional parameter names are: RoleId, Rolename	Required

Return Type

[[AdditionalInfo In-Process API Supplementary 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 In-Process API Supplementary Type\|GroupRoleMembersGetOptions]]`	Optional parameter names are: RoleId, Rolename	Required

Return Type

[[GroupRole In-Process API Supplementary 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 In-Process API Supplementary Type\|GroupRoleMembersListOptions]]`	Optional parameter names are: MembershipType, SortBy, SortOrder, PageSize, PageIndex. If left unspecified, sorting defaults to RoleName Ascending.	Optional

Return Type

[[PagedList(T) In-Process API Supplementary Type|PagedList]]<[[GroupRole In-Process API Supplementary Type|GroupRole]]>