Groups In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:06:33 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/19/2019 20:06:33

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

Events

Events.AfterCreate

Handler

void GroupAfterCreateEventHandler([[GroupAfterCreateEventArgs In-Process API Event Argument|GroupAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void GroupAfterDeleteEventHandler([[GroupAfterDeleteEventArgs In-Process API Event Argument|GroupAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void GroupAfterUpdateEventHandler([[GroupAfterUpdateEventArgs In-Process API Event Argument|GroupAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void GroupBeforeCreateEventHandler([[GroupBeforeCreateEventArgs In-Process API Event Argument|GroupBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void GroupBeforeDeleteEventHandler([[GroupBeforeDeleteEventArgs In-Process API Event Argument|GroupBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void GroupBeforeUpdateEventHandler([[GroupBeforeUpdateEventArgs In-Process API Event Argument|GroupBeforeUpdateEventArgs]] e);

Events.SelectTheme

Handler

void GroupSelectThemeEventHandler([[GroupSelectThemeEventArgs In-Process API Event Argument|GroupSelectThemeEventArgs]] e);

Properties

Name	Type	Description
ApplicationTypeId	`Guid`	Groups application type identifier
ContainerTypeId	`Guid`	Groups container type identifier
ContentTypeId	`Guid`	Groups content type identifier
Root	`[[Group In-Process API Supplementary Type\|Group]]`	Returns the root group of the site
ThemeTypeId	`Guid`	Groups theme type identifier
TotalLicensedRemaining	`int`

Methods

Group Create(string name, string groupType, GroupsCreateOptions options = null);

Creates a group

Parameters

Name	Type	Description	Required	Options
name	`string`	Name	Required
groupType	`string`	Group type	Required	Joinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
options	`[[GroupsCreateOptions In-Process API Supplementary Type\|GroupsCreateOptions]]`	Optional parameters are: Key, Description, ParentGroupId, EnableGroupMessages, AutoCreateApplications, ExtendedAttributes	Optional

Return Type

[[Group In-Process API Supplementary Type|Group]]

AdditionalInfo Delete(int id, bool? deleteApplications = null);

Deletes a group

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Group Id	Required
deleteApplications	`bool?`	Set to true if you want to delete child applications along with the group.	Optional

Return Type

[[AdditionalInfo In-Process API Supplementary Type|AdditionalInfo]]

Group Get(GroupsGetOptions options);

Gets a group

Parameters

Name	Type	Description	Required	Default	Options
options	`[[GroupsGetOptions In-Process API Supplementary Type\|GroupsGetOptions]]`	Optional parameters are: ContainerId, Id, Key, ParentGroupId	Required

Return Type

[[Group In-Process API Supplementary Type|Group]]

Group Get(Guid containerId);

Gets a group

Parameters

Name	Type	Description	Required	Default	Options
containerId	`Guid`	Container Id of the group	Required

Return Type

[[Group In-Process API Supplementary Type|Group]]

Group GetRootGroup();

Get the root group

Return Type

[[Group In-Process API Supplementary Type|Group]]

PagedList<Group> List(GroupsListOptions options = null);

Lists groups

Parameters

Name	Type	Description	Required	Default	Options
options	`[[GroupsListOptions In-Process API Supplementary Type\|GroupsListOptions]]`	Optional parameters are: UserId, Username, GroupNameFilter, ContainerIds, IncludePendingMembership, ParentGroupId, IncludeAllSubGroups, GroupTypes, PageSize, PageIndex, Permission, SortBy, SortOrder. If left unspecified, sorting defaults to Name Ascending.	Optional

Return Type

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

Group Update(int id, GroupsUpdateOptions options);

Updates a group

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Group Id	Required
options	`[[GroupsUpdateOptions In-Process API Supplementary Type\|GroupsUpdateOptions]]`	Optional parameters are: Name, Key, Description, ParentGroupId, GroupType, EnableGroupMessages, ExtendedAttributes	Required

Return Type

[[Group In-Process API Supplementary Type|Group]]