This service is available via Telligent.Evolution.Extensibility.Apis.Get<Telligent.Evolution.Extensibility.Api.Version1.IForums>() and is defined in Telligent.Evolution.Forums.dll
Events
Events.AfterCreate
Handler
void ForumAfterCreateEventHandler(ForumAfterCreateEventArgs e);
Events.AfterDelete
Handler
void ForumAfterDeleteEventHandler(ForumAfterDeleteEventArgs e);
Events.AfterUpdate
Handler
void ForumAfterUpdateEventHandler(ForumAfterUpdateEventArgs e);
Events.BeforeCreate
Handler
void ForumBeforeCreateEventHandler(ForumBeforeCreateEventArgs e);
Events.BeforeDelete
Handler
void ForumBeforeDeleteEventHandler(ForumBeforeDeleteEventArgs e);
Events.BeforeUpdate
Handler
void ForumBeforeUpdateEventHandler(ForumBeforeUpdateEventArgs e);
Events.Render
Handler
void ForumRenderEventHandler(ForumRenderEventArgs e);
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ApplicationTypeId | Guid | Forums application type identifier | ||
| ContentTypeId | Guid | Forums content type identifier | ||
| TotalLicensedRemaining | int |
Methods
Forum Create(int groupId, string name, ForumsCreateOptions options = null);
Creates a forum
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| name | string | Name | Required | ||
| options | ForumsCreateOptions | Optional parameter names are: Description, AllowedThreadTypes, DefaultThreadType, Enabled, IndexPosts, ModeratePosts, EnablePostStatistics, EnabledQualityVoting, EnableMailingList, MailingListName, MailingListAddress, EmailFooter, EnablePassiveMode, PassiveModeAddress, MappedGalleryId, ExtendedAttributes | Optional |
Return Type
AdditionalInfo Delete(int id);
Deletes a forum
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Forum Id | Required |
Return Type
Forum Get(int id);
Gets a forum
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Forum Id | Required |
Return Type
Forum Get(Guid applicationId);
Gets a forum
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| applicationId | Guid | Forum Application Id | Required |
Return Type
Forum Get(string key, int groupId);
Gets a forum using the assigned key and its group's Id
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| key | string | Forum key | Required | ||
| groupId | int | Group Id | Required |
Return Type
PagedList<Forum> List(ForumsListOptions options = null);
Lists forums
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| options | ForumsListOptions | Optional parameter names are: GroupId, IncludeSubGroups, ApplicationIds, PageIndex, PageSize, UserId, PermissionId, SortBy, SortOrder. If left unspecified, sorting defaults to Sort Order Ascending. | Optional |
Return Type
void MarkAllRead(int forumId, bool read);
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| forumId | int | Forum Id | Required | ||
| read | bool | Read | Required |
Forum Update(int id, ForumsUpdateOptions options);
Updates a forum
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Forum Id | Required | ||
| options | ForumsUpdateOptions | Optional parameter names are: GroupId, Name, Description, AllowedThreadTypes, DefaultThreadType, Enabled, IndexPosts, ModeratePosts, EnablePostStatistics, EnableQualityVoting, EnableMailingList, MailingListName, MailingListAddress, EmailFooter, EnablePassiveMode, PassiveModeAddress, MappedGalleryId, ExtendedAttributes | Required |