core_v2_forumReply Script API

Enables scripted content fragments to use ForumReplys

Properties

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

Methods

AreRatingsEnabled

DEPRECATED: Use $core_v2_rating.CanCreate() instead.

Velocity

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

JavaScript

var booleanResponse = core_v2_forumReply.AreRatingsEnabled(forumReplyId);

Parameters

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

Returns

Boolean

Create

Create Overload 1

Create a forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Create(threadId, body);

Parameters

Name	Type	Description	Required	Default	Options
threadId	`Number`	Id of forum thread	Required
body	`String`	Content of reply	Required

Create Overload 2

Create a forum thread reply

Velocity

#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 }"))

JavaScript

var 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	`Number`	Id of forum thread	Required
body	`String`	Content of reply	Required
options	Options	Set of optional parameters including:	Required
ContentType	`String`	Used when adding a post attachment.	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	`Array of Byte`	Obsolete in 12: Use FileUrl or FileUploadContext instead.	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
ForumId	`Number`	Id of the forum	Optional
ForumReplyId	`Number`	Forum Reply Id	Optional
IsAnonymous	`Boolean`	Used when the reply should be made anonymously	Optional	False
IsSuggestedAnswer	`Boolean`	Only applied to replies to threads that are questions.	Optional	False
PostDate	`DateTime`	Defaults to current datetime if not specified.	Optional
SubscribeToThread	`Boolean`	Whether the thread should be subscribed	Optional	False
Tags	`String`	A comma separated list of tags.	Optional

Returns

ForumReply

Delete

Delete Overload 1

Deletes a forum thread reply

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_forumReply.Delete(replyId);

Parameters

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

Delete Overload 2

Deletes a forum thread reply

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_forumReply.Delete(replyId, { DeleteChildren: deleteChildrenArg, DeleteReason: deleteReasonArg, SendAuthorDeleteNotification: sendAuthorDeleteNotificationArg });

Parameters

Name	Type	Description	Required	Default
replyId	`Number`	Forum reply id	Required
options	Options	Set of optional parameters including:	Required
DeleteChildren	`Boolean`	Deletes the reply's children	Optional	False
DeleteReason	`String`	Reason for deleting the reply	Optional
SendAuthorDeleteNotification	`Boolean`	Sends author a delete notification	Optional	False

Returns

AdditionalInfo

Get

Get Overload 1

Get a single forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Get(replyId);

Parameters

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

Get Overload 2

Get a single forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Get(contentId);

Parameters

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

Get Overload 3

Get a single forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Get(replyId, { ForumId: forumIdArg, ThreadId: threadIdArg });

Parameters

Name	Type	Description	Required
replyId	`Number`	Id of forum thread reply	Required
options	Options	Set of optional parameters including:	Required
ForumId	`Number`	Id of parent forum	Optional
ThreadId	`Number`	Id of parent forum thread	Optional

Returns

ForumReply

GetAncestors

Gets the hierarchy ancestors for a threaded reply.

Velocity

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

JavaScript

var apiListResponse = core_v2_forumReply.GetAncestors(replyId, depth);

Parameters

Name	Type	Description	Required	Default	Options
replyId	`Number`	Id of the forum thread reply	Required
depth	`Nullable of Number`	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

Returns

ApiList of ForumReply

GetForumReplyPageIndex

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

Velocity

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

JavaScript

var numberResponse = core_v2_forumReply.GetForumReplyPageIndex(threadId, replyId, { ForumReplyQueryType: forumReplyQueryTypeArg, IncludeThreadStarter: includeThreadStarterArg, PageSize: pageSizeArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

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

Returns

Number

GetRating

Obsolete in 11: Use the Ratings API instead. Obsolete in 11: Use the Ratings API instead.

Velocity

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

JavaScript

var ratingResponse = core_v2_forumReply.GetRating(forumReplyId);

Parameters

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

Returns

Rating

IncrementViewCount

Velocity

$core_v2_forumReply.IncrementViewCount($forumReplyId)

JavaScript

core_v2_forumReply.IncrementViewCount(forumReplyId);

Parameters

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

Returns

Nothing

List

List Overload 1

Obsolete in 14: Use core_v2_forumReply.List(options) instead. Obsolete in 14: Use core_v2_forumReply.List(options) instead.

Velocity

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

JavaScript

var pagedListResponse = core_v2_forumReply.List(threadId);

Parameters

Name	Type	Description	Required	Default	Options
threadId	`Nullable of Number`	Id of forum thread	Required

List Overload 2

Velocity

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

JavaScript

var pagedListResponse = core_v2_forumReply.List();

List Overload 3

List forum thread replies

Velocity

#set($pagedListResponse = $core_v2_forumReply.List("%{ ApplicationIds = $applicationIdsArg, AuthorId = $authorIdArg, ContainerIds = $containerIdsArg, ContentIds = $contentIdsArg, CreatedAfterDate = $createdAfterDateArg, CreatedBeforeDate = $createdBeforeDateArg, ForumId = $forumIdArg, ForumReplyQueryType = $forumReplyQueryTypeArg, GroupId = $groupIdArg, IncludeDiscussionThreads = $includeDiscussionThreadsArg, IncludeQuestionThreads = $includeQuestionThreadsArg, IncludeSubGroups = $includeSubGroupsArg, IncludeThreadStarter = $includeThreadStarterArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentReplyId = $parentReplyIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, ThreadId = $threadIdArg }"))

JavaScript

var pagedListResponse = core_v2_forumReply.List({ ApplicationIds: applicationIdsArg, AuthorId: authorIdArg, ContainerIds: containerIdsArg, ContentIds: contentIdsArg, CreatedAfterDate: createdAfterDateArg, CreatedBeforeDate: createdBeforeDateArg, ForumId: forumIdArg, ForumReplyQueryType: forumReplyQueryTypeArg, GroupId: groupIdArg, IncludeDiscussionThreads: includeDiscussionThreadsArg, IncludeQuestionThreads: includeQuestionThreadsArg, IncludeSubGroups: includeSubGroupsArg, IncludeThreadStarter: includeThreadStarterArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, ParentReplyId: parentReplyIdArg, SortBy: sortByArg, SortOrder: sortOrderArg, ThreadId: threadIdArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
ApplicationIds	`String`	Comma-seperated list of ApplicationIds. Used to filter forum replies by ApplicationIds. Filtering by ApplicationIds will ignore GroupId and ContainerIds.	Optional
AuthorId	`Number`	Id of the reply author.	Optional
ContainerIds	`String`	Comma-seperated list of ContainerIds. Used to filter forum replies by ContainerIds.	Optional
ContentIds	`String`	Comma separated list of ContentIds. Used to limit to a specific set of replies as well as sort order if SortBy is set to ContentIdsOrder. Filtering by ContentIds will ignore ThreadId, ForumId, GroupId, ApplicationIds and ContainerIds.	Optional
CreatedAfterDate	`Nullable of DateTime`	Include only replies created on or after.	Optional
CreatedBeforeDate	`Nullable of DateTime`	Include only replies created before.	Optional
ForumId	`Number`	Id of the parent forum. Filtering by ForumId will ignore GroupId, ApplicationIds and ContainerIds.	Optional
ForumReplyQueryType	`String`	Reply Type	Optional		moderated, non-verified-answers, verified-answers
GroupId	`Number`	Id of the parent group. Filtering by GroupId will ignore ContainerIds.	Optional
IncludeDiscussionThreads	`Boolean`	When false, excludes replies of discussion type threads.	Optional
IncludeQuestionThreads	`Boolean`	When false, excludes replies of question type threads.	Optional
IncludeSubGroups	`Boolean`	Used when getting forum replies for a group to specify whether or not to include subgroups. Only used if GroupId is specified.	Optional	False
IncludeThreadStarter	`Boolean`	When true, includes the original thread post in the set of replies	Optional
PageIndex	`Number`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Number`	Specify the number of results to return per page.	Optional	20
ParentReplyId	`Number`	Parent Reply Id	Optional
SortBy	`Boolean`	Sort By	Optional	PostDate	ContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending
ThreadId	`Number`	Id of the parent thread. Filtering by ThreadId will ignore ForumId, GroupId, ApplicationIds and ContainerIds.	Optional

List Overload 4

Obsolete in 14: Use core_v2_forumReply.List(options) instead. Obsolete in 14: Use core_v2_forumReply.List(options) instead.

Velocity

#set($pagedListResponse = $core_v2_forumReply.List($threadId, "%{ ApplicationIds = $applicationIdsArg, AuthorId = $authorIdArg, ContainerIds = $containerIdsArg, ContentIds = $contentIdsArg, CreatedAfterDate = $createdAfterDateArg, CreatedBeforeDate = $createdBeforeDateArg, ForumId = $forumIdArg, ForumReplyQueryType = $forumReplyQueryTypeArg, GroupId = $groupIdArg, IncludeDiscussionThreads = $includeDiscussionThreadsArg, IncludeQuestionThreads = $includeQuestionThreadsArg, IncludeSubGroups = $includeSubGroupsArg, IncludeThreadStarter = $includeThreadStarterArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentReplyId = $parentReplyIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_forumReply.List(threadId, { ApplicationIds: applicationIdsArg, AuthorId: authorIdArg, ContainerIds: containerIdsArg, ContentIds: contentIdsArg, CreatedAfterDate: createdAfterDateArg, CreatedBeforeDate: createdBeforeDateArg, ForumId: forumIdArg, ForumReplyQueryType: forumReplyQueryTypeArg, GroupId: groupIdArg, IncludeDiscussionThreads: includeDiscussionThreadsArg, IncludeQuestionThreads: includeQuestionThreadsArg, IncludeSubGroups: includeSubGroupsArg, IncludeThreadStarter: includeThreadStarterArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, ParentReplyId: parentReplyIdArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
threadId	`Nullable of Number`	Id of forum thread. Filtering by ThreadId will ignore ForumId, GroupId, ApplicationIds and ContainerIds.	Required
options	Options	Set of optional parameters including:	Required
ApplicationIds	`String`	Comma-seperated list of ApplicationIds. Used to filter forum replies by ApplicationIds. Filtering by ApplicationIds will ignore GroupId and ContainerIds.	Optional
AuthorId	`Number`	Id of the reply author.	Optional
ContainerIds	`String`	Comma-seperated list of ContainerIds. Used to filter forum replies by ContainerIds.	Optional
ContentIds	`String`	Comma separated list of ContentIds. Used to limit to a specific set of replies as well as sort order if SortBy is set to ContentIdsOrder. Filtering by ContentIds will ignore ThreadId, ForumId, GroupId, ApplicationIds and ContainerIds.	Optional
CreatedAfterDate	`Nullable of DateTime`	Include only replies created on or after.	Optional
CreatedBeforeDate	`Nullable of DateTime`	Include only replies created before.	Optional
ForumId	`Number`	Id of the parent forum. Filtering by ForumId will ignore GroupId, ApplicationIds and ContainerIds.	Optional
ForumReplyQueryType	`String`	Reply Type. When Reply Type is set to 'moderated' options are limited to ForumId, GroupId, IncludeSubGroups, PageSize and PageIndex.	Optional		moderated, non-verified-answers, verified-answers
GroupId	`Number`	Id of the parent group. Filtering by GroupId will ignore ContainerIds.	Optional
IncludeDiscussionThreads	`Boolean`	When false, excludes replies of discussion type threads.	Optional
IncludeQuestionThreads	`Boolean`	When false, excludes replies of question type threads.	Optional
IncludeSubGroups	`Boolean`	Used when getting forum replies for a group to specify whether or not to include subgroups.	Optional	False
IncludeThreadStarter	`Boolean`	When true, includes the original thread post in the set of replies	Optional
PageIndex	`Number`	Specify the page number of paged results to return. Zero-based index.	Optional	0
PageSize	`Number`	Specify the number of results to return per page.	Optional	20
ParentReplyId	`Number`	Parent Reply Id	Optional
SortBy	`Boolean`	Sort By	Optional	PostDate	ContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrder	`String`	Sort Order	Optional	Ascending	Ascending, Descending

Returns

PagedList of ForumReply

ListThreaded

Lists threaded replies for a forum thread

Velocity

#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 }"))

JavaScript

var 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	`Number`	Thread Id	Required
options	Options	Set of optional parameters including:	Required
ChildPageSize	`Number`	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	`Number`	Ending root level Reply Id	Optional
FlattenedDepth	`Number`	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	`Number`	Parent Reply Id	Optional
RootPageSize	`Number`	Number of first level replies to return. Max of 100.	Optional	20
StartReplyId	`Number`	Starting root level Reply Id	Optional
ThreadedSortBy	`String`	Sort threaded replies by	Optional		CreatedDate
ThreadedSortOrder	`String`	Threaded Sort Order	Optional	Ascending	Ascending, Descending

Returns

ApiList of 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.

Velocity

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

JavaScript

var 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	`Number`	Thread Id	Required
options	Options	Set of optional parameters including:	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	`Number`	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	`Number`	Number of replies to return. Max of 100.	Optional	20
ReplyId	`Number`	Reply Id	Optional
ThreadedSortBy	`String`	Sort threaded replies by	Optional		CreatedDate
ThreadedSortOrder	`String`	Threaded Sort Order	Optional	Ascending	Ascending, Descending

Returns

ApiList of ThreadedForumReply

Preview

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

Velocity

#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 }"))

JavaScript

var 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	`Number`	Id of the forum thread	Required
options	Options	Set of optional parameters including:	Required
Body	`String`	Content of the reply	Optional
ContentType	`String`	Used when adding a post attachment.	Optional
FileData	`Array of Byte`	Obsolete in 12: Use FileUrl or FileUploadContext instead.	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
ForumId	`Number`	Id of the forum	Optional
IsAnonymous	`Boolean`	Used when the reply should be made anonymously	Optional	False
IsSuggestedAnswer	`Boolean`	Only applied to replies to threads that are questions.	Optional	False
PostDate	`DateTime`	Defaults to current datetime if not specified.	Optional
SubscribeToThread	`Boolean`	Whether the thread should be subscribed to	Optional	False
Tags	`String`	A comma separated list of tags.	Optional

Returns

ForumReply

SetRating

DEPRECATED: Use $core_v2_rating.Create() instead.

Velocity

$core_v2_forumReply.SetRating($forumReplyId, $rating)

JavaScript

core_v2_forumReply.SetRating(forumReplyId, rating);

Parameters

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

Returns

Nothing

ToString

Velocity

#set($stringResponse = $core_v2_forumReply.ToString())

JavaScript

var stringResponse = core_v2_forumReply.ToString();

Returns

String

Update

Update Overload 1

Update a forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Update(replyId, threadId, forumId);

Parameters

Name	Type	Description	Required
replyId	`Number`	Id of forum thread reply	Required
threadId	`Number`	Id of forum thread	Required
forumId	`Number`	Id of forum	Required

Update Overload 2

Update a forum thread reply

Velocity

#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 }"))

JavaScript

var 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	`Number`	Id of forum thread reply	Required
threadId	`Number`	Id of forum thread	Required
forumId	`Number`	Id of forum	Required
options	Options	Set of optional parameters including:	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	`Array of Byte`	Obsolete in 12: Use FileUrl or FileUploadContext instead.	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	`Boolean`	Is Anonymous	Optional
IsAnswer	`Boolean`	Only applied to replies to threads that are questions.	Optional
IsSuggestedAnswer	`Boolean`	Only applied to replies to threads that are questions.	Optional
PostDate	`DateTime`	Reply Date	Optional
RemoveAttachment	`Boolean`	Used to remove an existing post attachment	Optional	False
SubscribeToThread	`Boolean`	Whether the thread should be subscribed	Optional
Tags	`String`	A comma separated list of tags	Optional

Returns

ForumReply

Recommended