core_v2_forumThread Script API

Enables scripted content fragments to use ForumThreads

Properties
AddPollItem
AllowsReplies
AreRatingsEnabled
Create
Delete
DeleteWikiPageAssociation
Get
GetRating
IncrementViewCount
IsFavorite
IsMuted
IsSubscribed
List
ListPollItems
MarkAsRead
Preview
RemovePollItem
Report
SetFavorite
SetMuted
SetRating
SetSubscribed
SubscriptionType
Update
UpdatePollItem

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Forum Threads content type identifier
Current	Read	`ForumThread`	Returns the current contextual Forum Thread
CurrentParent	Read	`ForumThread`	Identifies the thread being replied to when replying to a thread

Methods

AddPollItem

Adds a poll option to a thread. Deprecated: Use poll embedding instead.

Velocity

#set($pollItemResponse = $core_v2_forumThread.AddPollItem($threadId, $answer, $orderNumber))

JavaScript

var pollItemResponse = core_v2_forumThread.AddPollItem(threadId, answer, orderNumber);

Parameters

Name	Type	Description	Required
threadId	`Int32`	Thread Id	Required
answer	`String`	Answer	Required
orderNumber	`Int32`	Order Number	Required

Returns

PollItem

AllowsReplies

Determines if the Forum Thread allows replies

Velocity

#set($booleanResponse = $core_v2_forumThread.AllowsReplies($contentId))

JavaScript

var booleanResponse = core_v2_forumThread.AllowsReplies(contentId);

Parameters

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

Returns

Boolean

AreRatingsEnabled

Returns whether ratings are enabled on a thread. DEPRECATED: Use $core_v2_rating.CanCreate() instead.

Velocity

#set($booleanResponse = $core_v2_forumThread.AreRatingsEnabled($forumThreadId))

JavaScript

var booleanResponse = core_v2_forumThread.AreRatingsEnabled(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Boolean

Create

Create Overload 1

Creates a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Create($forumId, $subject, $body))

JavaScript

var forumThreadResponse = core_v2_forumThread.Create(forumId, subject, body);

Parameters

Name	Type	Description	Required
forumId	`Int32`	Forum Id	Required
subject	`String`	Subject	Required
body	`String`	Body	Required

Create Overload 2

Creates a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Create($forumId, $subject, $body, "%{ ContentType = $contentTypeArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, HasPoll = $hasPollArg, IsAnonymous = $isAnonymousArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsQuestion = $isQuestionArg, IsSticky = $isStickyArg, PollDescription = $pollDescriptionArg, PollExpirationDate = $pollExpirationDateArg, PollTitle = $pollTitleArg, PostDate = $postDateArg, StickyDate = $stickyDateArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg }"))

JavaScript

var forumThreadResponse = core_v2_forumThread.Create(forumId, subject, body, { ContentType: contentTypeArg, ExtendedAttributes: extendedAttributesArg, FeaturedImage: featuredImageArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, HasPoll: hasPollArg, IsAnonymous: isAnonymousArg, IsFeatured: isFeaturedArg, IsLocked: isLockedArg, IsQuestion: isQuestionArg, IsSticky: isStickyArg, PollDescription: pollDescriptionArg, PollExpirationDate: pollExpirationDateArg, PollTitle: pollTitleArg, PostDate: postDateArg, StickyDate: stickyDateArg, SubscribeToThread: subscribeToThreadArg, Tags: tagsArg });

Parameters

Name	Type	Description	Required	Default
forumId	`Int32`	Forum Id	Required
subject	`String`	Subject	Required
body	`String`	Body	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
FeaturedImage	`String`	URL of image to use when IsFeatured is true	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
HasPoll	`Boolean`	Deprecated: Use poll embedding instead.	Optional	False
IsAnonymous	`Boolean`	Is Anonymous	Optional	False
IsFeatured	`Boolean`	Is Featured	Optional	False
IsLocked	`Boolean`	Is Locked	Optional	False
IsQuestion	`Boolean`	Only used when the forum being posted to has both discussions and questions	Optional	False
IsSticky	`Boolean`	Is Sticky	Optional	False
PollDescription	`String`	Deprecated: Use poll embedding instead.	Optional
PollExpirationDate	`DateTime`	Deprecated: Use poll embedding instead.	Optional
PollTitle	`String`	Deprecated: Use poll embedding instead.	Optional
PostDate	`DateTime`	Post Date	Optional	Current Date
StickyDate	`DateTime`	If a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 days	Optional
SubscribeToThread	`Boolean`	Subscribe To Thread	Optional	False
Tags	`String`	A comma separated list of tags	Optional

Returns

ForumThread

Delete

Deletes a Forum Thread

Velocity

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

JavaScript

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

Parameters

Name	Type	Description	Required	Default
threadId	`Int32`	Thread Id	Required
options	Options	Set of optional parameters including:	Required
DeleteChildren	`Boolean`	Delete Children	Optional	False
DeleteReason	`String`	Delete Reason	Optional	False
SendAuthorDeleteNotification	`Boolean`	Send Author Delete Notification	Optional	False

Returns

AdditionalInfo

DeleteWikiPageAssociation

Deletes an association with a wiki page if one exits

Velocity

#set($additionalInfoResponse = $core_v2_forumThread.DeleteWikiPageAssociation($threadId))

JavaScript

var additionalInfoResponse = core_v2_forumThread.DeleteWikiPageAssociation(threadId);

Parameters

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

Returns

AdditionalInfo

Get

Get Overload 1

Gets a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Get($threadId))

JavaScript

var forumThreadResponse = core_v2_forumThread.Get(threadId);

Parameters

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

Get Overload 2

Gets a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Get($contentId))

JavaScript

var forumThreadResponse = core_v2_forumThread.Get(contentId);

Parameters

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

Get Overload 3

Gets a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Get($threadId, "%{ ForumId = $forumIdArg }"))

JavaScript

var forumThreadResponse = core_v2_forumThread.Get(threadId, { ForumId: forumIdArg });

Parameters

Name	Type	Description	Required
threadId	`Int32`	Thread Id	Required
options	Options	Set of optional parameters including:	Required
ForumId	`Int32`	Forum Id	Optional

Returns

ForumThread

GetRating

Gets the rating. DEPRECATED: Use $core_v2_ratedItem.Get() instead.

Velocity

#set($ratingResponse = $core_v2_forumThread.GetRating($forumThreadId))

JavaScript

var ratingResponse = core_v2_forumThread.GetRating(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Rating

IncrementViewCount

Increments the view count for a thread

Velocity

$core_v2_forumThread.IncrementViewCount($forumThreadId)

JavaScript

core_v2_forumThread.IncrementViewCount(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Nothing

IsFavorite

Returns favorite status for the accessing user. DEPRECATED: Use $core_v2_bookmark.Get() instead.

Velocity

#set($booleanResponse = $core_v2_forumThread.IsFavorite($forumThreadId))

JavaScript

var booleanResponse = core_v2_forumThread.IsFavorite(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Boolean

IsMuted

Returns the muted status for the accessing user

Velocity

#set($booleanResponse = $core_v2_forumThread.IsMuted($forumThreadId))

JavaScript

var booleanResponse = core_v2_forumThread.IsMuted(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Boolean

IsSubscribed

Returns subscribed status for the accessing user

Velocity

#set($booleanResponse = $core_v2_forumThread.IsSubscribed($forumThreadId))

JavaScript

var booleanResponse = core_v2_forumThread.IsSubscribed(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

Boolean

List

List Overload 1

Lists Forum Threads

Velocity

#set($pagedListResponse = $core_v2_forumThread.List($forumThreadQueryType))

JavaScript

var pagedListResponse = core_v2_forumThread.List(forumThreadQueryType);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadQueryType	`String`	Forum Thread Query Type	Required	All	Active, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, Unanswered, Unread

List Overload 2

Lists Forum Threads

Velocity

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

JavaScript

var pagedListResponse = core_v2_forumThread.List();

List Overload 3

Lists Forum Threads

Velocity

#set($pagedListResponse = $core_v2_forumThread.List($forumThreadQueryType, "%{ ContentIds = $contentIdsArg, ForumId = $forumIdArg, GroupId = $groupIdArg, IncludeDiscussions = $includeDiscussionsArg, IncludeQuestions = $includeQuestionsArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PopularOnly = $popularOnlyArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_forumThread.List(forumThreadQueryType, { ContentIds: contentIdsArg, ForumId: forumIdArg, GroupId: groupIdArg, IncludeDiscussions: includeDiscussionsArg, IncludeQuestions: includeQuestionsArg, IncludeSubGroups: includeSubGroupsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PopularOnly: popularOnlyArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
forumThreadQueryType	`String`	Forum Thread Query Type	Required	All	Active, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, NoResponse, Unanswered, Unread
options	Options	Set of optional parameters including:	Required
ContentIds	`String`	Comma separated list of ContentIds. Used to limit to a specific set of forum threads as well as sort order if SortBy is set to ContentIdsOrder	Optional
ForumId	`Int32`	Forum Id	Optional
GroupId	`Int32`	Group Id	Optional
IncludeDiscussions	`Boolean`	Include discussion threads	Optional	True
IncludeQuestions	`Boolean`	Include question and answer threads	Optional	True
IncludeSubGroups	`Boolean`	Whether to include sub groups	Optional	False
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
PopularOnly	`Boolean`	Whether to include popular threads only	Optional	False
SortBy	`String`	'LastPost' is sorting by the latest Thread/Reply modification date; 'Date' is sorting by thread created date; 'Votes' sorts by total votes, both quality and interest.	Optional		ContentIdsOrder, Date, LastPost, QualityScore, Replies, Score:SCORE_ID, Topic, TotalQualityVotes, Views, Votes
SortOrder	`String`	Default is Descending for lastpost, date, replies, and views. Default is Ascending for topic	Optional		Ascending, Descending

List Overload 4

Velocity

#set($pagedListResponse = $core_v2_forumThread.List("%{ AreStickyPostsOnTop = $areStickyPostsOnTopArg, AuthorId = $authorIdArg, ContentIds = $contentIdsArg, CreatedAfterDate = $createdAfterDateArg, CreatedBeforeDate = $createdBeforeDateArg, ForumId = $forumIdArg, ForumThreadQueryType = $forumThreadQueryTypeArg, GroupId = $groupIdArg, IncludeDiscussions = $includeDiscussionsArg, IncludeQuestions = $includeQuestionsArg, IncludeSubGroups = $includeSubGroupsArg, MaximumReplyCount = $maximumReplyCountArg, MinimumReplyCount = $minimumReplyCountArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PopularOnly = $popularOnlyArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))

JavaScript

var pagedListResponse = core_v2_forumThread.List({ AreStickyPostsOnTop: areStickyPostsOnTopArg, AuthorId: authorIdArg, ContentIds: contentIdsArg, CreatedAfterDate: createdAfterDateArg, CreatedBeforeDate: createdBeforeDateArg, ForumId: forumIdArg, ForumThreadQueryType: forumThreadQueryTypeArg, GroupId: groupIdArg, IncludeDiscussions: includeDiscussionsArg, IncludeQuestions: includeQuestionsArg, IncludeSubGroups: includeSubGroupsArg, MaximumReplyCount: maximumReplyCountArg, MinimumReplyCount: minimumReplyCountArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PopularOnly: popularOnlyArg, SortBy: sortByArg, SortOrder: sortOrderArg });

Parameters

Name	Type	Description	Required	Default	Options
options	Options	Set of optional parameters including:	Required
AreStickyPostsOnTop	`Boolean`	Determines whether to place sticky posts at the top of the list. This setting only applies to the lastpost' sort.	Optional	True
AuthorId	`Int32`	Author Id	Optional
ContentIds	`String`	Used to limit to a specific set of forum threads as well as sort order if SortBy is set to ContentIdsOrder	Optional
CreatedAfterDate	`Nullable of DateTime`	Include only threads created on or after.	Optional
CreatedBeforeDate	`Nullable of DateTime`	Include only threads created before.	Optional
ForumId	`Int32`	Forum Id	Optional
ForumThreadQueryType	`String`	Forum Thread Query Type	Optional	All	Active (Obsolete), All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, NoResponse, Unanswered, Unread
GroupId	`Int32`	Group Id	Optional
IncludeDiscussions	`Boolean`	Include discussion threads	Optional	True
IncludeQuestions	`Boolean`	Include question and answer threads	Optional	True
IncludeSubGroups	`Boolean`	Whether to include sub groups	Optional	False
MaximumReplyCount	`Int32`	Maximum number of replies a thread can have to be returned.	Optional
MinimumReplyCount	`Int32`	Minimum number of replies a thread must have to be returned.	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
PopularOnly	`Boolean`	Whether to include popular threads only	Optional	False
SortBy	`String`	'LastPost' is sorting by the latest Thread/Reply modification date; 'Date' is sorting by thread created date; 'Votes' sorts by total votes, both quality and interest.	Optional		ContentIdsOrder, Date, LastPost, QualityScore, Replies, Score:SCORE_ID, Topic, TotalQualityVotes, Views, Votes
SortOrder	`String`	Default is Descending for lastpost, date, replies, and views. Default is Ascending for topic	Optional		Ascending, Descending

Returns

PagedList of ForumThread

ListPollItems

Lists poll options in a thread. Deprecated: Use $core_v2_poll instead.

Velocity

#set($apiListResponse = $core_v2_forumThread.ListPollItems($threadId))

JavaScript

var apiListResponse = core_v2_forumThread.ListPollItems(threadId);

Parameters

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

Returns

ApiList of PollItem

MarkAsRead

Mark the thread as read by the accessing user

Velocity

$core_v2_forumThread.MarkAsRead($threadId)

JavaScript

core_v2_forumThread.MarkAsRead(threadId);

Parameters

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

Returns

Nothing

Preview

Previews a thread before it is saved

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Preview($forumId, "%{ Body = $bodyArg, ContentType = $contentTypeArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsAnonymous = $isAnonymousArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsQuestion = $isQuestionArg, IsSticky = $isStickyArg, PostDate = $postDateArg, StickyDate = $stickyDateArg, Subject = $subjectArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg }"))

JavaScript

var forumThreadResponse = core_v2_forumThread.Preview(forumId, { Body: bodyArg, ContentType: contentTypeArg, FeaturedImage: featuredImageArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, IsAnonymous: isAnonymousArg, IsFeatured: isFeaturedArg, IsLocked: isLockedArg, IsQuestion: isQuestionArg, IsSticky: isStickyArg, PostDate: postDateArg, StickyDate: stickyDateArg, Subject: subjectArg, SubscribeToThread: subscribeToThreadArg, Tags: tagsArg });

Parameters

Name	Type	Description	Required	Default
forumId	`Int32`	Forum Id	Required
options	Options	Set of optional parameters including:	Required
Body	`String`	Body	Optional
ContentType	`String`	Used when adding a post attachment	Optional
FeaturedImage	`String`	Featured Image	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	False
IsFeatured	`Boolean`	Is Featured	Optional	False
IsLocked	`Boolean`	Is Locked	Optional	False
IsQuestion	`Boolean`	Only used when the forum being posted to has both discussions and questions	Optional	False
IsSticky	`Boolean`	Is Sticky	Optional	False
PostDate	`DateTime`	Post Date	Optional	Current Date
StickyDate	`DateTime`	If a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 days	Optional
Subject	`String`	Subject	Optional
SubscribeToThread	`Boolean`	Subscribe To Thread	Optional	False
Tags	`String`	A comma separated list of tags	Optional

Returns

ForumThread

RemovePollItem

Removes a poll option from a thread. Deprecated: Use poll embedding instead.

Velocity

#set($additionalInfoResponse = $core_v2_forumThread.RemovePollItem($threadId, $answerId))

JavaScript

var additionalInfoResponse = core_v2_forumThread.RemovePollItem(threadId, answerId);

Parameters

Name	Type	Description	Required	Default	Options
threadId	`Int32`	Thread Id	Required
answerId	`String`	Answer Id	Required

Returns

AdditionalInfo

Report

Obsolete: No longer supported. Use $core_v2_abuseReport.Create() instead.

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Report($subject, $body, "%{ Tags = $tagsArg }"))

JavaScript

var forumThreadResponse = core_v2_forumThread.Report(subject, body, { Tags: tagsArg });

Parameters

Name	Type	Description	Required
subject	`String`	Subject	Required
body	`String`	Body	Required
options	Options	Set of optional parameters including:	Required
Tags	`String`	Comma-separated list of tags	Optional

Returns

ForumThread

SetFavorite

Sets favorite status for the accessing user. DEPRECATED: Use $core_v2_bookmark.Create() or $core_v2_bookmark.Delete() instead.

Velocity

$core_v2_forumThread.SetFavorite($forumThreadId, $favorite)

JavaScript

core_v2_forumThread.SetFavorite(forumThreadId, favorite);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required
favorite	`Boolean`	Favorite Status	Required

Returns

Nothing

SetMuted

Sets the muted status for the accessing user

Velocity

$core_v2_forumThread.SetMuted($forumThreadId, $mute)

JavaScript

core_v2_forumThread.SetMuted(forumThreadId, mute);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required
mute	`Boolean`	Muted Status	Required

Returns

Nothing

SetRating

Sets the rating for the accessing user. DEPRECATED: Use $core_v2_rating.Create() instead.

Velocity

$core_v2_forumThread.SetRating($forumThreadId, $rating)

JavaScript

core_v2_forumThread.SetRating(forumThreadId, rating);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required
rating	`Int32`	Rating value (0-5)	Required

Returns

Nothing

SetSubscribed

Sets subscribed status for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_forumThread.SetSubscribed($forumThreadId, $subscribe))

JavaScript

var additionalInfoResponse = core_v2_forumThread.SetSubscribed(forumThreadId, subscribe);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required
subscribe	`Boolean`	Subscribed Status	Required

Returns

AdditionalInfo

SubscriptionType

Returns the subscription type for the accessing user (None, Thread, Post, MailingList)

Velocity

#set($stringResponse = $core_v2_forumThread.SubscriptionType($forumThreadId))

JavaScript

var stringResponse = core_v2_forumThread.SubscriptionType(forumThreadId);

Parameters

Name	Type	Description	Required	Default	Options
forumThreadId	`Int32`	Forum Thread Id	Required

Returns

String

Update

Update Overload 1

Updates a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Update($forumId, $threadId))

JavaScript

var forumThreadResponse = core_v2_forumThread.Update(forumId, threadId);

Parameters

Name	Type	Description	Required	Default	Options
forumId	`Int32`	Forum Id	Required
threadId	`Int32`	Thread Id	Required

Update Overload 2

Updates a Forum Thread

Velocity

#set($forumThreadResponse = $core_v2_forumThread.Update($forumId, $threadId, "%{ Body = $bodyArg, ContentType = $contentTypeArg, EditNotes = $editNotesArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, HasPoll = $hasPollArg, IsAnonymous = $isAnonymousArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsQuestion = $isQuestionArg, IsSticky = $isStickyArg, PollDescription = $pollDescriptionArg, PollExpirationDate = $pollExpirationDateArg, PollTitle = $pollTitleArg, PostDate = $postDateArg, StickyDate = $stickyDateArg, Subject = $subjectArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg }"))

JavaScript

var forumThreadResponse = core_v2_forumThread.Update(forumId, threadId, { Body: bodyArg, ContentType: contentTypeArg, EditNotes: editNotesArg, ExtendedAttributes: extendedAttributesArg, FeaturedImage: featuredImageArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, HasPoll: hasPollArg, IsAnonymous: isAnonymousArg, IsFeatured: isFeaturedArg, IsLocked: isLockedArg, IsQuestion: isQuestionArg, IsSticky: isStickyArg, PollDescription: pollDescriptionArg, PollExpirationDate: pollExpirationDateArg, PollTitle: pollTitleArg, PostDate: postDateArg, StickyDate: stickyDateArg, Subject: subjectArg, SubscribeToThread: subscribeToThreadArg, Tags: tagsArg });

Parameters

Name	Type	Description	Required	Default
forumId	`Int32`	Forum Id	Required
threadId	`Int32`	Thread Id	Required
options	Options	Set of optional parameters including:	Required
Body	`String`	Body	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
FeaturedImage	`String`	URL of image to use when IsFeatured is true	Optional
FileData	`Array of 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. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.	Optional
FileUrl	`String`	When adding a post attachment either FileData, FileUrl or FileUploadContext is required.	Optional
HasPoll	`Boolean`	Deprecated: Use poll embedding instead.	Optional	False
IsAnonymous	`Boolean`	Is Anonymous	Optional	False
IsFeatured	`Boolean`	Is Featured	Optional	False
IsLocked	`Boolean`	Is Locked	Optional	False
IsQuestion	`Boolean`	Only used when the forum being posted to has both discussions and questions	Optional	False
IsSticky	`Boolean`	Is Sticky	Optional	False
PollDescription	`String`	Deprecated: Use poll embedding instead.	Optional
PollExpirationDate	`DateTime`	Deprecated: Use poll embedding instead.	Optional
PollTitle	`String`	Deprecated: Use poll embedding instead.	Optional
PostDate	`DateTime`	Post Date	Optional	Current Date
StickyDate	`DateTime`	If a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 days	Optional
Subject	`String`	Subject	Optional
SubscribeToThread	`Boolean`	Subscribe To Thread	Optional	False
Tags	`String`	A comma separated list of tags	Optional

Returns

ForumThread

UpdatePollItem

Updates a poll option in a thread. Deprecated: Use poll embedding instead.

Velocity

#set($pollItemResponse = $core_v2_forumThread.UpdatePollItem($threadId, $answerId, $answer, $orderNumber))

JavaScript

var pollItemResponse = core_v2_forumThread.UpdatePollItem(threadId, answerId, answer, orderNumber);

Parameters

Name	Type	Description	Required
threadId	`Int32`	Thread Id	Required
answerId	`String`	Answer Id	Required
answer	`String`	Answer	Required
orderNumber	`Int32`	Order Number	Required

Returns

PollItem

Recommended