ForumThreads In-Process API Service

Ben Tiedt — Fri, 08 Mar 2024 17:31:43 GMT

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

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

Events

Events.AfterCreate

Handler

void ForumThreadAfterCreateEventHandler([[ForumThreadAfterCreateEventArgs In-Process API Event Argument|ForumThreadAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ForumThreadAfterDeleteEventHandler([[ForumThreadAfterDeleteEventArgs In-Process API Event Argument|ForumThreadAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ForumThreadAfterUpdateEventHandler([[ForumThreadAfterUpdateEventArgs In-Process API Event Argument|ForumThreadAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ForumThreadBeforeCreateEventHandler([[ForumThreadBeforeCreateEventArgs In-Process API Event Argument|ForumThreadBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ForumThreadBeforeDeleteEventHandler([[ForumThreadBeforeDeleteEventArgs In-Process API Event Argument|ForumThreadBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ForumThreadBeforeUpdateEventHandler([[ForumThreadBeforeUpdateEventArgs In-Process API Event Argument|ForumThreadBeforeUpdateEventArgs]] e);

Events.Render

Handler

void ForumThreadRenderEventHandler([[ForumThreadRenderEventArgs In-Process API Event Argument|ForumThreadRenderEventArgs]] e);

Properties

Name	Type	Description	Default	Options
ContentTypeId	`Guid`	Forum Threads content type identifier

Methods

PollItem AddPollItem(int replyId, string answer, int orderNumber);

Obsolete. Deprecated in 8.5, use poll embedding instead.

Adds a poll option to a thread. Deprecated in 8.5, use poll embedding instead.

Parameters

Name	Type	Description	Required
replyId	`int`	Reply Id	Required
answer	`string`	Answer	Required
orderNumber	`int`	OrderNumber	Required

Return Type

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

bool AllowsReplies(Guid contentId);

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Content Id	Required

Return Type

bool

ForumThread Create(int forumId, string subject, string body, ForumThreadsCreateOptions options = null);

Creates a Forum Thread

Parameters

Name	Type	Description	Required
forumId	`int`	Forum Id	Required
subject	`string`	Subject	Required
body	`string`	Body	Required
options	`[[ForumThreadsCreateOptions In-Process API Supplementary Type\|ForumThreadsCreateOptions]]`	Optional parameter names are: IsSticky, StickyDate, PostDate, IsQuestion, IsLocked, SubscribeToThread, Tags, ContentType, FileName, FileData, FileStream, FileUrl, FileUploadContext, IsFeatured, FeaturedImage, IsAnonymous, ExtendedAttributes	Optional

Return Type

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

AdditionalInfo Delete(int threadId, ForumThreadsDeleteOptions options = null);

Deletes a Forum Thread

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumThreadsDeleteOptions In-Process API Supplementary Type\|ForumThreadsDeleteOptions]]`	Optional parameter names are: DeleteChildren, SendAuthorDeleteNotification, DeleteReason	Optional

Return Type

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

AdditionalInfo DeleteWikiPageAssociation(int threadId);

Deletes an association with a wiki page if one exits

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required

Return Type

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

ForumThread Get(int threadId, ForumThreadsGetOptions options = null);

Gets a Forum Thread

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumThreadsGetOptions In-Process API Supplementary Type\|ForumThreadsGetOptions]]`	Optional parameter names are: ForumId	Optional

Return Type

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

ForumThread Get(Guid contentId);

Gets a Forum Thread

Parameters

Name	Type	Description	Required	Default	Options
contentId	`Guid`	Thread Content Id	Required

Return Type

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

bool IsMuted(int threadId);

Returns the muted status for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required

Return Type

bool

PagedList<ForumThread> List();

Lists Forum Threads

Return Type

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

PagedList<ForumThread> List(ForumThreadsListOptions options);

Lists Forum Threads

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumThreadsListOptions In-Process API Supplementary Type\|ForumThreadsListOptions]]`	Optional parameter names are: ForumId, GroupId, ContentIds, SortBy, SortOrder, PopularOnly, IncludeSubGroups, PageSize, PageIndex, ForumThreadQueryType, IncludeDiscussions, IncludeQuestions. If left unspecified, sorting defaults to LastPost Ascending and ForumThreadQueryType defaults to All.	Required

Return Type

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

ApiList<PollItem> ListPollItems(int replyId);

Obsolete. Deprecated in 8.5, use Poll API instead.

Lists poll options in a thread. Deprecated in 8.5, use Poll API instead.

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required

Return Type

[[ApiList(T) In-Process API Supplementary Type|ApiList]]<[[PollItem In-Process API Supplementary Type|PollItem]]>

void MarkAsRead(int threadId);

Mark the thread as read by the accessing user

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Id of the forum thread	Required

ForumThread Preview(int forumId, ForumThreadsPreviewOptions options = null);

Previews a thread before it is saved

Parameters

Name	Type	Description	Required	Default	Options
forumId	`int`	Forum Id	Required
options	`[[ForumThreadsPreviewOptions In-Process API Supplementary Type\|ForumThreadsPreviewOptions]]`	Optional parameter names are: Subject, Body	Optional

Return Type

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

AdditionalInfo RemovePollItem(int replyId, string answerId);

Obsolete. Deprecated in 8.5, use poll embedding instead.

Removes a poll option from a thread. Deprecated in 8.5, use poll embedding instead.

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Reply Id	Required
answerId	`string`	Answer Id	Required

Return Type

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

ForumThread Report(string subject, string body, ForumThreadsReportOptions options = null);

Obsolete. No longer supported. Use Abuse.AbuseReports.Create() instead.

No longer supported. Use Abuse.AbuseReports.Create() instead.

Parameters

Name	Type	Description	Required
subject	`string`	Subject	Required
body	`string`	Body	Required
options	`[[ForumThreadsReportOptions In-Process API Supplementary Type\|ForumThreadsReportOptions]]`	Optional parameter names are: Tags	Optional

Return Type

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

void SetMuted(int threadId, bool mute);

Sets the muted status for the accessing user

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
mute	`bool`	True to mute the thread, false to unmute	Required

ForumThread Update(int forumId, int threadId, ForumThreadsUpdateOptions options = null);

Updates a Forum Thread

Parameters

Name	Type	Description	Required
forumId	`int`	Forum Id	Required
threadId	`int`	Thread Id	Required
options	`[[ForumThreadsUpdateOptions In-Process API Supplementary Type\|ForumThreadsUpdateOptions]]`	Optional parameter names are: Subject, Body, IsSticky, StickyDate, PostDate, IsQuestion, IsLocked, SubscribeToThread, ContentType, FileName, FileData, FileStream, FileUploadContext, FileUrl, RemoveAttachment, Tags, IsFeatured, FeaturedImage, IsAnonymous, EditNotes, ExtendedAttributes	Optional

Return Type

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

PollItem UpdatePollItem(int replyId, string answerId, string answer, int orderNumber);

Obsolete. Deprecated in 8.5, use poll embedding instead.

Updates a poll option in a thread. Deprecated in 8.5, use poll embedding instead.

Parameters

Name	Type	Description	Required
replyId	`int`	Reply Id	Required
answerId	`string`	Answer Id	Required
answer	`string`	Answer	Required
orderNumber	`int`	OrderNumber	Required

Return Type

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