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_wikiPage 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_wikiPage Widget Extension


Enables scripted content fragments to use WikiPages

Properties

NameTypeDescriptionDefaultOptions
CommentSubscriptionTypeIdGuid
ContentTypeIdGuidWiki pages content type identifier
CurrentWikiPageReturns the current contextual wiki page
CurrentOrDefaultWikiPageReturns the current or default wiki page
CurrentPageKeystringCurrent Page Key
CurrentParentWikiPageParent of current wiki page
DefaultWikiPageReturns the default wiki page for the current wiki context

Methods

AreRatingsEnabled

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

Usage

#set($booleanResponse = $core_v2_wikiPage.AreRatingsEnabled($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired

Return Type

bool

Create

Creates a Wiki Page

Usage

#set($wikiPageResponse = $core_v2_wikiPage.Create($wikiId, $title))

Parameters

NameTypeDescriptionRequiredDefaultOptions
wikiIdintWiki IdRequired
titlestringTitleRequired

Return Type

WikiPage

Create

Creates a Wiki Page

Usage

#set($wikiPageResponse = $core_v2_wikiPage.Create($wikiId, $title, "%{Body = $bodyArg, CreatedDate = $createdDateArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, HideInTableOfContents = $hideInTableOfContentsArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, ParentPageId = $parentPageIdArg, Position = $positionArg, Tags = $tagsArg, UserId = $userIdArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
wikiIdintWiki IdRequired
titlestringTitleRequired
BodystringBodyOptional
CreatedDateDateTimeDate wiki page was created.OptionalDateTime.Now
FeaturedImagestringUsed to include a featured image when IsFeatured is true.Optional
ForumThreadIdintRelated Forum ThreadOptional
HideInTableOfContentsboolWhen true this page will not be listed in the table of contents.Optional
IsFeaturedboolIs FeaturedOptionalFalse
IsLockedboolIs LockedOptionalFalse
IsPublishedboolIs PublishedOptionalTrue
MetaDescriptionstringDescription used in meta description tag.Optional
MetaKeywordsstringKeywords for the meta keyword tag.Optional
MetaTitlestringTitle used in page's title tag.Optional
ParentPageIdintParent Page IdOptional
PositionintPosition in the table of contents relative to the parent with the first child being 1 and then increasing sequentially. Only applies to listing the table of contents.Optional
TagsstringA comma separated list of tags.Optional
UserIdintUser IdOptional

Return Type

WikiPage

Delete

Deletes a Wiki Page

Usage

#set($additionalInfoResponse = $core_v2_wikiPage.Delete($wikiPageId, "%{DeleteChildPages = $deleteChildPagesArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
wikiPageIdintWiki Page IdRequired
DeleteChildPagesboolAlso delete any pages with this page as its parent. Optional.OptionalFalse

Return Type

AdditionalInfo

Get

Gets a Wiki Page

Usage

#set($wikiPageResponse = $core_v2_wikiPage.Get("%{ForumThreadId = $forumThreadIdArg, Id = $idArg, PageKey = $pageKeyArg, PageTitle = $pageTitleArg, WikiId = $wikiIdArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
ForumThreadIdintRelated Forum ThreadOptional
IdintEither Id or WikiId and PageTitle should be specified.Optional
PageKeystringObsolete, Either Id or WikiId and PageTitle should be specified.Optional
PageTitlestringEither Id or WikiId and PageTitle should be specified.Optional
WikiIdintWiki IdOptional

Return Type

WikiPage

Get

Gets a Wiki Page

Usage

#set($wikiPageResponse = $core_v2_wikiPage.Get($contentId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Return Type

WikiPage

GetRating

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

Usage

#set($ratingResponse = $core_v2_wikiPage.GetRating($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired

Return Type

Rating

IncrementViewCount

Increments the view count on the wiki page

Usage

$core_v2_wikiPage.IncrementViewCount($id)

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired

IsSubscribed

Returns subscribed status for the accessing user

Usage

#set($booleanResponse = $core_v2_wikiPage.IsSubscribed($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired

Return Type

bool

List

Lists Wiki Pages

Usage

#set($pagedListResponse = $core_v2_wikiPage.List($wikiId, "%{AuthorId = $authorIdArg, ContentIds = $contentIdsArg, GroupId = $groupIdArg, IncludeSubGroupContent = $includeSubGroupContentArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentPageId = $parentPageIdArg, QueryType = $queryTypeArg, ShowHiddenInTableOfContents = $showHiddenInTableOfContentsArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Tags = $tagsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
wikiIdintWiki IdRequired
AuthorIdintAuthor IdOptional
ContentIdsstringComma separated list of ContentIds. Used to limit to a specific set of wiki pages as well as sort order if SoryBy is set to ContentIdsOrderOptional
GroupIdintGroup IdOptional
IncludeSubGroupContentboolInclude Sub Group ContentOptionalFalse
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
ParentPageIdintParent Page IdOptional
QueryTypestringQuery TypeOptionalAll, AllByTags, New, Updated
ShowHiddenInTableOfContentsboolWhen true the list will only show items with their HiddenInTableOfContents flag set to true. When false they are excluded. Not specifying a value will show both.Optional
SortBystringSort ByOptionalDateContentIdsOrder, Date, Score:SCORE_ID, LastUpdatedDate, Title
SortOrderstringSort OrderOptionalDescendingAscending, Descending
TagsstringTagsOptional

Return Type

PagedList<WikiPage>

SetRating

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

Usage

$core_v2_wikiPage.SetRating($id, $rating)

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired
ratingintRating value (0-5)Required

SetSubscribed

Sets subscribed status for the accessing user

Usage

#set($additionalInfoResponse = $core_v2_wikiPage.SetSubscribed($id, $subscribe))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintWiki Page IdRequired
subscribeboolSubscribed StatusRequired

Return Type

AdditionalInfo

Update

Updates a Wiki Page

Usage

#set($wikiPageResponse = $core_v2_wikiPage.Update($id, "%{Body = $bodyArg, FeaturedImage = $featuredImageArg, ForumThreadId = $forumThreadIdArg, HideInTableOfContents = $hideInTableOfContentsArg, IsFeatured = $isFeaturedArg, IsLocked = $isLockedArg, IsPublished = $isPublishedArg, LastModifiedDate = $lastModifiedDateArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, ParentPageId = $parentPageIdArg, Position = $positionArg, SaveRevision = $saveRevisionArg, Tags = $tagsArg, Title = $titleArg, UserId = $userIdArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired
BodystringBodyOptional
FeaturedImagestringUsed to include a featured image when IsFeatured is true.Optional
ForumThreadIdintRelated Forum ThreadOptional
HideInTableOfContentsboolWhen true this page will not be listed in the table of contents.Optional
IsFeaturedboolIs FeaturedOptionalFalse
IsLockedboolIs LockedOptionalFalse
IsPublishedboolIs PublishedOptionalTrue
LastModifiedDateintDate the wiki page was last modifiedOptionalDateTime.Now
MetaDescriptionstringDescription used in meta description tag.Optional
MetaKeywordsstringKeywords for the meta keyword tag.Optional
MetaTitlestringTitle used in page's title tag.Optional
ParentPageIdintParent Page IdOptional
PositionintPosition in the table of contents relative to the parent with the first child being 1 and then increasing sequentially. Only applies to listing the table of contents.Optional
SaveRevisionboolSave RevisionOptionalTrue
TagsstringA comma separated list of tags.Optional
TitlestringTitleOptional
UserIdintUser IdOptional

Return Type

WikiPage


  • 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