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


Enables scripted content fragments to use Groups

Properties

NameTypeDescriptionDefaultOptions
ApplicationTypeIdGuidGroups application type identifier
ContainerTypeIdGuidGroups container type identifier
ContentTypeIdGuidGroups content type identifier
CurrentGroupCurrent contextual group
CurrentGroupPathIList<Group>Lists all parent groups of the current group, excluding the current group. Sorted from furthest to nearest ancestor.
Default ObsoleteGroup(OBSOLETE) Default Group
RootGroupSite root group
ThemeTypeIdGuidGroups theme type identifier
TotalLicensedRemainingintTotal number licensed groups

Methods

Create

Creates a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringNameRequired
groupTypestringGroup TypeRequired

Return Type

Group

Create

Creates a group

Usage

#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}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
namestringNameRequired
groupTypestringGroup TypeRequiredJoinless, PrivateListed, PrivateUnlisted, PublicClosed, PublicOpen
AutoCreateApplicationsboolAuto Create ApplicationsOptionalTrue
AvatarFileDatastringAvatar File Data. When adding an image either FileData or FileUploadContext is required.Optional
AvatarFileNamestringAvatar File Name. Required when updating featured item using FileUploadContext. Optional parameterOptional
AvatarFileUploadContextstringAvatar File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameterOptional
DescriptionstringDescriptionOptional
EnableGroupMessagesboolEnable 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
ParentGroupIdintParent Group IdOptional

Return Type

Group

Delete

Deletes a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired

Return Type

AdditionalInfo

Delete

Deletes a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired
deleteApplicationsbool?Set to true if you want to delete child applications along with the group.RequiredFalse

Return Type

AdditionalInfo

Get

Gets a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
ContainerIdGuidContainerId, Id, or Key + ParentGroupId is required.Optional
IdintContainerId, Id, or Key + ParentGroupId is required.Optional
KeystringContainerId, Id, or Key + ParentGroupId is required.Optional
ParentGroupIdintContainerId, Id, or Key + ParentGroupId is required.Optional

Return Type

Group

Get

Gets a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
containerIdGuidContainer IdRequired

Return Type

Group

HasNewPostLinks

Returns whether a group has new post links

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintGroup IdRequired

Return Type

bool

IsFavorite

Returns favorite status for the accessing user

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired

Return Type

bool

IsGroupMember

Determines if a user is a membber of a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
groupIdintGroup IdRequired
userIdintUser IdRequired

Return Type

bool

List

Lists groups

Usage

#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}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
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
IncludeAllSubGroupsboolUsed when getting child groups, will return all subgroups recursively.Optional
IncludePendingMembershipsboolWhen getting groups for a user, include groups where user has PendingMembershipOptional
PageIndexintSpecify the page number of paged results to return. Zero-based index.Optional0
PageSizeintSpecify the number of results to return per page.Optional20
ParentGroupIdintSetting 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
UserIdintUser ID to check permissions. This option is only used whenever the PermissionId is also supplied.Optional
UsernamestringUsernameOptional

Return Type

PagedList<Group>

ListNewPostLinks

Returns new post links for a group

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintGroup IdRequired

Return Type

IList<GroupNewPostLink>

ListTaggedContent

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

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
tagsIList<string>TagsRequired
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_group.ListTags() is supported for backwards compatibility, but $core_v2_tags.List() should be used if possible.

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

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
FilterTagsIList<string>Filter TagsOptional
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<tag>

Search

Searches groups

Usage

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

Parameters

NameTypeDescriptionRequiredDefaultOptions
queryTextstringQuery TextRequired
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

Usage

$core_v2_group.SetFavorite($id, $favorite)

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired
favoriteboolFavoriteRequired

Update

Updates a group

Usage

#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}"))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idintIdRequired
AvatarFileDatastringAvatar File Data. When adding an image either FileData or FileUploadContext is required.Optional
AvatarFileNamestringAvatar File Name. Required when updating featured item using FileUploadContext. Optional parameterOptional
AvatarFileUploadContextstringAvatar File Upload Context. When adding an image either FileData or FileUploadContext is required. Optional parameterOptional
DescriptionstringDescriptionOptional
EnableContactFormboolEnable Contact FormOptional
EnableGroupMessagesboolEnable 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
ParentGroupIdintParent Group IdOptional
RemoveAvatarImageboolIf, true uploaded avatar image will be removed and default avatar will be used.Optional

Return Type

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 2021 Verint, Inc.
Powered by Verint Community