$core_v2_forumReply Widget Extension

Enables scripted content fragments to use ForumReplys

Properties

Name	Type	Description
ContentTypeId	`Guid`	Forum replies content type identifier
Current	`ForumReply`
CurrentParent	`ForumReply`

Methods

AreRatingsEnabled

DEPRECATED: Use $core_v2_rating.CanCreate() instead.

Usage

#set($booleanResponse = $core_v2_forumReply.AreRatingsEnabled($forumReplyId))

Parameters

Name	Type	Description	Required	Default	Options
forumReplyId	`int`	Forum Reply Id	Required

Return Type

bool

Create

Create a forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Create($threadId, $body))

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Id of forum thread	Required
body	`string`	Content of reply	Required

Return Type

ForumReply

Create

Create a forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Create($threadId, $body, "%{ContentType = $contentTypeArg, ExtendedAttributes = $extendedAttributesArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, ForumId = $forumIdArg, ForumReplyId = $forumReplyIdArg, IsAnonymous = $isAnonymousArg, IsSuggestedAnswer = $isSuggestedAnswerArg, PostDate = $postDateArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg}"))

Parameters

Name	Type	Description	Required	Default
threadId	`int`	Id of forum thread	Required
body	`string`	Content of reply	Required
ContentType	`string`	Used when adding a post attachement.	Optional
ExtendedAttributes	`string`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
FileData	`Byte[]`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
FileName	`string`	Used when adding a post attachement.	Optional
FileUploadContext	`string`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
FileUrl	`string`	When adding a post attachment either FileData, FileUrl, or FileUploadContext is required.	Optional
ForumId	`int`	Id of the forum	Optional
ForumReplyId	`int`	Forum Reply Id	Optional
IsAnonymous	`bool`	Used when the reply should be made anonymously	Optional	False
IsSuggestedAnswer	`bool`	Only applied to replies to threads that are questions.	Optional	False
PostDate	`DateTime`	Defaults to current datetime if not specified.	Optional
SubscribeToThread	`bool`	Whether the thread should be subscribed	Optional	False
Tags	`string`	A comma separated list of tags.	Optional

Return Type

ForumReply

Delete

Deletes a forum thread reply

Usage

#set($additionalInfoResponse = $core_v2_forumReply.Delete($replyId, "%{DeleteChildren = $deleteChildrenArg, DeleteReason = $deleteReasonArg, SendAuthorDeleteNotification = $sendAuthorDeleteNotificationArg}"))

Parameters

Name	Type	Description	Required	Default
replyId	`int`	Forum reply id	Required
DeleteChildren	`bool`	Deletes the reply's children	Optional	False
DeleteReason	`string`	Reason for deleting the reply	Optional
SendAuthorDeleteNotification	`bool`	Sends author a delete notification	Optional	False

Return Type

AdditionalInfo

Delete

Deletes a forum thread reply

Usage

#set($additionalInfoResponse = $core_v2_forumReply.Delete($replyId))

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Forum reply id	Required

Return Type

AdditionalInfo

Get

Get a single forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Get($replyId, "%{ForumId = $forumIdArg, ThreadId = $threadIdArg}"))

Parameters

Name	Type	Description	Required
replyId	`int`	Id of forum thread reply	Required
ForumId	`int`	Id of parent forum	Optional
ThreadId	`int`	Id of parent forum thread	Optional

Return Type

ForumReply

Get

Get a single forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Get($replyId))

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Id of forum thread reply	Required

Return Type

ForumReply

Get

Get a single forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Get($contentId))

Parameters

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

Return Type

ForumReply

GetAncestors

Gets the hierarchy ancestors for a threaded reply.

Usage

#set($apiListResponse = $core_v2_forumReply.GetAncestors($replyId, $depth))

Parameters

Name	Type	Description	Required	Default	Options
replyId	`int`	Id of the forum thread reply	Required
depth	`int?`	Levels of ancestors to return from the root reply down. 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, ApiList will have no records.	Required

Return Type

ApiList<ForumReply>

GetForumReplyPageIndex

Gets the page index for a known forum thread reply within a set of other replies

Usage

#set($int32Response = $core_v2_forumReply.GetForumReplyPageIndex($threadId, $replyId, "%{ForumReplyQueryType = $forumReplyQueryTypeArg, IncludeThreadStarter = $includeThreadStarterArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Id of the forum thread	Required
replyId	`int`	Id of the forum thread reply	Required
ForumReplyQueryType	`string`	Reply Type	Optional		moderated, non-verified-answers, verified-answers
IncludeThreadStarter	`bool`	Used when determining whether to count the thread starter with the count of replies	Optional	False
PageSize	`int`	Specify the number of results to return per page.	Optional	20
SortBy	`int`	Sort By	Optional	0	0 (Reply Date), 1 (UserId), 3 (Total Votes)
SortOrder	`bool`	Sort Order	Optional	False	false (ascending), true (descending)

Return Type

int

GetRating

DEPRECATED: Use $core_v2_ratedItem.Get() instead.

Usage

#set($ratingResponse = $core_v2_forumReply.GetRating($forumReplyId))

Parameters

Name	Type	Description	Required	Default	Options
forumReplyId	`int`	Forum Reply Id	Required

Return Type

Rating

IncrementViewCount

Usage

$core_v2_forumReply.IncrementViewCount($forumReplyId)

Parameters

Name	Type	Description	Required	Default	Options
forumReplyId	`int`	Forum Reply Id	Required

List

List a forum thread's replies

Usage

#set($pagedListResponse = $core_v2_forumReply.List($threadId, "%{ContentIds = $contentIdsArg, ForumId = $forumIdArg, ForumReplyQueryType = $forumReplyQueryTypeArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IncludeThreadStarter = $includeThreadStarterArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentReplyId = $parentReplyIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int?`	Id of forum thread	Required
ContentIds	`string`	Used to limit to a specific set of replies as well as sort order if SoryBy is set to ContentIdsOrder	Optional
ForumId	`int`	Id of the parent forum	Optional
ForumReplyQueryType	`string`	Reply Type	Optional		moderated, non-verified-answers, verified-answers
GroupId	`int`	Id of the parent group	Optional
IncludeSubGroups	`bool`	Used when getting forum replies for a group to specify whether or not to include subgroups.	Optional	False
IncludeThreadStarter	`bool`	When true, includes the original thread post in the set of replies	Optional
PageIndex	`int`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`int`	Specify the number of results to return per page.	Optional	20
ParentReplyId	`int`	Parent Reply Id	Optional
SortBy	`bool`	Sort By	Optional	PostDate	ContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrder	`string`	Sort Order	Optional	Ascending	Ascending, Descending

Return Type

PagedList<ForumReply>

List

List forum thread replies

Usage

#set($pagedListResponse = $core_v2_forumReply.List("%{ContentIds = $contentIdsArg, ForumId = $forumIdArg, ForumReplyQueryType = $forumReplyQueryTypeArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IncludeThreadStarter = $includeThreadStarterArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentReplyId = $parentReplyIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))

Parameters

Name	Type	Description	Required	Default	Options
ContentIds	`string`	Comma separated list of ContentIds. Used to limit to a specific set of replies as well as sort order if SoryBy is set to ContentIdsOrder	Optional
ForumId	`int`	Id of the parent forum	Optional
ForumReplyQueryType	`string`	Reply Type	Optional		moderated, non-verified-answers, verified-answers
GroupId	`int`	Id of the parent group	Optional
IncludeSubGroups	`bool`	Used when getting forum replies for a group to specify whether or not to include subgroups.	Optional	False
IncludeThreadStarter	`bool`	When true, includes the original thread post in the set of replies	Optional
PageIndex	`int`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`int`	Specify the number of results to return per page.	Optional	20
ParentReplyId	`int`	Parent Reply Id	Optional
SortBy	`bool`	Sort By	Optional	PostDate	ContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrder	`string`	Sort Order	Optional	Ascending	Ascending, Descending

Return Type

PagedList<ForumReply>

List

List forum thread replies

Usage

#set($pagedListResponse = $core_v2_forumReply.List())

Return Type

PagedList<ForumReply>

List

List a forum thread's replies

Usage

#set($pagedListResponse = $core_v2_forumReply.List($threadId))

Parameters

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

Return Type

PagedList<ForumReply>

ListThreaded

Lists threaded replies for a forum thread

Usage

#set($apiListResponse = $core_v2_forumReply.ListThreaded($threadId, "%{ChildPageSize = $childPageSizeArg, CreatedEndDate = $createdEndDateArg, CreatedStartDate = $createdStartDateArg, EndReplyId = $endReplyIdArg, FlattenedDepth = $flattenedDepthArg, FlattenedSortBy = $flattenedSortByArg, FlattenedSortOrder = $flattenedSortOrderArg, ParentReplyId = $parentReplyIdArg, RootPageSize = $rootPageSizeArg, StartReplyId = $startReplyIdArg, ThreadedSortBy = $threadedSortByArg, ThreadedSortOrder = $threadedSortOrderArg}"))

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
ChildPageSize	`int`	Specifies the number of child records to return per first level reply. Max of 50.	Optional	10
CreatedEndDate	`DateTime`	Created end date. Only filters first level of replies returned.	Optional
CreatedStartDate	`DateTime`	Created start date. Only filters first level of replies returned.	Optional
EndReplyId	`int`	Ending root level Reply Id	Optional
FlattenedDepth	`int`	Specify the depth at which all child replies will be wrapped under the last level of threaded replies. Zero-based index. Max of 9.	Optional	3
FlattenedSortBy	`string`	Sort flattened replies by	Optional		CreatedDate
FlattenedSortOrder	`string`	Flattened Sort Order	Optional	Ascending	Ascending, Descending
ParentReplyId	`int`	Parent Reply Id	Optional
RootPageSize	`int`	Number of first level replies to return. Max of 100.	Optional	20
StartReplyId	`int`	Starting root level Reply Id	Optional
ThreadedSortBy	`string`	Sort threaded replies by	Optional		CreatedDate
ThreadedSortOrder	`string`	Threaded Sort Order	Optional	Ascending	Ascending, Descending

Return Type

ApiList<ThreadedForumReply>

ListThreadedForReply

Lists threaded replies for a forum thread based on a specific reply. Will return all direct anscetors including the reply up until the PageSize is reached. May not return the top level replies if the specified reply is too deap.

Usage

#set($apiListResponse = $core_v2_forumReply.ListThreadedForReply($threadId, "%{Direction = $directionArg, FlattenedDepth = $flattenedDepthArg, FlattenedSortBy = $flattenedSortByArg, FlattenedSortOrder = $flattenedSortOrderArg, PageSize = $pageSizeArg, ReplyId = $replyIdArg, ThreadedSortBy = $threadedSortByArg, ThreadedSortOrder = $threadedSortOrderArg}"))

Parameters

Name	Type	Description	Required	Default	Options
threadId	`int`	Thread Id	Required
Direction	`string`	Specifies the direction paging occurs, either up from the ReplyId passed in to the root reply, or down from the root reply for the ReplyId passed in.	Optional		FromReply, FromRootReply
FlattenedDepth	`int`	Specify the depth at which all child replies will be wrapped under the last level of threaded replies. Zero-based index. Max of 9.	Optional	3
FlattenedSortBy	`string`	Sort flattened replies by	Optional		CreatedDate
FlattenedSortOrder	`string`	Flattened Sort Order	Optional	Ascending	Ascending, Descending
PageSize	`int`	Number of replies to return. Max of 100.	Optional	20
ReplyId	`int`	Reply Id	Optional
ThreadedSortBy	`string`	Sort threaded replies by	Optional		CreatedDate
ThreadedSortOrder	`string`	Threaded Sort Order	Optional	Ascending	Ascending, Descending

Return Type

ApiList<ThreadedForumReply>

Preview

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

Usage

#set($forumReplyResponse = $core_v2_forumReply.Preview($threadId, "%{Body = $bodyArg, ContentType = $contentTypeArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, ForumId = $forumIdArg, IsAnonymous = $isAnonymousArg, IsSuggestedAnswer = $isSuggestedAnswerArg, PostDate = $postDateArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg}"))

Parameters

Name	Type	Description	Required	Default
threadId	`int`	Id of the forum thread	Required
Body	`string`	Content of the reply	Optional
ContentType	`string`	Used when adding a post attachement.	Optional
FileData	`Byte[]`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
FileName	`string`	Used when adding a post attachement.	Optional
FileUploadContext	`string`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
FileUrl	`string`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
ForumId	`int`	Id of the forum	Optional
IsAnonymous	`bool`	Used when the reply should be made anonymously	Optional	False
IsSuggestedAnswer	`bool`	Only applied to replies to threads that are questions.	Optional	False
PostDate	`DateTime`	Defaults to current datetime if not specified.	Optional
SubscribeToThread	`bool`	Whether the thread should be subscribed to	Optional	False
Tags	`string`	A comma separated list of tags.	Optional

Return Type

ForumReply

SetRating

DEPRECATED: Use $core_v2_rating.Create() instead.

Usage

$core_v2_forumReply.SetRating($forumReplyId, $rating)

Parameters

Name	Type	Description	Required	Default	Options
forumReplyId	`int`	Forum Reply Id	Required
rating	`int`	Rating	Required

Update

Update a forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Update($replyId, $threadId, $forumId))

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

Return Type

ForumReply

Update

Update a forum thread reply

Usage

#set($forumReplyResponse = $core_v2_forumReply.Update($replyId, $threadId, $forumId, "%{Body = $bodyArg, ContentType = $contentTypeArg, EditNotes = $editNotesArg, ExtendedAttributes = $extendedAttributesArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsAnonymous = $isAnonymousArg, IsAnswer = $isAnswerArg, IsSuggestedAnswer = $isSuggestedAnswerArg, PostDate = $postDateArg, RemoveAttachment = $removeAttachmentArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg}"))

Parameters

Name	Type	Description	Required	Default
replyId	`int`	Id of forum thread reply	Required
threadId	`int`	Id of forum thread	Required
forumId	`int`	Id of forum	Required
Body	`string`	Content of the reply	Optional
ContentType	`string`	Used when adding a post attachment	Optional
EditNotes	`string`	Edit Notes	Optional
ExtendedAttributes	`string`	Extended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".	Optional
FileData	`Byte[]`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required	Optional
FileName	`string`	Used when adding a post attachment	Optional
FileUploadContext	`string`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required	Optional
FileUrl	`string`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required	Optional
IsAnonymous	`bool`	Is Anonymous	Optional
IsAnswer	`bool`	Only applied to replies to threads that are questions.	Optional
IsSuggestedAnswer	`bool`	Only applied to replies to threads that are questions.	Optional
PostDate	`DateTime`	Reply Date	Optional
RemoveAttachment	`bool`	Used to remove an existing post attachment	Optional	False
SubscribeToThread	`bool`	Whether the thread should be subscribed	Optional
Tags	`string`	A comma separated list of tags	Optional

Return Type

ForumReply

Recommended