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


Enables scripted content fragments to use BlogPosts

Properties

NameTypeDescriptionDefaultOptions
BlogPostContentViewTypeIdGuidId used to track a view to the a blog post
ContentTypeIdGuidBlog posts content type identifier
CurrentBlogPostReturns the current contextual blog post

Methods

AreRatingsEnabled

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

Usage

#set($booleanResponse = $core_v2_blogPost.AreRatingsEnabled($blogPostId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired

Return Type

bool

Create

Creates a new blog post

Usage

#set($blogPostResponse = $core_v2_blogPost.Create($blogId, $title, $body))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdintBlog IdRequired
titlestringTitleRequired
bodystringBodyRequired

Return Type

BlogPost

Create

Creates a new blog post

Usage

#set($blogPostResponse = $core_v2_blogPost.Create($blogId, $title, $body, "%{ContentType = $contentTypeArg, Excerpt = $excerptArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsApproved = $isApprovedArg, IsFeatured = $isFeaturedArg, MetaDescription = $metaDescriptionArg, MetaKeywords = $metaKeywordsArg, MetaTitle = $metaTitleArg, OpenGraphDescription = $openGraphDescriptionArg, OpenGraphImageContext = $openGraphImageContextArg, OpenGraphImageFileName = $openGraphImageFileNameArg, OpenGraphTitle = $openGraphTitleArg, PostImageFileData = $postImageFileDataArg, PostImageFileName = $postImageFileNameArg, PostImageFileUploadContext = $postImageFileUploadContextArg, PostImageUrl = $postImageUrlArg, PublishedDate = $publishedDateArg, Slug = $slugArg, Tags = $tagsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdintId of parent blogRequired
titlestringTitle of blog postRequired
bodystringContent of blog postRequired
ContentTypestringUsed when adding a post attachement.Optional
ExcerptstringExcerptOptional
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImagestringUsed to include a featured image when IsFeatured is true.Optional
FileDataByte[]When adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNamestringUsed when adding a post attachement.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
IsApprovedboolWhether the moderation state should be approvedOptionalTrue
IsFeaturedboolWhether the post should be featuredOptionalFalse
MetaDescriptionstringDescription used in meta description tag.Optional
MetaKeywordsstringKeywords for the meta keyword tag.Optional
MetaTitlestringTitle used in page's title tag.Optional
OpenGraphDescriptionstringDescription used in Open Graph description tag.Optional
OpenGraphImageContextstringWhen adding a an Open Graph image either OpenGraphImageData or OpenGraphImageContext is required.Optional
OpenGraphImageFileNamestringUsed when adding an Open Graph imageOptional
OpenGraphTitlestringTitle used in Open Graph title tag.Optional
PostImageFileDataByte[]When adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PostImageFileNamestringUsed when adding a post image.Optional
PostImageFileUploadContextstringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PostImageUrlstringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PublishedDateDateTimeIf PublishedDate is not specified it will default to current date/time.Optional
SlugstringIf not specified slug will be automatically created based on post title.Optional
TagsstringA comma separated list of tags.Optional

Return Type

BlogPost

Delete

Deletes a blog post

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintId of the blog postRequired

Return Type

AdditionalInfo

Delete

Deletes a blog post

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintId of the blog postRequired

Return Type

AdditionalInfo

Get

Gets a blog post

Usage

#set($blogPostResponse = $core_v2_blogPost.Get("%{BlogId = $blogIdArg, Id = $idArg, Name = $nameArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
BlogIdintId of the parent blogOptional
IdintEither the Id or the Name (key) is required.Optional
NamestringEither the Id or the Name (key) is required.Optional

Return Type

BlogPost

Get

Gets a blog post

Usage

#set($blogPostResponse = $core_v2_blogPost.Get($contentId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
contentIdGuidContent IdRequired

Return Type

BlogPost

GetRating

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

Usage

#set($ratingResponse = $core_v2_blogPost.GetRating($blogPostId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired

Return Type

Rating

IncrementViewCount

Increments the view count for a blog post

Usage

$core_v2_blogPost.IncrementViewCount($blogPostId)

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired

IsSubscribed

Returns subscribed status for the accessing user

Usage

#set($booleanResponse = $core_v2_blogPost.IsSubscribed($blogPostId, "%{IncludeApplicationSubscriptions = $includeApplicationSubscriptionsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired
IncludeApplicationSubscriptionsboolWhen false, this will only show the subscription status of the content itself, ignorning any application level subscriptions.OptionalTrue

Return Type

bool

IsSubscribed

Returns subscribed status for the accessing user

Usage

#set($booleanResponse = $core_v2_blogPost.IsSubscribed($blogPostId))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired

Return Type

bool

List

Lists blog posts

Usage

#set($pagedListResponse = $core_v2_blogPost.List("%{AuthorId = $authorIdArg, BlogId = $blogIdArg, BlogIds = $blogIdsArg, ContentIds = $contentIdsArg, DateFilter = $dateFilterArg, DateFilterType = $dateFilterTypeArg, GroupId = $groupIdArg, IncludeSubGroups = $includeSubGroupsArg, IncludeUnpublished = $includeUnpublishedArg, LogicallyOrTags = $logicallyOrTagsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, Tags = $tagsArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
AuthorIdintId of authorOptional
BlogIdintBlog to filter by.Optional
BlogIdsstringUsed to filter by a list of blogs. Multiple values are separated with commas.Optional
ContentIdsstringComma separated list of ContentIds. Used to limit to a specific set of blog posts as well as sort order if SoryBy is set to ContentIdsOrderOptional
DateFilterstringA DateTime value used to filter postsOptional
DateFilterTypestringOnly used when using a DateFilter.OptionalDay, Month, Year
GroupIdintGroup to filter by.Optional
IncludeSubGroupsboolOnly used when GroupId is specified.OptionalFalse
IncludeUnpublishedbooldefines whether to include unpublished posts in the response. OptionalFalse
LogicallyOrTagsboolFilter posts by tags with OROptionalFalse
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
SortBystringSort ByOptionalMostRecentContentIdsOrder, MostComments, MostRecent, MostViewed, Score:SCORE_ID
SortOrderstringSort OrderOptionalAscendingAscending, Descending
TagsstringComma separated list of tagsOptional

Return Type

PagedList<BlogPost>

SetRating

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

Usage

$core_v2_blogPost.SetRating($blogPostId, $rating)

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired
ratingintRatingRequired

SetSubscribed

Sets subscribed status for the accessing user

Usage

#set($additionalInfoResponse = $core_v2_blogPost.SetSubscribed($blogPostId, $subscribe))

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogPostIdintBlog Post IdRequired
subscribeboolSubscribed StatusRequired

Return Type

AdditionalInfo

Update

Updates a blog post

Usage

#set($blogPostResponse = $core_v2_blogPost.Update($id, "%{BlogId = $blogIdArg, Body = $bodyArg, ContentType = $contentTypeArg, Excerpt = $excerptArg, ExtendedAttributes = $extendedAttributesArg, FeaturedImage = $featuredImageArg, FileData = $fileDataArg, FileName = $fileNameArg, FileUploadContext = $fileUploadContextArg, FileUrl = $fileUrlArg, IsApproved = $isApprovedArg, IsFeatured = $isFeaturedArg, MetaDescription = $metaDescriptionArg, MetaTitle = $metaTitleArg, OpenGraphDescription = $openGraphDescriptionArg, OpenGraphImageContext = $openGraphImageContextArg, OpenGraphImageFileName = $openGraphImageFileNameArg, OpenGraphTitle = $openGraphTitleArg, PostImageFileData = $postImageFileDataArg, PostImageFileName = $postImageFileNameArg, PostImageFileUploadContext = $postImageFileUploadContextArg, PostImageUrl = $postImageUrlArg, PublishedDate = $publishedDateArg, RemoveAttachment = $removeAttachmentArg, RemoveOpenGraphImage = $removeOpenGraphImageArg, RemovePostImage = $removePostImageArg, Slug = $slugArg, Tags = $tagsArg, Title = $titleArg}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintId of the blog post to updateRequired
BlogIdintId of parent blogOptional
BodystringContent of blog postOptional
ContentTypestringUsed when adding a post attachement.Optional
ExcerptstringExcerptOptional
ExtendedAttributesstringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
FeaturedImagestringUsed to include a featured image when IsFeatured is true.Optional
FileDataByte[]When adding a post attachment either FileData, FileUrl or FileUploadContext is required.Optional
FileNamestringUsed when adding a post attachement.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
IsApprovedboolWhether the moderation state should be approvedOptionalTrue
IsFeaturedboolWhether the post should be featuredOptionalFalse
MetaDescriptionstringDescription used in meta description tag.Optional
MetaTitlestringTitle used in page's title tag.Optional
OpenGraphDescriptionstringDescription used in Open Graph title tag.Optional
OpenGraphImageContextstringWhen adding a an Open Graph image either OpenGraphImageData or OpenGraphImageContext is required.Optional
OpenGraphImageFileNamestringUsed when adding an Open Graph imageOptional
OpenGraphTitlestringTitle used in Open Graph title tag.Optional
PostImageFileDataByte[]When adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PostImageFileNamestringUsed when adding a post image.Optional
PostImageFileUploadContextstringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PostImageUrlstringWhen adding a post attachment either PostImageFileData, PostImageFileUrl or PostImageFileUploadContext is required.Optional
PublishedDateDateTimeIf PublishedDate is not specified it will default to current date/time.Optional
RemoveAttachmentboolWhen true, removes the post's attachmentOptionalFalse
RemoveOpenGraphImageboolWhen true, removes the post's open graph imageOptionalFalse
RemovePostImageboolWhen true, removes the post's imageOptionalFalse
SlugstringIf not specified slug will be automatically created based on post title.Optional
TagsstringA comma separated list of tags.Optional
TitlestringTitle of blog postOptional

Return Type

BlogPost


  • 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