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


Enables scripted content fragments to use Groups

  • Properties
  • Create
  • Delete
  • Get
  • HasNewPostLinks
  • IsFavorite
  • IsGroupMember
  • List
  • ListNewPostLinks
  • ListTaggedContent
  • ListTags
  • Search
  • SetFavorite
  • Update

Properties

NameAccessTypeDescription
ApplicationTypeIdReadGuidGroups application type identifier
ContainerTypeIdReadGuidGroups container type identifier
ContentTypeIdReadGuidGroups content type identifier
CurrentReadGroupCurrent contextual group
CurrentGroupPathReadIList of GroupLists all parent groups of the current group, excluding the current group. Sorted from furthest to nearest ancestor.
DefaultReadGroup
Obsolete.
(OBSOLETE) Default Group
RootReadGroupSite root group
ThemeTypeIdReadGuidGroups theme type identifier
TotalLicensedRemainingReadInt32Total number licensed groups

Methods

Create

Create Overload 1

Creates a group

Velocity

#set($groupResponse = $core_v2_group.Create($name, $groupType))

JavaScript

var groupResponse = core_v2_group.Create(name, groupType);

Parameters

NameTypeDescriptionRequiredDefaultOptions
nameStringNameRequired
groupTypeStringGroup TypeRequired

Create Overload 2

Creates a group

Velocity

#set($groupResponse = $core_v2_group.Create($name, $groupType, "%{ AutoCreateApplications = $autoCreateApplicationsArg, AvatarFileData = $avatarFileDataArg, AvatarFileName = $avatarFileNameArg, AvatarFileUploadContext = $avatarFileUploadContextArg, Description = $descriptionArg, EnableGroupMessages = $enableGroupMessagesArg, ExtendedAttributes = $extendedAttributesArg, Key = $keyArg, ParentGroupId = $parentGroupIdArg }"))

JavaScript

var groupResponse = core_v2_group.Create(name, groupType, { AutoCreateApplications: autoCreateApplicationsArg, AvatarFileData: avatarFileDataArg, AvatarFileName: avatarFileNameArg, AvatarFileUploadContext: avatarFileUploadContextArg, Description: descriptionArg, EnableGroupMessages: enableGroupMessagesArg, ExtendedAttributes: extendedAttributesArg, Key: keyArg, ParentGroupId: parentGroupIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
nameStringNameRequired
groupTypeStringGroup TypeRequiredJoinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
optionsOptionsSet of optional parameters including:Required
AutoCreateApplicationsBooleanAuto Create ApplicationsOptionalTrue
AvatarFileDataArray of ByteAvatar File Data. When adding an image either FileData or FileUploadContext is required. OBSOLETE in 12: Use AvatarFileUploadContext instead.Optional
AvatarFileNameStringAvatar File Name. Required when updating featured item using AvatarFileUploadContext. Optional parameterOptional
AvatarFileUploadContextStringAvatar File Upload Context. When adding an image either AvatarFileData or AvatarFileUploadContext is required. Optional parameterOptional
DescriptionStringDescriptionOptional
EnableGroupMessagesBooleanEnable Group MessagesOptionalFalse
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 generated.Optional
ParentGroupIdInt32Parent Group IdOptional

Returns

Group

Delete

Delete Overload 1

Deletes a group

Velocity

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

JavaScript

var additionalInfoResponse = core_v2_group.Delete(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired

Delete Overload 2

Deletes a group

Velocity

#set($additionalInfoResponse = $core_v2_group.Delete($id, $deleteApplications))

JavaScript

var additionalInfoResponse = core_v2_group.Delete(id, deleteApplications);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired
deleteApplicationsNullable of BooleanSet to true if you want to delete child applications along with the group.RequiredFalse

Returns

AdditionalInfo

Get

Get Overload 1

Gets a group

Velocity

#set($groupResponse = $core_v2_group.Get("%{ ContainerId = $containerIdArg, Id = $idArg, Key = $keyArg, ParentGroupId = $parentGroupIdArg }"))

JavaScript

var groupResponse = core_v2_group.Get({ ContainerId: containerIdArg, Id: idArg, Key: keyArg, ParentGroupId: parentGroupIdArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ContainerIdGuidContainerId, Id, or Key + ParentGroupId is required.Optional
IdInt32ContainerId, Id, or Key + ParentGroupId is required.Optional
KeyStringContainerId, Id, or Key + ParentGroupId is required.Optional
ParentGroupIdInt32ContainerId, Id, or Key + ParentGroupId is required.Optional

Get Overload 2

Gets a group

Velocity

#set($groupResponse = $core_v2_group.Get($containerId))

JavaScript

var groupResponse = core_v2_group.Get(containerId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
containerIdGuidContainer IdRequired

Returns

Group

HasNewPostLinks

Returns whether a group has new post links

Velocity

#set($booleanResponse = $core_v2_group.HasNewPostLinks($id))

JavaScript

var booleanResponse = core_v2_group.HasNewPostLinks(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Group IdRequired

Returns

Boolean

IsFavorite

Returns favorite status for the accessing user

Velocity

#set($booleanResponse = $core_v2_group.IsFavorite($id))

JavaScript

var booleanResponse = core_v2_group.IsFavorite(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired

Returns

Boolean

IsGroupMember

Determines if a user is a membber of a group

Velocity

#set($booleanResponse = $core_v2_group.IsGroupMember($groupId, $userId))

JavaScript

var booleanResponse = core_v2_group.IsGroupMember(groupId, userId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdInt32Group IdRequired
userIdInt32User IdRequired

Returns

Boolean

List

Lists groups

Velocity

#set($pagedListResponse = $core_v2_group.List("%{ ContainerIds = $containerIdsArg, GroupNameFilter = $groupNameFilterArg, GroupTypes = $groupTypesArg, IncludeAllSubGroups = $includeAllSubGroupsArg, IncludePendingMemberships = $includePendingMembershipsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, ParentGroupId = $parentGroupIdArg, Permission = $permissionArg, SortBy = $sortByArg, SortOrder = $sortOrderArg, UserId = $userIdArg, Username = $usernameArg }"))

JavaScript

var pagedListResponse = core_v2_group.List({ ContainerIds: containerIdsArg, GroupNameFilter: groupNameFilterArg, GroupTypes: groupTypesArg, IncludeAllSubGroups: includeAllSubGroupsArg, IncludePendingMemberships: includePendingMembershipsArg, PageIndex: pageIndexArg, PageSize: pageSizeArg, ParentGroupId: parentGroupIdArg, Permission: permissionArg, SortBy: sortByArg, SortOrder: sortOrderArg, UserId: userIdArg, Username: usernameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
ContainerIdsStringComma separated list of ContainerIds. Used to limit to a specific set of groups as well as sort order if SortBy is set to ContainerIdsOrderOptional
GroupNameFilterStringFilters based on group nameOptional
GroupTypesStringGroup TypesOptionalAll, Joinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
IncludeAllSubGroupsBooleanUsed when getting child groups, will return all subgroups recursively.Optional
IncludePendingMembershipsBooleanWhen getting groups for a user, include groups where user has PendingMembershipOptional
PageIndexInt32Specify the page number of paged results to return. Zero-based index.Optional0
PageSizeInt32Specify the number of results to return per page.Optional20
ParentGroupIdInt32Setting a Parent Group Id returns just the child groups for the group.Optional
PermissionStringUsed to get a list of groups for which the user set in UserId has the provided Permission ID.Optional
SortByStringSort ByOptionalNameContainerIdsOrder, LastUpdate, Name, SortOrder
SortOrderStringSort OrderOptionalAscendingAscending, Descending
UserIdInt32User ID to check permissions. This option is only used whenever the PermissionId is also supplied.Optional
UsernameStringUsernameOptional

Returns

PagedList of Group

ListNewPostLinks

Returns new post links for a group

Velocity

#set($iListResponse = $core_v2_group.ListNewPostLinks($id))

JavaScript

var iListResponse = core_v2_group.ListNewPostLinks(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32Group IdRequired

Returns

IList of GroupNewPostLink

ListTaggedContent

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

Velocity

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

JavaScript

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList of StringTagsRequired
optionsOptionsSet of optional parameters including:Required
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. This method is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

Velocity

#set($pagedListResponse = $core_v2_group.ListTags("%{ FilterTags = $filterTagsArg, GroupId = $groupIdArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_group.ListTags({ FilterTags: filterTagsArg, GroupId: groupIdArg, PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
optionsOptionsSet of optional parameters including:Required
FilterTagsIList of StringFilter TagsOptional
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 Tag

Search

Searches groups

Velocity

#set($pagedListResponse = $core_v2_group.Search($queryText, "%{ PageIndex = $pageIndexArg, PageSize = $pageSizeArg }"))

JavaScript

var pagedListResponse = core_v2_group.Search(queryText, { PageIndex: pageIndexArg, PageSize: pageSizeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextStringQuery TextRequired
optionsOptionsSet of optional parameters including:Required
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 SearchResult

SetFavorite

Sets favorite status for the accessing user

Velocity

$core_v2_group.SetFavorite($id, $favorite)

JavaScript

core_v2_group.SetFavorite(id, favorite);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired
favoriteBooleanFavoriteRequired

Returns

Nothing

Update

Updates a group

Velocity

#set($groupResponse = $core_v2_group.Update($id, "%{ AvatarFileData = $avatarFileDataArg, AvatarFileName = $avatarFileNameArg, AvatarFileUploadContext = $avatarFileUploadContextArg, Description = $descriptionArg, EnableContactForm = $enableContactFormArg, EnableGroupMessages = $enableGroupMessagesArg, ExtendedAttributes = $extendedAttributesArg, GroupType = $groupTypeArg, Key = $keyArg, Name = $nameArg, ParentGroupId = $parentGroupIdArg, RemoveAvatarImage = $removeAvatarImageArg }"))

JavaScript

var groupResponse = core_v2_group.Update(id, { AvatarFileData: avatarFileDataArg, AvatarFileName: avatarFileNameArg, AvatarFileUploadContext: avatarFileUploadContextArg, Description: descriptionArg, EnableContactForm: enableContactFormArg, EnableGroupMessages: enableGroupMessagesArg, ExtendedAttributes: extendedAttributesArg, GroupType: groupTypeArg, Key: keyArg, Name: nameArg, ParentGroupId: parentGroupIdArg, RemoveAvatarImage: removeAvatarImageArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
idInt32IdRequired
optionsOptionsSet of optional parameters including:Required
AvatarFileDataArray of ByteAvatar File Data. When adding an image either AvatarFileData or AvatarFileUploadContext is required. OBSOLETE in 12: Use AvatarFileUploadContext instead.Optional
AvatarFileNameStringAvatar File Name. Required when updating featured item using AvatarFileUploadContext. Optional parameterOptional
AvatarFileUploadContextStringAvatar File Upload Context. When adding an image either AvatarFileData or AvatarFileUploadContext is required. Optional parameterOptional
DescriptionStringDescriptionOptional
EnableContactFormBooleanEnable Contact FormOptional
EnableGroupMessagesBooleanEnable Group MessagesOptional
ExtendedAttributesStringExtended attributes are key-value pairs set using the syntax _ExtendedAttributes_key=value. i.e. _ExtendedAttributes_MyKey=MyValue sets ExtendedAttributes["MyKey"] to "MyValue".Optional
GroupTypeStringGroup TypeOptionalJoinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
KeyStringIf not specified, the key will be generated.Optional
NameStringNameOptional
ParentGroupIdInt32Parent Group IdOptional
RemoveAvatarImageBooleanIf, true uploaded avatar image will be removed and default avatar will be used.Optional

Returns

Group


  • 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