Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation core_v2_forumThread Script API
  • User Documentation
  • Ask the Community
  • API Documentation
  • Manager Training
  • Developer Training
  • Tags
  • More
  • Cancel
  • New
  • API Documentation
  • +In-Process API Documentation
  • +Plugin API Documentation
  • +REST API Documentation
  • -Widget, Theme, and Automation APIs
    • +Automation Events
    • +Client-side APIs
    • +Dynamic Configuration
    • +LESS Functions
    • +Script API Types
    • -Script APIs
      • articles_v1_articleCategories Script API
      • articles_v1_articleCollections Script API
      • articles_v1_articles Script API
      • articles_v1_articleTypes Script API
      • articles_v1_articleUrls Script API
      • articles_v1_articleVersionCategories Script API
      • articles_v1_articleVersions Script API
      • articles_v1_categories Script API
      • articles_v1_helpfulness Script API
      • articles_v1_helpfulnessResponseTypes Script API
      • articles_v1_permissions Script API
      • articles_v1_publishGroups Script API
      • articles_v1_subscriptionTypes Script API
      • calendar_v1_calendars Script API
      • calendar_v1_events Script API
      • calendar_v1_permissions Script API
      • calendar_v1_registrations Script API
      • calendar_v1_resources Script API
      • calendar_v1_UI Script API
      • calendar_v1_urls Script API
      • context_v2_automationState Script API
      • context_v2_automationTrigger Script API
      • context_v2_embeddable Script API
      • context_v2_propertyRule Script API
      • context_v2_propertyTemplate Script API
      • context_v2_scheduledFile Script API
      • context_v2_themeBody Script API
      • context_v2_themeHeader Script API
      • core_v1_reportingPermissions Script API
      • core_v1_reportingUrls Script API
      • core_v2_abuseAppeal Script API
      • core_v2_abuseReport Script API
      • core_v2_abusiveContent Script API
      • core_v2_achievement Script API
      • core_v2_achievementSummary Script API
      • core_v2_activityStory Script API
      • core_v2_activityStorySitePreference Script API
      • core_v2_activityStoryUserPreference Script API
      • core_v2_apiKey Script API
      • core_v2_application Script API
      • core_v2_applicationMerge Script API
      • core_v2_applicationSubscription Script API
      • core_v2_applicationType Script API
      • core_v2_authentication Script API
      • core_v2_authorQualityScore Script API
      • core_v2_automation Script API
      • core_v2_blog Script API
      • core_v2_blogConfiguration Script API
      • core_v2_blogPermissions Script API
      • core_v2_blogPost Script API
      • core_v2_blogPostSummary Script API
      • core_v2_blogUrls Script API
      • core_v2_bookmark Script API
      • core_v2_calculatedScores Script API
      • core_v2_captureThreadToArticle Script API
      • core_v2_cfs Script API
      • core_v2_comments Script API
      • core_v2_commentSummary Script API
      • core_v2_commentVotes Script API
      • core_v2_configuration Script API
      • core_v2_container Script API
      • core_v2_containerType Script API
      • core_v2_content Script API
      • core_v2_contentConversion Script API
      • core_v2_contentPresence Script API
      • core_v2_contentQualityScore Script API
      • core_v2_contentRecommendation Script API
      • core_v2_contentSubscribers Script API
      • core_v2_contentSubscription Script API
      • core_v2_contentType Script API
      • core_v2_contentViews Script API
      • core_v2_conversation Script API
      • core_v2_conversationMessage Script API
      • core_v2_customNavigation Script API
      • core_v2_customPage Script API
      • core_v2_dynamicForm Script API
      • core_v2_editableGroup Script API
      • core_v2_editor Script API
      • core_v2_email Script API
      • core_v2_emailDigest Script API
      • core_v2_emoticon Script API
      • core_v2_encoding Script API
      • core_v2_eventLog Script API
      • core_v2_exceptions Script API
      • core_v2_follower Script API
      • core_v2_following Script API
      • core_v2_forum Script API
      • core_v2_forumConfiguration Script API
      • core_v2_forumPermissions Script API
      • core_v2_forumReply Script API
      • core_v2_forumReplyVote Script API
      • core_v2_forumThread Script API
      • core_v2_forumThreadVote Script API
      • core_v2_forumUrls Script API
      • core_v2_friendship Script API
      • core_v2_gallery Script API
      • core_v2_group Script API
      • core_v2_groupAuthorQualityScore Script API
      • core_v2_groupContactRequest Script API
      • core_v2_groupPermissions Script API
      • core_v2_groupRoleMember Script API
      • core_v2_groupUrls Script API
      • core_v2_groupUserMember Script API
      • core_v2_hashTag Script API
      • core_v2_http Script API
      • core_v2_infoResult Script API
      • core_v2_language Script API
      • core_v2_ldapGroups Script API
      • core_v2_ldapUsers Script API
      • core_v2_leader Script API
      • core_v2_leaderboard Script API
      • core_v2_leaderboardUrls Script API
      • core_v2_like Script API
      • core_v2_likedItem Script API
      • core_v2_media Script API
      • core_v2_mediaConfiguration Script API
      • core_v2_mediaPermissions Script API
      • core_v2_mediaUrls Script API
      • core_v2_mention Script API
      • core_v2_mentionable Script API
      • core_v2_message Script API
      • core_v2_moderationTemplates Script API
      • core_v2_notification Script API
      • core_v2_notificationCategory Script API
      • core_v2_notificationDistributionType Script API
      • core_v2_notificationType Script API
      • core_v2_notificationUserPreference Script API
      • core_v2_oauthClient Script API
      • core_v2_page Script API
      • core_v2_permission Script API
      • core_v2_pointTransaction Script API
      • core_v2_poll Script API
      • core_v2_process Script API
      • core_v2_ratedItem Script API
      • core_v2_rating Script API
      • core_v2_reviewableContent Script API
      • core_v2_role Script API
      • core_v2_roleUsers Script API
      • core_v2_rssFeedItem Script API
      • core_v2_search Script API
      • core_v2_searchCategory Script API
      • core_v2_searchResult Script API
      • core_v2_servicePresence Script API
      • core_v2_sitePermissions Script API
      • core_v2_statusMessage Script API
      • core_v2_submittableEditor Script API
      • core_v2_systemNotification Script API
      • core_v2_taggedContent Script API
      • core_v2_tags Script API
      • core_v2_theme Script API
      • core_v2_themeFooter Script API
      • core_v2_themeHeader Script API
      • core_v2_themePage Script API
      • core_v2_tourTip Script API
      • core_v2_ui Script API
      • core_v2_uploadedFile Script API
      • core_v2_urls Script API
      • core_v2_user Script API
      • core_v2_userAchievement Script API
      • core_v2_userFile Script API
      • core_v2_userFolder Script API
      • core_v2_userInvitation Script API
      • core_v2_userPermission Script API
      • core_v2_userProfileField Script API
      • core_v2_userProfileFieldGroup Script API
      • core_v2_userRecommendation Script API
      • core_v2_userValidation Script API
      • core_v2_utility Script API
      • core_v2_webhook Script API
      • core_v2_webhookEvent Script API
      • core_v2_widget Script API
      • core_v2_wiki Script API
      • core_v2_wikiConfiguration Script API
      • core_v2_wikiFiles Script API
      • core_v2_wikiPage Script API
      • core_v2_wikiPageCommentSubscriptions Script API
      • core_v2_wikiPageRevision Script API
      • core_v2_wikiPermissions Script API
      • core_v2_wikiToc Script API
      • core_v2_wikiUrls Script API
      • core_v3_feature Script API
      • core_v3_permission Script API
      • telligentIdeas_v1_challenges Script API
      • telligentIdeas_v1_ideaCategories Script API
      • telligentIdeas_v1_ideaPermissions Script API
      • telligentIdeas_v1_ideas Script API
      • telligentIdeas_v1_ideaStatuses Script API
      • telligentIdeas_v1_statuses Script API
      • telligentIdeas_v1_urls Script API
      • telligentIdeas_v1_userVoteSummaries Script API
      • telligentIdeas_v1_votes Script API

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

NameAccessTypeDescription
ContentTypeIdReadGuidForum Threads content type identifier
CurrentReadForumThreadReturns the current contextual Forum Thread
CurrentParentReadForumThreadIdentifies 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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
answerStringAnswerRequired
orderNumberInt32Order NumberRequired

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

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumIdInt32Forum IdRequired
subjectStringSubjectRequired
bodyStringBodyRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumIdInt32Forum IdRequired
subjectStringSubjectRequired
bodyStringBodyRequired
optionsOptionsSet of optional parameters including:Required
ContentTypeStringUsed when adding a post attachmentOptional
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
FileDataArray of ByteWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.Optional
FileNameStringUsed when adding a post attachmentOptional
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
HasPollBooleanDeprecated: Use poll embedding instead.OptionalFalse
IsAnonymousBooleanIs AnonymousOptionalFalse
IsFeaturedBooleanIs FeaturedOptionalFalse
IsLockedBooleanIs LockedOptionalFalse
IsQuestionBooleanOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyBooleanIs 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
SubscribeToThreadBooleanSubscribe To ThreadOptionalFalse
TagsStringA comma separated list of tagsOptional

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
optionsOptionsSet of optional parameters including:Required
DeleteChildrenBooleanDelete ChildrenOptionalFalse
DeleteReasonStringDelete ReasonOptionalFalse
SendAuthorDeleteNotificationBooleanSend Author Delete NotificationOptionalFalse

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired

Get Overload 2

Gets a Forum Thread

Velocity

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

JavaScript

var forumThreadResponse = core_v2_forumThread.Get(contentId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidThread Content IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
optionsOptionsSet of optional parameters including:Required
ForumIdInt32Forum IdOptional

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

Returns

Rating

IncrementViewCount

Increments the view count for a thread

Velocity

$core_v2_forumThread.IncrementViewCount($forumThreadId)

JavaScript

core_v2_forumThread.IncrementViewCount(forumThreadId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadQueryTypeStringForum Thread Query TypeRequiredAllActive, 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

NameTypeDescriptionRequiredDefaultOptions
forumThreadQueryTypeStringForum Thread Query TypeRequiredAllActive, All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, NoResponse, Unanswered, Unread
optionsOptionsSet of optional parameters including:Required
ContentIdsStringComma separated list of ContentIds. Used to limit to a specific set of forum threads as well as sort order if SortBy is set to ContentIdsOrderOptional
ForumIdInt32Forum IdOptional
GroupIdInt32Group IdOptional
IncludeDiscussionsBooleanInclude discussion threadsOptionalTrue
IncludeQuestionsBooleanInclude question and answer threadsOptionalTrue
IncludeSubGroupsBooleanWhether to include sub groupsOptionalFalse
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
PopularOnlyBooleanWhether 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

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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
AreStickyPostsOnTopBooleanDetermines whether to place sticky posts at the top of the list. This setting only applies to the lastpost' sort.OptionalTrue
AuthorIdInt32Author IdOptional
ContentIdsStringUsed to limit to a specific set of forum threads as well as sort order if SortBy is set to ContentIdsOrderOptional
CreatedAfterDateNullable of DateTimeInclude only threads created on or after.Optional
CreatedBeforeDateNullable of DateTimeInclude only threads created before.Optional
ForumIdInt32Forum IdOptional
ForumThreadQueryTypeStringForum Thread Query TypeOptionalAllActive (Obsolete), All, Answered, AnsweredNotVerified, AnsweredWithNotVerified, Authored, Moderated, MyThreads, NoResponse, Unanswered, Unread
GroupIdInt32Group IdOptional
IncludeDiscussionsBooleanInclude discussion threadsOptionalTrue
IncludeQuestionsBooleanInclude question and answer threadsOptionalTrue
IncludeSubGroupsBooleanWhether to include sub groupsOptionalFalse
MaximumReplyCountInt32Maximum number of replies a thread can have to be returned.Optional
MinimumReplyCountInt32Minimum number of replies a thread must have to be returned.Optional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
PopularOnlyBooleanWhether 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

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumIdInt32Forum IdRequired
optionsOptionsSet of optional parameters including:Required
BodyStringBodyOptional
ContentTypeStringUsed when adding a post attachmentOptional
FeaturedImageStringFeatured ImageOptional
FileDataArray of ByteWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.Optional
FileNameStringUsed when adding a post attachmentOptional
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
IsAnonymousBooleanIs AnonymousOptionalFalse
IsFeaturedBooleanIs FeaturedOptionalFalse
IsLockedBooleanIs LockedOptionalFalse
IsQuestionBooleanOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyBooleanIs 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
SubscribeToThreadBooleanSubscribe To ThreadOptionalFalse
TagsStringA comma separated list of tagsOptional

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
answerIdStringAnswer IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
subjectStringSubjectRequired
bodyStringBodyRequired
optionsOptionsSet of optional parameters including:Required
TagsStringComma-separated list of tagsOptional

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired
favoriteBooleanFavorite StatusRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired
muteBooleanMuted StatusRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired
ratingInt32Rating 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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired
subscribeBooleanSubscribed StatusRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumThreadIdInt32Forum Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumIdInt32Forum IdRequired
threadIdInt32Thread IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
forumIdInt32Forum IdRequired
threadIdInt32Thread IdRequired
optionsOptionsSet of optional parameters including:Required
BodyStringBodyOptional
ContentTypeStringUsed when adding a post attachmentOptional
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
FileDataArray of ByteWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNameStringUsed when adding a post attachmentOptional
FileUploadContextStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required. OBSOLETE in 12: Use FileUrl or FileUploadContext instead.Optional
FileUrlStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
HasPollBooleanDeprecated: Use poll embedding instead.OptionalFalse
IsAnonymousBooleanIs AnonymousOptionalFalse
IsFeaturedBooleanIs FeaturedOptionalFalse
IsLockedBooleanIs LockedOptionalFalse
IsQuestionBooleanOnly used when the forum being posted to has both discussions and questionsOptionalFalse
IsStickyBooleanIs 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
SubscribeToThreadBooleanSubscribe To ThreadOptionalFalse
TagsStringA comma separated list of tagsOptional

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
answerIdStringAnswer IdRequired
answerStringAnswerRequired
orderNumberInt32Order NumberRequired

Returns

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 2024 Verint, Inc.
Powered by Verint Community