Enables scripted content fragments to use ForumReplys
- Properties
- AreRatingsEnabled
- Create
- Delete
- Get
- GetAncestors
- GetForumReplyPageIndex
- GetRating
- IncrementViewCount
- List
- ListThreaded
- ListThreadedForReply
- Preview
- SetRating
- Update
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 | Int32 | 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 | Int32 | 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 | Options |
---|---|---|---|---|---|
threadId | Int32 | 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 | When adding a post attachment either FileData, FileUrl or FileUploadContext is required. 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 | Int32 | Id of the forum | Optional | ||
ForumReplyId | Int32 | 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
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 | Int32 | 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 | Options |
---|---|---|---|---|---|
replyId | Int32 | 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
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 | Int32 | 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 | Default | Options |
---|---|---|---|---|---|
replyId | Int32 | Id of forum thread reply | Required | ||
options | Options | Set of optional parameters including: | Required | ||
ForumId | Int32 | Id of parent forum | Optional | ||
ThreadId | Int32 | Id of parent forum thread | Optional |
Returns
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 | Int32 | Id of the forum thread reply | Required | ||
depth | Nullable of Int32 | 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
GetForumReplyPageIndex
Gets the page index for a known forum thread reply within a set of other replies
Velocity
#set($int32Response = $core_v2_forumReply.GetForumReplyPageIndex($threadId, $replyId, "%{ ForumReplyQueryType = $forumReplyQueryTypeArg, IncludeThreadStarter = $includeThreadStarterArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))
JavaScript
var 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 | Int32 | Id of the forum thread | Required | ||
replyId | Int32 | 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 | Int32 | Specify the number of results to return per page. | Optional | 20 | |
SortBy | Int32 | Sort By | Optional | 0 | 0 (Reply Date), 1 (UserId), 3 (Total Votes) |
SortOrder | Boolean | Sort Order | Optional | False | false (ascending), true (descending) |
Returns
Int32
GetRating
DEPRECATED: Use $core_v2_ratedItem.Get() 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 | Int32 | Forum Reply Id | Required |
Returns
IncrementViewCount
Velocity
$core_v2_forumReply.IncrementViewCount($forumReplyId)
JavaScript
core_v2_forumReply.IncrementViewCount(forumReplyId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
forumReplyId | Int32 | Forum Reply Id | Required |
Returns
NothingList
List Overload 1
List a forum thread's replies
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 Int32 | Id of forum thread | Required |
List Overload 2
List forum thread replies
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("%{ AuthorId = $authorIdArg, ContentIds = $contentIdsArg, 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({ AuthorId: authorIdArg, ContentIds: contentIdsArg, 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 |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
AuthorId | Int32 | Id of the reply author. If threadId is not provided, AuthorId or ForumReplyQueryType = 'moderated' is required. | 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 | Optional | ||
ForumId | Int32 | Id of the parent forum | Optional | ||
ForumReplyQueryType | String | Reply Type | Optional | moderated, non-verified-answers, verified-answers | |
GroupId | Int32 | Id of the parent group | 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 | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
ParentReplyId | Int32 | 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 |
List Overload 4
List a forum thread's replies
Velocity
#set($pagedListResponse = $core_v2_forumReply.List($threadId, "%{ AuthorId = $authorIdArg, ContentIds = $contentIdsArg, 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, { AuthorId: authorIdArg, ContentIds: contentIdsArg, 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 Int32 | Id of forum thread. If not provided, AuthorId or ForumReplyQueryType = 'moderated' | Required | ||
options | Options | Set of optional parameters including: | Required | ||
AuthorId | Int32 | Id of the reply author. If threadId is not provided, AuthorId or ForumReplyQueryType = 'moderated' is required. | Optional | ||
ContentIds | String | Used to limit to a specific set of replies as well as sort order if SortBy is set to ContentIdsOrder | Optional | ||
ForumId | Int32 | Id of the parent forum | 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 | Int32 | Id of the parent group | 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 | Int32 | Specify the page number of paged results to return. Zero-based index. | Optional | 0 | |
PageSize | Int32 | Specify the number of results to return per page. | Optional | 20 | |
ParentReplyId | Int32 | 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
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 | Int32 | Thread Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
ChildPageSize | Int32 | 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 | Int32 | Ending root level Reply Id | Optional | ||
FlattenedDepth | Int32 | 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 | Int32 | Parent Reply Id | Optional | ||
RootPageSize | Int32 | Number of first level replies to return. Max of 100. | Optional | 20 | |
StartReplyId | Int32 | Starting root level Reply Id | Optional | ||
ThreadedSortBy | String | Sort threaded replies by | Optional | CreatedDate | |
ThreadedSortOrder | String | Threaded Sort Order | Optional | Ascending | Ascending, Descending |
Returns
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 | Int32 | 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 | Int32 | 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 | Int32 | Number of replies to return. Max of 100. | Optional | 20 | |
ReplyId | Int32 | Reply Id | Optional | ||
ThreadedSortBy | String | Sort threaded replies by | Optional | CreatedDate | |
ThreadedSortOrder | String | Threaded Sort Order | Optional | Ascending | Ascending, Descending |
Returns
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 | Options |
---|---|---|---|---|---|
threadId | Int32 | 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 | When adding a post attachment either FileData, FileUrl or FileUploadContext is required. 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 | Int32 | 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
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 | Int32 | Forum Reply Id | Required | ||
rating | Int32 | Rating | Required |
Returns
NothingUpdate
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 | Default | Options |
---|---|---|---|---|---|
replyId | Int32 | Id of forum thread reply | Required | ||
threadId | Int32 | Id of forum thread | Required | ||
forumId | Int32 | 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 | Options |
---|---|---|---|---|---|
replyId | Int32 | Id of forum thread reply | Required | ||
threadId | Int32 | Id of forum thread | Required | ||
forumId | Int32 | 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 | When adding a post attachment either FileData, FileUrl or FileUploadContext is required. 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 |