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 e);
Events.AfterDelete
Handler
void GroupAfterDeleteEventHandler(GroupAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void GroupAfterUpdateEventHandler(GroupAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void GroupBeforeCreateEventHandler(GroupBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void GroupBeforeDeleteEventHandler(GroupBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void GroupBeforeUpdateEventHandler(GroupBeforeUpdateEventArgs e);
Events.SelectTheme
Handler
void GroupSelectThemeEventHandler(GroupSelectThemeEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ApplicationTypeId | Guid | Groups application type identifier | ||
| ContainerTypeId | Guid | Groups container type identifier | ||
| ContentTypeId | Guid | Groups content type identifier | ||
| Root | 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 | Default | Options |
|---|---|---|---|---|---|
| name | string | Name | Required | ||
| groupType | string | Group type | Required | Joinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen | |
| options | GroupsCreateOptions | Optional parameters are: Key, Description, ParentGroupId, EnableGroupMessages, AutoCreateApplications, ExtendedAttributes | Optional |
Return Type
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
Group Get(GroupsGetOptions options);
Gets a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | GroupsGetOptions | Optional parameters are: ContainerId, Id, Key, ParentGroupId | Required |
Return Type
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 GetRootGroup();
Get the root group
Return Type
PagedList<Group> List(GroupsListOptions options = null);
Lists groups
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | 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
Group Update(int id, GroupsUpdateOptions options);
Updates a group
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Group Id | Required | ||
| options | GroupsUpdateOptions | Optional parameters are: Name, Key, Description, ParentGroupId, GroupType, EnableGroupMessages, ExtendedAttributes | Required |