Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_forumThread Widget Extension
  • Ask the Community
  • User Documentation
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget API Documentation
    • +JavaScript API Documentation
    • +Widget Associated Types
    • -Widget Extensions
      • $calendar_v1_calendars Widget Extension
      • $calendar_v1_events Widget Extension
      • $calendar_v1_permissions Widget Extension
      • $calendar_v1_registrations Widget Extension
      • $calendar_v1_resources Widget Extension
      • $calendar_v1_UI Widget Extension
      • $calendar_v1_urls Widget Extension
      • $context_v2_propertyTemplate Widget Extension
      • $context_v2_themeBody Widget Extension
      • $context_v2_themeHeader Widget Extension
      • $core_v2_abuseAppeal Widget Extension
      • $core_v2_abuseReport Widget Extension
      • $core_v2_abusiveContent Widget Extension
      • $core_v2_achievement Widget Extension
      • $core_v2_achievementSummary Widget Extension
      • $core_v2_activityStory Widget Extension
      • $core_v2_activityStorySitePreference Widget Extension
      • $core_v2_activityStoryUserPreference Widget Extension
      • $core_v2_apiKey Widget Extension
      • $core_v2_application Widget Extension
      • $core_v2_applicationMerge Widget Extension
      • $core_v2_applicationSubscription Widget Extension
      • $core_v2_applicationType Widget Extension
      • $core_v2_authentication Widget Extension
      • $core_v2_authorQualityScore Widget Extension
      • $core_v2_blog Widget Extension
      • $core_v2_blogConfiguration Widget Extension
      • $core_v2_blogPermissions Widget Extension
      • $core_v2_blogPost Widget Extension
      • $core_v2_blogPostSummary Widget Extension
      • $core_v2_blogUrls Widget Extension
      • $core_v2_bookmark Widget Extension
      • $core_v2_calculatedScores Widget Extension
      • $core_v2_cfs Widget Extension
      • $core_v2_comments Widget Extension
      • $core_v2_commentVotes Widget Extension
      • $core_v2_configuration Widget Extension
      • $core_v2_container Widget Extension
      • $core_v2_containerType Widget Extension
      • $core_v2_content Widget Extension
      • $core_v2_contentConversion Widget Extension
      • $core_v2_contentPresence Widget Extension
      • $core_v2_contentQualityScore Widget Extension
      • $core_v2_contentRecommendation Widget Extension
      • $core_v2_contentSubscribers Widget Extension
      • $core_v2_contentSubscription Widget Extension
      • $core_v2_contentType Widget Extension
      • $core_v2_contentViews Widget Extension
      • $core_v2_conversation Widget Extension
      • $core_v2_conversationMessage Widget Extension
      • $core_v2_customNavigation Widget Extension
      • $core_v2_customPage Widget Extension
      • $core_v2_dynamicForm Widget Extension
      • $core_v2_editableGroup Widget Extension
      • $core_v2_editor Widget Extension
      • $core_v2_emailDigest Widget Extension
      • $core_v2_emoticon Widget Extension
      • $core_v2_encoding Widget Extension
      • $core_v2_eventLog Widget Extension
      • $core_v2_follower Widget Extension
      • $core_v2_following Widget Extension
      • $core_v2_forum Widget Extension
      • $core_v2_forumConfiguration Widget Extension
      • $core_v2_forumPermissions Widget Extension
      • $core_v2_forumReply Widget Extension
      • $core_v2_forumReplyVote Widget Extension
      • $core_v2_forumThread Widget Extension
      • $core_v2_forumThreadVote Widget Extension
      • $core_v2_forumUrls Widget Extension
      • $core_v2_friendship Widget Extension
      • $core_v2_gallery Widget Extension
      • $core_v2_group Widget Extension
      • $core_v2_groupAuthorQualityScore Widget Extension
      • $core_v2_groupContactRequest Widget Extension
      • $core_v2_groupPermissions Widget Extension
      • $core_v2_groupRoleMember Widget Extension
      • $core_v2_groupUrls Widget Extension
      • $core_v2_groupUserMember Widget Extension
      • $core_v2_hashTag Widget Extension
      • $core_v2_infoResult Widget Extension
      • $core_v2_language Widget Extension
      • $core_v2_ldapGroups Widget Extension
      • $core_v2_ldapUsers Widget Extension
      • $core_v2_leader Widget Extension
      • $core_v2_leaderboard Widget Extension
      • $core_v2_leaderboardUrls Widget Extension
      • $core_v2_like Widget Extension
      • $core_v2_likedItem Widget Extension
      • $core_v2_media Widget Extension
      • $core_v2_mediaConfiguration Widget Extension
      • $core_v2_mediaPermissions Widget Extension
      • $core_v2_mediaUrls Widget Extension
      • $core_v2_mention Widget Extension
      • $core_v2_mentionable Widget Extension
      • $core_v2_message Widget Extension
      • $core_v2_moderationTemplates Widget Extension
      • $core_v2_nodePermission Widget Extension
      • $core_v2_notification Widget Extension
      • $core_v2_notificationCategory Widget Extension
      • $core_v2_notificationDistributionType Widget Extension
      • $core_v2_notificationType Widget Extension
      • $core_v2_notificationUserPreference Widget Extension
      • $core_v2_oauthClient Widget Extension
      • $core_v2_page Widget Extension
      • $core_v2_permission Widget Extension
      • $core_v2_pointTransaction Widget Extension
      • $core_v2_poll Widget Extension
      • $core_v2_ratedItem Widget Extension
      • $core_v2_rating Widget Extension
      • $core_v2_recaptcha Widget Extension
      • $core_v2_role Widget Extension
      • $core_v2_roleUsers Widget Extension
      • $core_v2_rssFeedItem Widget Extension
      • $core_v2_search Widget Extension
      • $core_v2_searchCategory Widget Extension
      • $core_v2_searchResult Widget Extension
      • $core_v2_servicePresence Widget Extension
      • $core_v2_sitePermissions Widget Extension
      • $core_v2_statusMessage Widget Extension
      • $core_v2_submittableEditor Widget Extension
      • $core_v2_systemNotification Widget Extension
      • $core_v2_taggedContent Widget Extension
      • $core_v2_tags Widget Extension
      • $core_v2_theme Widget Extension
      • $core_v2_themeFooter Widget Extension
      • $core_v2_themeHeader Widget Extension
      • $core_v2_themePage Widget Extension
      • $core_v2_tourTip Widget Extension
      • $core_v2_ui Widget Extension
      • $core_v2_uploadedFile Widget Extension
      • $core_v2_urls Widget Extension
      • $core_v2_user Widget Extension
      • $core_v2_userAchievement Widget Extension
      • $core_v2_userFile Widget Extension
      • $core_v2_userFolder Widget Extension
      • $core_v2_userInvitation Widget Extension
      • $core_v2_userPermission Widget Extension
      • $core_v2_userPresence Widget Extension
      • $core_v2_userProfileField Widget Extension
      • $core_v2_userProfileFieldGroup Widget Extension
      • $core_v2_userRecommendation Widget Extension
      • $core_v2_userValidation Widget Extension
      • $core_v2_utility Widget Extension
      • $core_v2_webhook Widget Extension
      • $core_v2_webhookEvent Widget Extension
      • $core_v2_widget Widget Extension
      • $core_v2_wiki Widget Extension
      • $core_v2_wikiConfiguration Widget Extension
      • $core_v2_wikiFiles Widget Extension
      • $core_v2_wikiPage Widget Extension
      • $core_v2_wikiPageCommentSubscriptions Widget Extension
      • $core_v2_wikiPageRevision Widget Extension
      • $core_v2_wikiPermissions Widget Extension
      • $core_v2_wikiToc Widget Extension
      • $core_v2_wikiUrls Widget Extension
      • $core_v3_feature Widget Extension
      • $geocoding_v1_core Widget Extension
      • $km_v1_categories Widget Extension
      • $km_v1_documents Widget Extension
      • $km_v1_knowledgeCollections Widget Extension
      • $km_v1_permissions Widget Extension
      • $km_v1_tags Widget Extension
      • $km_v1_urls Widget Extension
      • $telligentIdeas_v1_challenges Widget Extension
      • $telligentIdeas_v1_ideaCategories Widget Extension
      • $telligentIdeas_v1_ideaPermissions Widget Extension
      • $telligentIdeas_v1_ideas Widget Extension
      • $telligentIdeas_v1_ideaStatuses Widget Extension
      • $telligentIdeas_v1_statuses Widget Extension
      • $telligentIdeas_v1_urls Widget Extension
      • $telligentIdeas_v1_userVoteSummaries Widget Extension
      • $telligentIdeas_v1_votes Widget Extension

$core_v2_forumThread Widget Extension


Enables scripted content fragments to use ForumThreads

Properties

NameTypeDescriptionDefaultOptions
ContentTypeIdGuidForum Threads content type identifier
CurrentForumThreadReturns the current contextual Forum Thread
CurrentParentForumThreadIdentifies the thread being replied to when replying to a thread

Methods

AddPollItem

Obsolete.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired
answerstringAnswerRequired
orderNumberintOrder NumberRequired

Return Type

PollItem

AllowsReplies

Determines if the Forum Thread allows replies

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Return Type

bool

AreRatingsEnabled

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

bool

Create

Creates a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
subjectstringSubjectRequired
bodystringBodyRequired

Return Type

ForumThread

Create

Creates a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
subjectstringSubjectRequired
bodystringBodyRequired
ContentTypestringUsed when adding a post attachementOptional
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImagestringURL of image to use when IsFeatured is trueOptional
FileDataByte[]When adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNamestringUsed when adding a post attachementOptional
FileUploadContextstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileUrlstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
HasPollboolDeprecated: Use poll embedding instead.OptionalFalse
IsAnonymousboolIs AnonymousOptionalFalse
IsFeaturedboolIs FeaturedOptionalFalse
IsLockedboolIs LockedOptionalFalse
IsQuestionboolOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyboolIs StickyOptionalFalse
PollDescriptionstringDeprecated: Use poll embedding instead.Optional
PollExpirationDateDateTimeDeprecated: Use poll embedding instead.Optional
PollTitlestringDeprecated: Use poll embedding instead.Optional
PostDateDateTimePost DateOptionalCurrent Date
StickyDateDateTimeIf a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 daysOptional
SubscribeToThreadboolSubscribe To ThreadOptionalFalse
TagsstringA comma separated list of tagsOptional

Return Type

ForumThread

Delete

Deletes a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired
DeleteChildrenboolDelete ChildrenOptionalFalse
DeleteReasonstringDelete ReasonOptionalFalse
SendAuthorDeleteNotificationboolSend Author Delete NotificationOptionalFalse

Return Type

AdditionalInfo

DeleteWikiPageAssociation

Deletes an association with a wiki page if one exits

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired

Return Type

AdditionalInfo

Get

Gets a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired

Return Type

ForumThread

Get

Gets a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidThread Content IdRequired

Return Type

ForumThread

Get

Gets a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired
ForumIdintForum IdOptional

Return Type

ForumThread

GetRating

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

Rating

IncrementViewCount

Increments the view count for a thread

Usage

$core_v2_forumThread.IncrementViewCount($forumThreadId)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

IsFavorite

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

bool

IsMuted

Returns the muted status for the accessing user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

bool

IsSubscribed

Returns subscribed status for the accessing user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

bool

List

Lists Forum Threads

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadQueryTypestringForum Thread Query TypeRequiredAllActive, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, Unanswered, Unread

Return Type

PagedList<ForumThread>

List

Usage

#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, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PopularOnly = $popularOnlyArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
AreStickyPostsOnTopboolDetermines whether to place sticky posts at the top of the list. This setting only applies to the lastpost' sort.OptionalTrue
AuthorIdintAuthor IdOptional
ContentIdsstringUsed to limit to a specific set of forum threads as well as sort order if SoryBy is set to ContentIdsOrderOptional
CreatedAfterDateDateTime?Include only threads created on or after.Optional
CreatedBeforeDateDateTime?Include only threads created before.Optional
ForumIdintForum IdOptional
ForumThreadQueryTypestringForum Thread Query TypeOptionalAllActive, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Moderated, MyThreads, Unanswered, Unread
GroupIdintGroup IdOptional
IncludeDiscussionsboolInclude discussion threadsOptionalTrue
IncludeQuestionsboolInclude question and answer threadsOptionalTrue
IncludeSubGroupsboolWhether to include sub groupsOptionalFalse
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
PopularOnlyboolWhether to include popular threads onlyOptionalFalse
SortBystring'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.OptionalContentIdsOrder, Date, LastPost, QualityScore, Replies, Score:SCORE_ID, Topic, TotalQualityVotes, Views, Votes
SortOrderstringDefault is Descending for lastpost, date, replies, and views. Default is Ascending for topicOptionalAscending, Descending

Return Type

PagedList<ForumThread>

List

Lists Forum Threads

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadQueryTypestringForum Thread Query TypeRequiredAllActive, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, Unanswered, Unread
ContentIdsstringComma separated list of ContentIds. Used to limit to a specific set of forum threads as well as sort order if SoryBy is set to ContentIdsOrderOptional
ForumIdintForum IdOptional
GroupIdintGroup IdOptional
IncludeDiscussionsboolInclude discussion threadsOptionalTrue
IncludeQuestionsboolInclude question and answer threadsOptionalTrue
IncludeSubGroupsboolWhether to include sub groupsOptionalFalse
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
PopularOnlyboolWhether to include popular threads onlyOptionalFalse
SortBystring'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.OptionalContentIdsOrder, Date, LastPost, QualityScore, Replies, Score:SCORE_ID, Topic, TotalQualityVotes, Views, Votes
SortOrderstringDefault is Descending for lastpost, date, replies, and views. Default is Ascending for topicOptionalAscending, Descending

Return Type

PagedList<ForumThread>

List

Lists Forum Threads

Usage

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

Return Type

PagedList<ForumThread>

ListPollItems

Obsolete.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired

Return Type

ApiList<PollItem>

MarkAsRead

Mark the thread as read by the accessing user

Usage

$core_v2_forumThread.MarkAsRead($threadId)

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired

Preview

Previews a thread before it is saved

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
BodystringBodyOptional
ContentTypestringUsed when adding a post attachementOptional
FeaturedImagestringFeatured ImageOptional
FileDataByte[]When adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNamestringUsed when adding a post attachementOptional
FileUploadContextstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileUrlstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
IsAnonymousboolIs AnonymousOptionalFalse
IsFeaturedboolIs FeaturedOptionalFalse
IsLockedboolIs LockedOptionalFalse
IsQuestionboolOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyboolIs StickyOptionalFalse
PostDateDateTimePost DateOptionalCurrent Date
StickyDateDateTimeIf a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 daysOptional
SubjectstringSubjectOptional
SubscribeToThreadboolSubscribe To ThreadOptionalFalse
TagsstringA comma separated list of tagsOptional

Return Type

ForumThread

RemovePollItem

Obsolete.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired
answerIdstringAnswer IdRequired

Return Type

AdditionalInfo

Report

Obsolete.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
subjectstringSubjectRequired
bodystringBodyRequired
TagsstringComma-separated list of tagsOptional

Return Type

ForumThread

SetFavorite

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

Usage

$core_v2_forumThread.SetFavorite($forumThreadId, $favorite)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired
favoriteboolFavorite StatusRequired

SetMuted

Sets the muted status for the accessing user

Usage

$core_v2_forumThread.SetMuted($forumThreadId, $mute)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired
muteboolMuted StatusRequired

SetRating

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

Usage

$core_v2_forumThread.SetRating($forumThreadId, $rating)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired
ratingintRating value (0-5)Required

SetSubscribed

Sets subscribed status for the accessing user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired
subscribeboolSubscribed StatusRequired

Return Type

AdditionalInfo

SubscriptionType

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdintForum Thread IdRequired

Return Type

string

Update

Updates a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
threadIdintThread IdRequired
BodystringBodyOptional
ContentTypestringUsed when adding a post attachementOptional
EditNotesstringEdit NotesOptional
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImagestringURL of image to use when IsFeatured is trueOptional
FileDataByte[]When adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNamestringUsed when adding a post attachementOptional
FileUploadContextstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileUrlstringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
HasPollboolDeprecated: Use poll embedding instead.OptionalFalse
IsAnonymousboolIs AnonymousOptionalFalse
IsFeaturedboolIs FeaturedOptionalFalse
IsLockedboolIs LockedOptionalFalse
IsQuestionboolOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyboolIs StickyOptionalFalse
PollDescriptionstringDeprecated: Use poll embedding instead.Optional
PollExpirationDateDateTimeDeprecated: Use poll embedding instead.Optional
PollTitlestringDeprecated: Use poll embedding instead.Optional
PostDateDateTimePost DateOptionalCurrent Date
StickyDateDateTimeIf a thread is sticky, used to specify how long it should be sticky. If no sticky date provided default is current date + 7 daysOptional
SubjectstringSubjectOptional
SubscribeToThreadboolSubscribe To ThreadOptionalFalse
TagsstringA comma separated list of tagsOptional

Return Type

ForumThread

Update

Updates a Forum Thread

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
threadIdintThread IdRequired

Return Type

ForumThread

UpdatePollItem

Obsolete.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdintThread IdRequired
answerIdstringAnswer IdRequired
answerstringAnswerRequired
orderNumberintOrder NumberRequired

Return Type

PollItem


  • Share
  • History
  • More
  • Cancel
Related
Recommended
  • Telligent
  • Professional Services
  • Submit a Support Ticket
  • Become a Partner
  • Request a Demo
  • Contact Us

About
Privacy Policy
Terms of use
Copyright 2021 Verint, Inc.
Powered by Verint Community