Telligent Community
Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Telligent Community 10.x
  • Verint Community
  • More
Telligent Community 10.x
API Documentation $core_v2_searchResult 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_searchResult Widget Extension


Enables scripted content fragments to use Search

Methods

Create

Usage

#set($searchResultResponse = $core_v2_searchResult.Create($content, $contentId, $contentType, $contentUrl, $date, $roles, $title))

Parameters

Name Type Description Required Default Options
content string Content Required
contentId string Content Id Required
contentType string Content Type Required
contentUrl string Content Url Required
date DateTime Date Required
roles string Roles Required
title string Title Required

Return Type

SearchResult

Create

Usage

#set($searchResultResponse = $core_v2_searchResult.Create($content, $contentId, $contentType, $contentUrl, $date, $roles, $title, "%{Collapse = $collapseArg, CreatedBy = $createdByArg, CustomFields = $customFieldsArg, EditedBy = $editedByArg, GroupId = $groupIdArg, Rating = $ratingArg, SectionId = $sectionIdArg, Tags = $tagsArg, ThreadId = $threadIdArg, UserId = $userIdArg, Username = $usernameArg, WikiId = $wikiIdArg}"))

Parameters

Name Type Description Required Default Options
content string Content Required
contentId string Content Id Required
contentType string Content Type Required
contentUrl string Content Url Required
date DateTime Date Required
roles string Roles Required
title string Title Required
Collapse bool Collapse Optional
CreatedBy string Created By Optional
CustomFields List<SearchField> Custom Fields Optional
EditedBy string Edited By Optional
GroupId int Group Id Optional
Rating double Rating Optional
SectionId int Section Id Optional
Tags string Tags Optional
ThreadId int Thread Id Optional
UserId int User Id Optional
Username string Username Optional
WikiId int Wiki Id Optional

Return Type

SearchResult

Delete

Usage

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

Parameters

Name Type Description Required Default Options
id string Id Required

Return Type

AdditionalInfo

Get

Get a SearchResult by Id

Usage

#set($searchResultResponse = $core_v2_searchResult.Get($id))

Parameters

Name Type Description Required Default Options
id string Id Required

Return Type

SearchResult

GetRelatedContent

Searches for related content

Usage

#set($searchResultsResponse = $core_v2_searchResult.GetRelatedContent($searchUniqueId))

Parameters

Name Type Description Required Default Options
searchUniqueId string An entity's unique search id, available as a property of entities Required

Return Type

SearchResults

GetRelatedContent

Searches for related content

Usage

#set($searchResultsResponse = $core_v2_searchResult.GetRelatedContent($searchUniqueId, "%{Filters = $filtersArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Sort = $sortArg}"))

Parameters

Name Type Description Required Default Options
searchUniqueId string An entity's unique search id, available as a property of entities Required
Filters string Filters. Optional
PageIndex int Specify the page number of paged results to return. Zero-based index. Optional 0
PageSize int Specify the number of results to return per page. Optional 20
Sort string Sort Optional date, date asc, date desc, titlesort, titlesort asc, titlesort desc

Return Type

SearchResults

IsSearchable

Usage

#set($booleanResponse = $core_v2_searchResult.IsSearchable($contentTypeId))

Parameters

Name Type Description Required Default Options
contentTypeId Guid Content Type Id Required

Return Type

bool

List

Perform a search with query parameters.

Usage

#set($searchResultsResponse = $core_v2_searchResult.List("%{ApplicationId = $applicationIdArg, Collapse = $collapseArg, ContainerId = $containerIdArg, DateRangeFacets = $dateRangeFacetsArg, DateRangeFilters = $dateRangeFiltersArg, EndDate = $endDateArg, FieldFacets = $fieldFacetsArg, FieldFilters = $fieldFiltersArg, Filters = $filtersArg, IsApplication = $isApplicationArg, IsContainer = $isContainerArg, IsContent = $isContentArg, LogicallyOrTags = $logicallyOrTagsArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, Query = $queryArg, Sort = $sortArg, StartDate = $startDateArg, Tags = $tagsArg}"))

Parameters

Name Type Description Required Default Options
ApplicationId Guid Application Id Optional
Collapse bool Collapse Optional False
ContainerId Guid Container Id Optional
DateRangeFacets string Date Range Facets. Optional
DateRangeFilters string Date Range Filters. Optional
EndDate DateTime End Date Optional
FieldFacets string Field Facets. Optional
FieldFilters string Field Filters. Optional
Filters string Filters is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. Optional
IsApplication bool Is Application Optional
IsContainer bool Is Container Optional
IsContent bool Is Content Optional
LogicallyOrTags bool Whether to AND or OR tags specified in the Tags parameter. Default is False, logically AND tags. Optional
PageIndex int Specify the page number of paged results to return. Zero-based index. Optional 0
PageSize int Specify the number of results to return per page. Optional 20
Query string Query is not required but you should use either Query or Filters otherwise you'll get all documents in the search index. Optional
Sort string Sort Optional date, date asc, date desc, titlesort, titlesort asc, titlesort desc
StartDate DateTime Start Date Optional
Tags string Comma delimited list of tags. Optional

Return Type

SearchResults

Update

Usage

#set($searchResultResponse = $core_v2_searchResult.Update($id, "%{Collapse = $collapseArg, Content = $contentArg, ContentId = $contentIdArg, ContentType = $contentTypeArg, ContentUrl = $contentUrlArg, CreatedBy = $createdByArg, CustomFields = $customFieldsArg, Date = $dateArg, EditedBy = $editedByArg, GroupId = $groupIdArg, Rating = $ratingArg, Roles = $rolesArg, SectionId = $sectionIdArg, Tags = $tagsArg, ThreadId = $threadIdArg, Title = $titleArg, UserId = $userIdArg, Username = $usernameArg, WikiId = $wikiIdArg}"))

Parameters

Name Type Description Required Default Options
id string Id Required
Collapse bool Collapse Optional
Content string Content Optional
ContentId string Content Id Optional
ContentType string Content Type Optional
ContentUrl string Content Url Optional
CreatedBy string Created By Optional
CustomFields List<SearchField> Custom Fields Optional
Date DateTime Date Optional
EditedBy string Edited By Optional
GroupId int Group Id Optional
Rating double Rating Optional
Roles string Roles Optional
SectionId int Section Id Optional
Tags string Tags Optional
ThreadId int Thread Id Optional
Title string Title Optional
UserId int User Id Optional
Username string Username Optional
WikiId int Wiki Id Optional

Return Type

SearchResult


  • 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