Forums In-Process API Service

Ben Tiedt — Fri, 15 Jan 2021 20:00:24 GMT

Current Revision posted to API Documentation by Ben Tiedt on 01/15/2021 20:00:24

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

Events.AfterDelete

Handler

void ForumAfterDeleteEventHandler([[ForumAfterDeleteEventArgs In-Process API Event Argument|ForumAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ForumAfterUpdateEventHandler([[ForumAfterUpdateEventArgs In-Process API Event Argument|ForumAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ForumBeforeCreateEventHandler([[ForumBeforeCreateEventArgs In-Process API Event Argument|ForumBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ForumBeforeDeleteEventHandler([[ForumBeforeDeleteEventArgs In-Process API Event Argument|ForumBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ForumBeforeUpdateEventHandler([[ForumBeforeUpdateEventArgs In-Process API Event Argument|ForumBeforeUpdateEventArgs]] e);

Properties

Name	Type	Description
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
groupId	`int`	Group Id	Required
name	`string`	Name	Required
options	`[[ForumsCreateOptions In-Process API Supplementary Type\|ForumsCreateOptions]]`	Optional parameter names are: Description, AllowedThreadTypes, DefaultThreadType, Enabled, IndexPosts, ModeratePosts, EnablePostStatistics, EnabledQualityVoting, EnableMailingList, MailingListName, MailingListAddress, EmailFooter, EnablePassiveMode, PassiveModeAddress, MappedGalleryId, ExtendedAttributes	Optional

Return Type

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

AdditionalInfo Delete(int id);

Deletes a forum

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Forum Id	Required

Return Type

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

Forum Get(int id);

Gets a forum

Parameters

Name	Type	Description	Required	Default	Options
id	`int`	Forum Id	Required

Return Type

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

Forum Get(Guid applicationId);

Gets a forum

Parameters

Name	Type	Description	Required	Default	Options
applicationId	`Guid`	Forum Application Id	Required

Return Type

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

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

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

PagedList<Forum> List(ForumsListOptions options = null);

Lists forums

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumsListOptions In-Process API Supplementary Type\|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

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

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 In-Process API Supplementary Type\|ForumsUpdateOptions]]`	Optional parameter names are: GroupId, Name, Description, AllowedThreadTypes, DefaultThreadType, Enabled, IndexPosts, ModeratePosts, EnablePostStatistics, EnableQualityVoting, EnableMailingList, MailingListName, MailingListAddress, EmailFooter, EnablePassiveMode, PassiveModeAddress, MappedGalleryId, ExtendedAttributes	Required

Return Type

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