ForumReplies In-Process API Service

Ben Tiedt — Tue, 19 Nov 2019 20:04:03 GMT

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

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

Events

Events.AfterCreate

Handler

void ForumReplyAfterCreateEventHandler([[ForumReplyAfterCreateEventArgs In-Process API Event Argument|ForumReplyAfterCreateEventArgs]] e);

Events.AfterDelete

Handler

void ForumReplyAfterDeleteEventHandler([[ForumReplyAfterDeleteEventArgs In-Process API Event Argument|ForumReplyAfterDeleteEventArgs]] e);

Events.AfterUpdate

Handler

void ForumReplyAfterUpdateEventHandler([[ForumReplyAfterUpdateEventArgs In-Process API Event Argument|ForumReplyAfterUpdateEventArgs]] e);

Events.BeforeCreate

Handler

void ForumReplyBeforeCreateEventHandler([[ForumReplyBeforeCreateEventArgs In-Process API Event Argument|ForumReplyBeforeCreateEventArgs]] e);

Events.BeforeDelete

Handler

void ForumReplyBeforeDeleteEventHandler([[ForumReplyBeforeDeleteEventArgs In-Process API Event Argument|ForumReplyBeforeDeleteEventArgs]] e);

Events.BeforeUpdate

Handler

void ForumReplyBeforeUpdateEventHandler([[ForumReplyBeforeUpdateEventArgs In-Process API Event Argument|ForumReplyBeforeUpdateEventArgs]] e);

Events.Render

Handler

void ForumReplyRenderEventHandler([[ForumReplyRenderEventArgs In-Process API Event Argument|ForumReplyRenderEventArgs]] e);

Properties

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

Methods

ForumReply Create(int threadId, string body, ForumRepliesCreateOptions options = null);

Create a forum thread reply

Parameters

Name	Type	Description	Required
threadId	`int`	Id of forum thread	Required
body	`string`	Content of reply	Required
options	`[[ForumRepliesCreateOptions In-Process API Supplementary Type\|ForumRepliesCreateOptions]]`	Optional parameter names are: ForumId, ForumReplyId, PostDate, IsSuggestedAnswer, SubscribeToThread, Tags, ContentType, FileName, FileData, FileStream, FileUploadContext, FileUrl, IsAnonymous, ExtendedAttributes	Optional

Return Type

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

AdditionalInfo Delete(int replyId, ForumRepliesDeleteOptions options = null);

Deletes a forum thread reply

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Forum reply id	Required
options	`[[ForumRepliesDeleteOptions In-Process API Supplementary Type\|ForumRepliesDeleteOptions]]`	Optional parameters are: DeleteChildren, SendAuthorDeleteNotification, DeleteReason	Optional

Return Type

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

ForumReply Get(int replyId, ForumRepliesGetOptions options = null);

Get a single forum thread reply

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Id of forum thread reply	Required
options	`[[ForumRepliesGetOptions In-Process API Supplementary Type\|ForumRepliesGetOptions]]`	Optional parameter names are: ThreadId, ForumId	Optional

Return Type

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

ForumReply Get(Guid contentId);

Get a single forum thread reply

Parameters

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

Return Type

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

ApiList<ForumReply> GetAncestors(int replyId, int? depth);

Gets the parent hierarchy for the given ForumReply

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Id of the forum thread reply	Required
depth	`int?`	Levels of ancestors to return. Zero based with a max of 9. If 0 is specified, only the root reply id is returned. If the reply is the root reply, IApiList will have no records.	Required

Return Type

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

int GetPageIndex(int threadId, int replyId, ForumRepliesGetPageIndexOptions options = null);

Gets the page index for the given ForumReply

Parameters

Name	Type	Description	Required
threadId	`int`	Id of the forum thread	Required
replyId	`int`	Id of the forum thread reply	Required
options	`[[ForumRepliesGetPageIndexOptions In-Process API Supplementary Type\|ForumRepliesGetPageIndexOptions]]`	Optional parameters are: ForumReplyQueryType, IncludeThreadStarter, PageSize, SortBy, SortOrder	Optional

Return Type

int

PagedList<ForumReply> List(ForumRepliesListOptions options = null);

List a forum thread's replies

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumRepliesListOptions In-Process API Supplementary Type\|ForumRepliesListOptions]]`	Optional parameter names are: ForumId, GroupId, ParentReplyId, ContentIds, ForumReplyQueryType, IncludeSubGroups, IncludeThreadStarter, PageSize, PageIndex, SortOrder, SortBy	Optional

Return Type

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

PagedList<ForumReply> List(int? threadId, ForumRepliesListOptions options = null);

List forum thread replies. Method is included for backwards compatibility, though it may not work properly because ThreadId is required.

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int?`	Thread Id	Required
options	`[[ForumRepliesListOptions In-Process API Supplementary Type\|ForumRepliesListOptions]]`	Optional parameter names are: ForumId, GroupId, ParentReplyId, ForumReplyQueryType, IncludeSubGroups, IncludeThreadStarter, PageSize, PageIndex, SortOrder, SortBy	Optional

Return Type

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

PagedList<ForumReply> List(int threadId, ForumRepliesListOptions options = null);

List forum thread replies

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumRepliesListOptions In-Process API Supplementary Type\|ForumRepliesListOptions]]`	Optional parameter names are: ForumId, GroupId, ParentReplyId, ForumReplyQueryType, IncludeSubGroups, IncludeThreadStarter, PageSize, PageIndex, SortOrder, SortBy	Optional

Return Type

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

ApiList<ThreadedForumReply> ListThreaded(int threadId, ForumRepliesListThreadedOptions options = null);

List forum thread threaded replies

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumRepliesListThreadedOptions In-Process API Supplementary Type\|ForumRepliesListThreadedOptions]]`	Optional parameter names are: ParentReplyId, StartReplyId, EndReplyId, CreatedStartDate, CreatedEndDate, ThreadedSortBy, ThreadedSortOrder, FlattenedSortBy, FlattenedSortOrder, RootPageSize, FlattenedDepth, ChilPageSize	Optional

Return Type

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

ApiList<ThreadedForumReply> ListThreadedForReply(int threadId, ForumRepliesListThreadedForReplyOptions options = null);

List forum thread threaded replies for a specified reply

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
options	`[[ForumRepliesListThreadedForReplyOptions In-Process API Supplementary Type\|ForumRepliesListThreadedForReplyOptions]]`	Optional parameter names are: ReplyId, ThreadedSortBy, ThreadedSortOrder, FlattenedSortBy, FlattenedSortOrder, FlattenedDepth, PageSize, Direction	Optional

Return Type

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

PagedList<ForumReply> ModeratedRepliesList(ForumRepliesListOptions options = null);

List ForumReplies

Parameters

Name	Type	Description	Required	Default	Options
options	`[[ForumRepliesListOptions In-Process API Supplementary Type\|ForumRepliesListOptions]]`	Optional parameters are: ForumId, GroupId, IncludeSubGroups, PageSize, PageIndex	Optional

Return Type

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

ForumReply Preview(int threadId, ForumRepliesPreviewOptions options = null);

Creates a Forum Reply object without persisting it, usable for previewing

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Id of the forum thread	Required
options	`[[ForumRepliesPreviewOptions In-Process API Supplementary Type\|ForumRepliesPreviewOptions]]`	Optional parameter names are: Body	Optional

Return Type

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

ForumReply Update(int replyId, int threadId, int forumId, ForumRepliesUpdateOptions options = null);

Update a forum thread reply

Parameters

Name	Type	Description	Required
replyId	`int`	Id of forum thread reply	Required
threadId	`int`	Id of forum thread	Required
forumId	`int`	Id of forum	Required
options	`[[ForumRepliesUpdateOptions In-Process API Supplementary Type\|ForumRepliesUpdateOptions]]`	Optional parameter names are: Body, PostDate, IsSuggestedAnswer, IsAnswer, SubscribeToThread, Tags, ContentType, FileName, FileData, FileStream, FileUploadContext, FileUrl, RemoveAttachment, EditNotes, IsAnonymous, ExtendedAttributes	Optional

Return Type

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