Telligent Community
Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_forum 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_forum Widget Extension


Enables scripted content fragments to use Forums

Properties

NameTypeDescriptionDefaultOptions
ApplicationTypeIdGuidForums application type identifier
ContentTypeIdGuidForums content type identifier
CurrentForumCurrent contextual forum
TotalLicensedRemainingintTotal number licensed forums

Methods

Create

Creates a forum

Usage

#set($forumResponse = $core_v2_forum.Create($groupId, $name))

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdintGroup IdRequired
namestringNameRequired

Return Type

Forum

Create

Creates a forum

Usage

#set($forumResponse = $core_v2_forum.Create($groupId, $name, "%{AllowedThreadTypes = $allowedThreadTypesArg, AutoLockingDefaultInterval = $autoLockingDefaultIntervalArg, AutoLockingEnabled = $autoLockingEnabledArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, EnableQualityVoting = $enableQualityVotingArg, ExtendedAttributes = $extendedAttributesArg, IndexPosts = $indexPostsArg, Key = $keyArg, MailingListAddress = $mailingListAddressArg, MailingListName = $mailingListNameArg, ModeratePosts = $moderatePostsArg, PassiveModeAddress = $passiveModeAddressArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdintGroup IdRequired
namestringNameRequired
AllowedThreadTypesstringA comma separated list of thread types supported.OptionalDiscussionDiscussion, QuestionAndAnswer
AutoLockingDefaultIntervalintThe number of days before a thread is automatically locked when the Forum Auto-Locking plugin is enabled. If not specified and auto-locking is enabled, the plugin's configuration value is used.Optional
AutoLockingEnabledboolTurns on auto locking of threads according to the configuration of the Forum Auto Locking plugin if it is enabled.OptionalFalse
DefaultThreadTypestringThe default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowedOptionalDiscussionDiscussion, QuestionAndAnswer
DescriptionstringDescriptionOptional
EmailFooterstringEmail FooterOptional
EnabledboolEnabledOptionalTrue
EnableMailingListboolEnable Mailing ListOptionalFalse
EnablePassiveModeboolEnable Passive ModeOptionalFalse
EnablePostPointsboolObsolete in 10.0. This option is no longer used.OptionalTrue
EnablePostStatisticsboolEnable Post StatisticsOptionalTrue
EnableQualityVotingboolEnable Quality VotingOptionalFalse
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
IndexPostsboolIndex PostsOptionalTrue
KeystringString identifier uniquely identifying a forum within its containing group. Used in the url. If unspecified, will be auto-generated based on the NameOptional
MailingListAddressstringMailing List Address. Required if EnableMailingList is trueOptional
MailingListNamestringMailing List Name. Required if EnableMailingList is trueOptional
ModeratePostsboolModerate PostsOptionalFalse
PassiveModeAddressstringPassive Mode Address. Required if EnablePassiveMode is true.OptionalTrue

Return Type

Forum

Delete

Deletes a forum

Usage

#set($additionalInfoResponse = $core_v2_forum.Delete($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintForum IdRequired

Return Type

AdditionalInfo

Get

Gets a forum

Usage

#set($forumResponse = $core_v2_forum.Get($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintForum IdRequired

Return Type

Forum

Get

Gets a forum

Usage

#set($forumResponse = $core_v2_forum.Get($applicationId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
applicationIdGuidForum Application IdRequired

Return Type

Forum

IsFavorite

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

Usage

#set($booleanResponse = $core_v2_forum.IsFavorite($forumId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired

Return Type

bool

IsSubscribed

Returns subscribed status for the accessing user

Usage

#set($booleanResponse = $core_v2_forum.IsSubscribed($forumId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired

Return Type

bool

List

Lists forums

Usage

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

Return Type

PagedList<Forum>

List

Lists forums

Usage

#set($pagedListResponse = $core_v2_forum.List("%{ApplicationIds = $applicationIdsArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, PermissionId = $permissionIdArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
ApplicationIdsstringUsed to limit to a specific set of forums as well as sort order if SoryBy is set to ApplicationIdsOrderOptional
GroupIdintGroup IdOptional
IncludeSubGroupsboolOnly used when GroupId is specified.OptionalFalse
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
PermissionIdstringPermission IdOptional
SortBystringSort ByOptionalSortOrderApplicationIdsOrder, DateCreated, LastPost, Name, Post, Score:SCORE_ID, SortOrder, Thread, TotalPosts
SortOrderstringSort OrderOptionalAscendingAscending, Descending
UserIdintObsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user insteadOptional

Return Type

PagedList<Forum>

ListForQuickPost

Lists forums available for a quick post context for the accessing user and current group

Usage

#set($iListResponse = $core_v2_forum.ListForQuickPost())

Return Type

IList<Forum>

ListTaggedContent

Obsolete. $core_v2_forum.ListTaggedContent() is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.

Lists tagged content. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_taggedContent.List() should be used if possible.

Usage

#set($pagedListResponse = $core_v2_forum.ListTaggedContent($tags, "%{ForumId = $forumIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList<string>TagsRequired
ForumIdintForum IdOptional
GroupIdintGroup IdOptional
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20

Return Type

PagedList<TaggedContent>

ListTags

Obsolete. $core_v2_forum.ListTags() is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

Lists tags in a forum. DEPRECATED: This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

Usage

#set($pagedListResponse = $core_v2_forum.ListTags("%{FilterTags = $filterTagsArg, ForumId = $forumIdArg, GroupId = $groupIdArg, MinimumItemsPerTag = $minimumItemsPerTagArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
FilterTagsIList<string>Tags to filter byOptional
ForumIdintForum IdOptional
GroupIdintGroup IdOptional
MinimumItemsPerTagintMinimum Items Per TagOptional
PageIndexintPage IndexOptional0
PageSizeintPage SizeOptional100

Return Type

PagedList<tag>

MarkAllRead

Marks all threads in a forum as read for the accessing user

Usage

$core_v2_forum.MarkAllRead($forumId, $read)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
readboolRead StatusRequired

Search

Searches forums

Usage

#set($pagedListResponse = $core_v2_forum.Search($queryText, "%{GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextstringSearch QueryRequired
GroupIdintGroup IdOptional
IncludeSubGroupsboolInclude 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

Return Type

PagedList<SearchResult>

SetFavorite

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

Usage

$core_v2_forum.SetFavorite($forumId, $favorite)

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
favoriteboolFavorite StatusRequired

SetSubscribed

Sets subscribed status for the accessing user

Usage

#set($additionalInfoResponse = $core_v2_forum.SetSubscribed($forumId, $subscribe))

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired
subscribeboolSubscribed StatusRequired

Return Type

AdditionalInfo

SubscriptionType

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

Usage

#set($stringResponse = $core_v2_forum.SubscriptionType($forumId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
forumIdintForum IdRequired

Return Type

string

Update

Updates a forum

Usage

#set($forumResponse = $core_v2_forum.Update($id, "%{AllowedThreadTypes = $allowedThreadTypesArg, AutoLockingDefaultInterval = $autoLockingDefaultIntervalArg, AutoLockingEnabled = $autoLockingEnabledArg, DefaultThreadType = $defaultThreadTypeArg, Description = $descriptionArg, EmailFooter = $emailFooterArg, Enabled = $enabledArg, EnableMailingList = $enableMailingListArg, EnablePassiveMode = $enablePassiveModeArg, EnablePostPoints = $enablePostPointsArg, EnablePostStatistics = $enablePostStatisticsArg, EnableQualityVoting = $enableQualityVotingArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, IndexPosts = $indexPostsArg, Key = $keyArg, MailingListAddress = $mailingListAddressArg, MailingListName = $mailingListNameArg, ModeratePosts = $moderatePostsArg, Name = $nameArg, PassiveModeAddress = $passiveModeAddressArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintForum IdRequired
AllowedThreadTypesstringA comma separated list of thread types supported.OptionalDiscussion, QuestionAndAnswer
AutoLockingDefaultIntervalintThe number of days before a thread is automatically locked when the Forum Auto-Locking plugin is enabled. If not specified and auto-locking is enabled, the plugin's configuration value is used.Optional
AutoLockingEnabledboolTurns on auto locking of threads according to the configuration of the Forum Auto Locking plugin if it is enabled.OptionalFalse
DefaultThreadTypestringThe default thread type for the forum if both QuestionAndAnswer and Discussion threads are allowedOptionalDiscussion, QuestionAndAnswer
DescriptionstringDescriptionOptional
EmailFooterstringEmail FooterOptional
EnabledboolEnabledOptional
EnableMailingListboolEnable Mailing ListOptional
EnablePassiveModeboolEnable Passive ModeOptional
EnablePostPointsboolObsolete in 10.0. This option is no longer used.OptionalTrue
EnablePostStatisticsboolEnable Post StatisticsOptional
EnableQualityVotingboolEnable Quality VotingOptionalFalse
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
GroupIdintGroup IdOptional
IndexPostsboolIndex PostsOptional
KeystringString identifier uniquely identifying a forum within its containing group. Used in the url. If unspecified, will be auto-generated based on the NameOptional
MailingListAddressstringMailing List Address. Required if EnableMailingList is trueOptional
MailingListNamestringMailing List Name. Required if EnableMailingList is trueOptional
ModeratePostsboolModerate PostsOptional
NamestringNameOptional
PassiveModeAddressstringPassive Mode Address. Required if EnablePassiveMode is true.Optional

Return Type

Forum


  • 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