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_forumReply 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_forumReply Script API


Enables scripted content fragments to use ForumReplys

  • Properties
  • AreRatingsEnabled
  • Create
  • Delete
  • Get
  • GetAncestors
  • GetForumReplyPageIndex
  • GetRating
  • IncrementViewCount
  • List
  • ListThreaded
  • ListThreadedForReply
  • Preview
  • SetRating
  • Update

Properties

NameAccessTypeDescription
ContentTypeIdReadGuidForum replies content type identifier
CurrentReadForumReplyCurrent
CurrentParentReadForumReplyCurrent 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

NameTypeDescriptionRequiredDefaultOptions
forumReplyIdInt32Forum Reply IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Id of forum threadRequired
bodyStringContent of replyRequired

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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Id of forum threadRequired
bodyStringContent of replyRequired
optionsOptionsSet of optional parameters including:Required
ContentTypeStringUsed when adding a post attachment.Optional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
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 attachment.Optional
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
ForumIdInt32Id of the forumOptional
ForumReplyIdInt32Forum Reply IdOptional
IsAnonymousBooleanUsed when the reply should be made anonymouslyOptionalFalse
IsSuggestedAnswerBooleanOnly applied to replies to threads that are questions.OptionalFalse
PostDateDateTimeDefaults to current datetime if not specified.Optional
SubscribeToThreadBooleanWhether the thread should be subscribedOptionalFalse
TagsStringA comma separated list of tags.Optional

Returns

ForumReply

Delete

Delete Overload 1

Deletes a forum thread reply

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_forumReply.Delete(replyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Forum reply idRequired

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

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Forum reply idRequired
optionsOptionsSet of optional parameters including:Required
DeleteChildrenBooleanDeletes the reply's childrenOptionalFalse
DeleteReasonStringReason for deleting the replyOptional
SendAuthorDeleteNotificationBooleanSends author a delete notificationOptionalFalse

Returns

AdditionalInfo

Get

Get Overload 1

Get a single forum thread reply

Velocity

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

JavaScript

var forumReplyResponse = core_v2_forumReply.Get(replyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Id of forum thread replyRequired

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

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

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

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Id of forum thread replyRequired
optionsOptionsSet of optional parameters including:Required
ForumIdInt32Id of parent forumOptional
ThreadIdInt32Id of parent forum threadOptional

Returns

ForumReply

GetAncestors

Gets the hierarchy ancestors for a threaded reply.

Velocity

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

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Id of the forum thread replyRequired
depthNullable of Int32Levels of ancestors to return from the root reply down. Zero based with a max of 9. If 0 is specified, only the root reply id is returned. If the reply is the root reply, ApiList will have no records.Required

Returns

ApiList of ForumReply

GetForumReplyPageIndex

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

Velocity

#set($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

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Id of the forum threadRequired
replyIdInt32Id of the forum thread replyRequired
optionsOptionsSet of optional parameters including:Required
ForumReplyQueryTypeStringReply TypeOptionalmoderated, non-verified-answers, verified-answers
IncludeThreadStarterBooleanUsed when determining whether to count the thread starter with the count of repliesOptionalFalse
PageSizeInt32Specify the number of results to return per page. Optional20
SortByInt32Sort ByOptional00 (Reply Date), 1 (UserId), 3 (Total Votes)
SortOrderBooleanSort OrderOptionalFalsefalse (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

NameTypeDescriptionRequiredDefaultOptions
forumReplyIdInt32Forum Reply IdRequired

Returns

Rating

IncrementViewCount

Velocity

$core_v2_forumReply.IncrementViewCount($forumReplyId)

JavaScript

core_v2_forumReply.IncrementViewCount(forumReplyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumReplyIdInt32Forum Reply IdRequired

Returns

Nothing

List

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

NameTypeDescriptionRequiredDefaultOptions
threadIdNullable of Int32Id of forum threadRequired

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

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
AuthorIdInt32Id of the reply author. If threadId is not provided, AuthorId or ForumReplyQueryType = 'moderated' is required.Optional
ContentIdsStringComma separated list of ContentIds. Used to limit to a specific set of replies as well as sort order if SortBy is set to ContentIdsOrderOptional
ForumIdInt32Id of the parent forumOptional
ForumReplyQueryTypeStringReply TypeOptionalmoderated, non-verified-answers, verified-answers
GroupIdInt32Id of the parent groupOptional
IncludeDiscussionThreadsBooleanWhen false, excludes replies of discussion type threads.Optional
IncludeQuestionThreadsBooleanWhen false, excludes replies of question type threads.Optional
IncludeSubGroupsBooleanUsed when getting forum replies for a group to specify whether or not to include subgroups. OptionalFalse
IncludeThreadStarterBooleanWhen true, includes the original thread post in the set of repliesOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page. Optional20
ParentReplyIdInt32Parent Reply IdOptional
SortByBooleanSort ByOptionalPostDateContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrderStringSort OrderOptionalAscendingAscending, 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

NameTypeDescriptionRequiredDefaultOptions
threadIdNullable of Int32Id of forum thread. If not provided, AuthorId or ForumReplyQueryType = 'moderated'Required
optionsOptionsSet of optional parameters including:Required
AuthorIdInt32Id of the reply author. If threadId is not provided, AuthorId or ForumReplyQueryType = 'moderated' is required.Optional
ContentIdsStringUsed to limit to a specific set of replies as well as sort order if SortBy is set to ContentIdsOrderOptional
ForumIdInt32Id of the parent forumOptional
ForumReplyQueryTypeStringReply Type. When Reply Type is set to 'moderated' options are limited to ForumId, GroupId, IncludeSubGroups, PageSize and PageIndex.Optionalmoderated, non-verified-answers, verified-answers
GroupIdInt32Id of the parent groupOptional
IncludeDiscussionThreadsBooleanWhen false, excludes replies of discussion type threads.Optional
IncludeQuestionThreadsBooleanWhen false, excludes replies of question type threads.Optional
IncludeSubGroupsBooleanUsed when getting forum replies for a group to specify whether or not to include subgroups. OptionalFalse
IncludeThreadStarterBooleanWhen true, includes the original thread post in the set of repliesOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page. Optional20
ParentReplyIdInt32Parent Reply IdOptional
SortByBooleanSort ByOptionalPostDateContentIdsOrder, PostDate, Score:SCORE_ID, SortOrder, TotalVotes, UserID
SortOrderStringSort OrderOptionalAscendingAscending, Descending

Returns

PagedList of ForumReply

ListThreaded

Lists threaded replies for a forum thread

Velocity

#set($apiListResponse = $core_v2_forumReply.ListThreaded($threadId, "%{ ChildPageSize = $childPageSizeArg, CreatedEndDate = $createdEndDateArg, CreatedStartDate = $createdStartDateArg, EndReplyId = $endReplyIdArg, FlattenedDepth = $flattenedDepthArg, FlattenedSortBy = $flattenedSortByArg, FlattenedSortOrder = $flattenedSortOrderArg, ParentReplyId = $parentReplyIdArg, RootPageSize = $rootPageSizeArg, StartReplyId = $startReplyIdArg, ThreadedSortBy = $threadedSortByArg, ThreadedSortOrder = $threadedSortOrderArg }"))

JavaScript

var apiListResponse = core_v2_forumReply.ListThreaded(threadId, { ChildPageSize: childPageSizeArg, CreatedEndDate: createdEndDateArg, CreatedStartDate: createdStartDateArg, EndReplyId: endReplyIdArg, FlattenedDepth: flattenedDepthArg, FlattenedSortBy: flattenedSortByArg, FlattenedSortOrder: flattenedSortOrderArg, ParentReplyId: parentReplyIdArg, RootPageSize: rootPageSizeArg, StartReplyId: startReplyIdArg, ThreadedSortBy: threadedSortByArg, ThreadedSortOrder: threadedSortOrderArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
optionsOptionsSet of optional parameters including:Required
ChildPageSizeInt32Specifies the number of child records to return per first level reply. Max of 50.Optional10
CreatedEndDateDateTimeCreated end date. Only filters first level of replies returned.Optional
CreatedStartDateDateTimeCreated start date. Only filters first level of replies returned.Optional
EndReplyIdInt32Ending root level Reply IdOptional
FlattenedDepthInt32Specify the depth at which all child replies will be wrapped under the last level of threaded replies. Zero-based index. Max of 9.Optional3
FlattenedSortByStringSort flattened replies by OptionalCreatedDate
FlattenedSortOrderStringFlattened Sort OrderOptionalAscendingAscending, Descending
ParentReplyIdInt32Parent Reply IdOptional
RootPageSizeInt32Number of first level replies to return. Max of 100.Optional20
StartReplyIdInt32Starting root level Reply IdOptional
ThreadedSortByStringSort threaded replies by OptionalCreatedDate
ThreadedSortOrderStringThreaded Sort OrderOptionalAscendingAscending, Descending

Returns

ApiList of ThreadedForumReply

ListThreadedForReply

Lists threaded replies for a forum thread based on a specific reply. Will return all direct anscetors including the reply up until the PageSize is reached. May not return the top level replies if the specified reply is too deap.

Velocity

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

JavaScript

var apiListResponse = core_v2_forumReply.ListThreadedForReply(threadId, { Direction: directionArg, FlattenedDepth: flattenedDepthArg, FlattenedSortBy: flattenedSortByArg, FlattenedSortOrder: flattenedSortOrderArg, PageSize: pageSizeArg, ReplyId: replyIdArg, ThreadedSortBy: threadedSortByArg, ThreadedSortOrder: threadedSortOrderArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Thread IdRequired
optionsOptionsSet of optional parameters including:Required
DirectionStringSpecifies 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.OptionalFromReply, FromRootReply
FlattenedDepthInt32Specify the depth at which all child replies will be wrapped under the last level of threaded replies. Zero-based index. Max of 9.Optional3
FlattenedSortByStringSort flattened replies by OptionalCreatedDate
FlattenedSortOrderStringFlattened Sort OrderOptionalAscendingAscending, Descending
PageSizeInt32Number of replies to return. Max of 100.Optional20
ReplyIdInt32Reply IdOptional
ThreadedSortByStringSort threaded replies by OptionalCreatedDate
ThreadedSortOrderStringThreaded Sort OrderOptionalAscendingAscending, Descending

Returns

ApiList of ThreadedForumReply

Preview

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

Velocity

#set($forumReplyResponse = $core_v2_forumReply.Preview($threadId, "%{ Body = $bodyArg, ContentType = $contentTypeArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, ForumId = $forumIdArg, IsAnonymous = $isAnonymousArg, IsSuggestedAnswer = $isSuggestedAnswerArg, PostDate = $postDateArg, SubscribeToThread = $subscribeToThreadArg, Tags = $tagsArg }"))

JavaScript

var forumReplyResponse = core_v2_forumReply.Preview(threadId, { Body: bodyArg, ContentType: contentTypeArg, FileData: fileDataArg, FileName: fileNameArg, FileUploadContext: fileUploadContextArg, FileUrl: fileUrlArg, ForumId: forumIdArg, IsAnonymous: isAnonymousArg, IsSuggestedAnswer: isSuggestedAnswerArg, PostDate: postDateArg, SubscribeToThread: subscribeToThreadArg, Tags: tagsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
threadIdInt32Id of the forum threadRequired
optionsOptionsSet of optional parameters including:Required
BodyStringContent of the replyOptional
ContentTypeStringUsed when adding a post attachment.Optional
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 attachment.Optional
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
ForumIdInt32Id of the forumOptional
IsAnonymousBooleanUsed when the reply should be made anonymouslyOptionalFalse
IsSuggestedAnswerBooleanOnly applied to replies to threads that are questions.OptionalFalse
PostDateDateTimeDefaults to current datetime if not specified.Optional
SubscribeToThreadBooleanWhether the thread should be subscribed toOptionalFalse
TagsStringA comma separated list of tags.Optional

Returns

ForumReply

SetRating

DEPRECATED: Use $core_v2_rating.Create() instead.

Velocity

$core_v2_forumReply.SetRating($forumReplyId, $rating)

JavaScript

core_v2_forumReply.SetRating(forumReplyId, rating);

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumReplyIdInt32Forum Reply IdRequired
ratingInt32RatingRequired

Returns

Nothing

Update

Update Overload 1

Update a forum thread reply

Velocity

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

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Id of forum thread replyRequired
threadIdInt32Id of forum threadRequired
forumIdInt32Id of forumRequired

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

NameTypeDescriptionRequiredDefaultOptions
replyIdInt32Id of forum thread replyRequired
threadIdInt32Id of forum threadRequired
forumIdInt32Id of forumRequired
optionsOptionsSet of optional parameters including:Required
BodyStringContent of the replyOptional
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
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 requiredOptional
FileUrlStringWhen adding a post attachment either FileData, FileUrl or FileUploadContext is requiredOptional
IsAnonymousBooleanIs AnonymousOptional
IsAnswerBooleanOnly applied to replies to threads that are questions.Optional
IsSuggestedAnswerBooleanOnly applied to replies to threads that are questions.Optional
PostDateDateTimeReply DateOptional
RemoveAttachmentBooleanUsed to remove an existing post attachmentOptionalFalse
SubscribeToThreadBooleanWhether the thread should be subscribedOptional
TagsStringA comma separated list of tagsOptional

Returns

ForumReply


  • 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