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


Enables scripted content fragments to use Blogs

  • Properties
  • Create
  • CreateContactRequest
  • Delete
  • DeleteContactRequest
  • Get
  • GetContactRequest
  • IsSubscribed
  • List
  • ListContactRequests
  • ListForQuickPost
  • ListTaggedContent
  • ListTags
  • Search
  • SetSubscribed
  • SubscribeAnonymously
  • Update

Properties

NameAccessTypeDescription
ApplicationTypeIdReadGuidBlogs application type identifier
ContentTypeIdReadGuidBlogs content type identifier
CurrentReadBlogCurrent contextual blog
ThemeTypeIdReadGuidBlogs theme type identifier
TotalLicensedRemainingReadInt32Total number licensed blogs remaining.

Methods

Create

Create Overload 1

Creates a new blog

Velocity

#set($blogResponse = $core_v2_blog.Create($groupId, $name))

JavaScript

var blogResponse = core_v2_blog.Create(groupId, name);

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdInt32Group IdRequired
nameStringNameRequired

Create Overload 2

Creates a new blog

Velocity

#set($blogResponse = $core_v2_blog.Create($groupId, $name, "%{ Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, Key = $keyArg }"))

JavaScript

var blogResponse = core_v2_blog.Create(groupId, name, { Authors: authorsArg, DefaultPostImageUrl: defaultPostImageUrlArg, Description: descriptionArg, Enabled: enabledArg, ExtendedAttributes: extendedAttributesArg, Key: keyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdInt32Group in which to create the blogRequired
nameStringName of the blogRequired
optionsOptionsSet of optional parameters including:Required
AuthorsStringComma separated list of usernamesOptional
DefaultPostImageUrlStringDefault Post Image UrlOptional
DescriptionStringDescriptionOptional
EnabledBooleanEnabledOptionalTrue
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
KeyStringIf not specified, the key will be generatedOptional

Returns

Blog

CreateContactRequest

Creates a contact request

Velocity

#set($blogContactRequestResponse = $core_v2_blog.CreateContactRequest($blogId, $subject, $body, $name, $emailAddress, $dateCreated, $ipAddress))

JavaScript

var blogContactRequestResponse = core_v2_blog.CreateContactRequest(blogId, subject, body, name, emailAddress, dateCreated, ipAddress);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
subjectStringSubjectRequired
bodyStringBodyRequired
nameStringNameRequired
emailAddressStringEmail AddressRequired
dateCreatedDateTimeDate CreatedRequired
ipAddressStringIp AddressRequired

Returns

BlogContactRequest

Delete

Deletes a blog

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_blog.Delete(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Blog IdRequired

Returns

AdditionalInfo

DeleteContactRequest

Deletes a contact request

Velocity

#set($additionalInfoResponse = $core_v2_blog.DeleteContactRequest($blogId, $id))

JavaScript

var additionalInfoResponse = core_v2_blog.DeleteContactRequest(blogId, id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
idInt32IdRequired

Returns

AdditionalInfo

Get

Get Overload 1

Gets a blog

Velocity

#set($blogResponse = $core_v2_blog.Get("%{ GroupId = $groupIdArg, Id = $idArg, Key = $keyArg }"))

JavaScript

var blogResponse = core_v2_blog.Get({ GroupId: groupIdArg, Id: idArg, Key: keyArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
GroupIdInt32Either the Id or the Key + GroupId are requiredOptional
IdInt32Either the Id or the Key + GroupId are requiredOptional
KeyStringEither the Id or the Key + GroupId are requiredOptional

Get Overload 2

Gets a blog

Velocity

#set($blogResponse = $core_v2_blog.Get($applicationId))

JavaScript

var blogResponse = core_v2_blog.Get(applicationId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
applicationIdGuidApplication IdRequired

Returns

Blog

GetContactRequest

Gets a contact request

Velocity

#set($blogContactRequestResponse = $core_v2_blog.GetContactRequest($id))

JavaScript

var blogContactRequestResponse = core_v2_blog.GetContactRequest(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired

Returns

BlogContactRequest

IsSubscribed

Returns subscribed status for the accessing user

Velocity

#set($booleanResponse = $core_v2_blog.IsSubscribed($blogId))

JavaScript

var booleanResponse = core_v2_blog.IsSubscribed(blogId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired

Returns

Boolean

List

List Overload 1

Returns a listing of all blogs

Velocity

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

JavaScript

var pagedListResponse = core_v2_blog.List();

List Overload 2

Returns a queried listing of blogs

Velocity

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

JavaScript

var pagedListResponse = core_v2_blog.List({ ApplicationIds: applicationIdsArg, GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, OwnerUserId: ownerUserIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, PermissionId: permissionIdArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserId: userIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ApplicationIdsStringComma separated list of ContentIds. Used to limit to a specific set of blogs as well as sort order if SortBy is set to ApplicationIdsOrderOptional
GroupIdInt32Group IDOptional
IncludeSubGroupsBooleanWhether or not query should include sub-groupsOptional
OwnerUserIdInt32User ID of the owner of the blogs. When this value is present, only blogs where the given user is an owner are returned. The accessing user must specify their own user Id or the accessing user must have impersonation rights.Optional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
PermissionIdStringUsed to get a list of blogs for which the user set in UserId has the provided Permission ID.Optional
SortByStringAttribute to order the resultsOptionalApplicationIdsOrder, MostComments, MostRecent, MostViewed
SortOrderStringDirection to sort the resultsOptionalAscendingAscending, Descending
UserIdInt32Obsolete in 9.2: User Id should no longer be used. Rely on the authenticated or impersonated user instead.Optional

Returns

PagedList of Blog

ListContactRequests

ListContactRequests Overload 1

Lists contact requests

Velocity

#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId))

JavaScript

var pagedListResponse = core_v2_blog.ListContactRequests(blogId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired

ListContactRequests Overload 2

Lists contact requests

Velocity

#set($pagedListResponse = $core_v2_blog.ListContactRequests($blogId, "%{ IsModerated = $isModeratedArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_blog.ListContactRequests(blogId, { IsModerated: isModeratedArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
optionsOptionsSet of optional parameters including:Required
IsModeratedBooleanIs ModeratedOptionalFalse
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20

Returns

PagedList of BlogContactRequest

ListForQuickPost

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

Velocity

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

JavaScript

var iListResponse = core_v2_blog.ListForQuickPost();

Returns

IList of Blog

ListTaggedContent

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

Velocity

#set($pagedListResponse = $core_v2_blog.ListTaggedContent($tags, "%{ BlogId = $blogIdArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_blog.ListTaggedContent(tags, { BlogId: blogIdArg, GroupId: groupIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList of StringTagsRequired
optionsOptionsSet of optional parameters including:Required
BlogIdInt32Blog IdOptional
GroupIdInt32Group IdOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20

Returns

PagedList of TaggedContent

ListTags

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

Velocity

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

JavaScript

var pagedListResponse = core_v2_blog.ListTags({ BlogId: blogIdArg, FilterTags: filterTagsArg, GroupId: groupIdArg, MinimumItemsPerTag: minimumItemsPerTagArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
BlogIdInt32Blog IdOptional
FilterTagsIList of StringTags to filter byOptional
GroupIdInt32Group IdOptional
MinimumItemsPerTagInt32Minimum Items Per TagOptional
PageIndexInt32Page IndexOptional0
PageSizeInt32Page SizeOptional100

Returns

PagedList of Tag

Search

Performs a blog search

Velocity

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

JavaScript

var pagedListResponse = core_v2_blog.Search(queryText, { GroupId: groupIdArg, IncludeSubGroups: includeSubGroupsArg, PageIndex: pageIndexArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextStringQuery TextRequired
optionsOptionsSet of optional parameters including:Required
GroupIdGroup IdOptional
IncludeSubGroupsInclude Sub GroupsOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0

Returns

PagedList of SearchResult

SetSubscribed

Sets subscribed status for the accessing user

Velocity

#set($additionalInfoResponse = $core_v2_blog.SetSubscribed($blogId, $subscribe))

JavaScript

var additionalInfoResponse = core_v2_blog.SetSubscribed(blogId, subscribe);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
subscribeBooleanSubscribed StatusRequired

Returns

AdditionalInfo

SubscribeAnonymously

Velocity

#set($nullableResponse = $core_v2_blog.SubscribeAnonymously($blogId, $email))

JavaScript

var nullableResponse = core_v2_blog.SubscribeAnonymously(blogId, email);

Parameters

NameTypeDescriptionRequiredDefaultOptions
blogIdInt32Blog IdRequired
emailStringEmailRequired

Returns

Nullable of AnonymousBlogSubscriptionResponse

Update

Updates a blog

Velocity

#set($blogResponse = $core_v2_blog.Update($id, "%{ Authors = $authorsArg, DefaultPostImageUrl = $defaultPostImageUrlArg, Description = $descriptionArg, Enabled = $enabledArg, ExtendedAttributes = $extendedAttributesArg, GroupId = $groupIdArg, Key = $keyArg, Name = $nameArg }"))

JavaScript

var blogResponse = core_v2_blog.Update(id, { Authors: authorsArg, DefaultPostImageUrl: defaultPostImageUrlArg, Description: descriptionArg, Enabled: enabledArg, ExtendedAttributes: extendedAttributesArg, GroupId: groupIdArg, Key: keyArg, Name: nameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired
optionsOptionsSet of optional parameters including:Required
AuthorsStringComma separated list of usernamesOptional
DefaultPostImageUrlStringDefault Post Image UrlOptional
DescriptionStringDescriptionOptional
EnabledBooleanEnabledOptionalTrue
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
GroupIdInt32Group IdOptional
KeyStringIf not specified, the key will be generatedOptional
NameStringNameOptional

Returns

Blog


  • 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