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


Enables scripted content fragments to get contextual and configuration data related to the current widget / content fragment.

Properties

NameTypeDescriptionDefaultOptions
IsInWidgetPreviewModeboolReturns true when the widget's containing page, header, or footer is being edited
RegionNamestringName of the current widget's region
WrapperElementIdstringDOM Id of the current widget's wrapper element

Methods

ApplyTokens

Process tokens, such as resources, in a string

Usage

#set($stringResponse = $core_v2_widget.ApplyTokens($html))

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlstringHtmlRequired

Return Type

string

ClearValue

Removes the configured value for a property.

Usage

$core_v2_widget.ClearValue($propertyName)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

ExecuteEmbeddedFile

Usage

#set($stringResponse = $core_v2_widget.ExecuteEmbeddedFile($propertyName, $fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
fileNamestringFile NameRequired

Return Type

string

ExecuteFile

Loads, executes, and returns the content of an attached widget script file

Usage

#set($stringResponse = $core_v2_widget.ExecuteFile($fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNamestringName of attached widget scriptRequired

Return Type

string

GetBoolValue

Returns the boolean widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetBoolValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

bool?

GetBoolValue

Returns the boolean widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetBoolValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValueboolDefault ValueRequired

Return Type

bool?

GetColorValue

Returns the color widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetColorValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

GetCustomValue

Returns the custom widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetCustomValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

GetDateTimeValue

Returns the DateTime widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetDateTimeValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValueDateTimeDefault ValueRequired

Return Type

DateTime?

GetDateTimeValue

Returns the DateTime widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetDateTimeValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

DateTime?

GetDoubleValue

Returns the double widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetDoubleValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

double?

GetDoubleValue

Returns the double widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetDoubleValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuedoubleDefault ValueRequired

Return Type

double?

GetEmbeddedFile

Usage

#set($fileResponse = $core_v2_widget.GetEmbeddedFile($propertyName, $fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
fileNamestringFile NameRequired

Return Type

File

GetEmbeddedFileByUrl

Usage

#set($fileResponse = $core_v2_widget.GetEmbeddedFileByUrl($propertyName, $url))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
urlstringUrlRequired

Return Type

File

GetEmbeddedFiles

Usage

#set($iEnumerableResponse = $core_v2_widget.GetEmbeddedFiles($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

IEnumerable<File>

GetExecutedEmbeddedFileUrl

Usage

#set($stringResponse = $core_v2_widget.GetExecutedEmbeddedFileUrl($propertyName, $fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
fileNamestringFile NameRequired

Return Type

string

GetExecutedFileUrl

Returns an absolute URL for a given widget attachment which, when requested, processes the attachment and reeturns its output

Usage

#set($stringResponse = $core_v2_widget.GetExecutedFileUrl($fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNamestringName of attached widget scriptRequired

Return Type

string

GetFileUrl

Returns an absolute URL for a given widget attachment

Usage

#set($stringResponse = $core_v2_widget.GetFileUrl($fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNamestringName of widget attachmentRequired

Return Type

string

GetGuidValue

Returns the Guid widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetGuidValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

Guid?

GetGuidValue

Returns the Guid widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetGuidValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValueGuidDefault ValueRequired

Return Type

Guid?

GetHtmlValue

Returns the HTML widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetHtmlValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

GetIntValue

Returns the integer widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetIntValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

int?

GetIntValue

Returns the integer widget configuration value specified by the property name

Usage

#set($nullableResponse = $core_v2_widget.GetIntValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValueintDefault ValueRequired

Return Type

int?

GetStringValue

Returns the string widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetStringValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

GetUnitValue

Returns the Unit widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetUnitValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

GetUrlListValue

Returns the URL list widget configuration value specified by the property name

Usage

#set($iListResponse = $core_v2_widget.GetUrlListValue($propertyName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired

Return Type

IList<string>

GetUrlValue

Returns the URL widget configuration value specified by the property name

Usage

#set($stringResponse = $core_v2_widget.GetUrlValue($propertyName, $defaultValue))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
defaultValuestringDefault ValueRequired

Return Type

string

Hide

Hides the current widget

Usage

$core_v2_widget.Hide()

RenderEmbeddedFile

Usage

#set($stringResponse = $core_v2_widget.RenderEmbeddedFile($propertyName, $fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
fileNamestringFile NameRequired

Return Type

string

RenderFile

Loads and returns the content of an attached file without executing it

Usage

#set($stringResponse = $core_v2_widget.RenderFile($fileName))

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNamestringName of widget attachmentRequired

Return Type

string

SetBoolValue

Sets a boolean widget configuration value

Usage

$core_v2_widget.SetBoolValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valueboolValueRequired

SetColorValue

Sets a Color widget configuration value

Usage

$core_v2_widget.SetColorValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetCustomValue

Sets a custom widget configuration value

Usage

$core_v2_widget.SetCustomValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetDateTimeValue

Sets a DateTime widget configuration value

Usage

$core_v2_widget.SetDateTimeValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valueDateTimeValueRequired

SetDoubleValue

Sets a double widget configuration value

Usage

$core_v2_widget.SetDoubleValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuedoubleValueRequired

SetGuidValue

Sets a guid widget configuration value

Usage

$core_v2_widget.SetGuidValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetHtmlValue

Sets an HTML widget configuration value

Usage

$core_v2_widget.SetHtmlValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetIntValue

Sets an integer widget configuration value

Usage

$core_v2_widget.SetIntValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valueintValueRequired

SetStringValue

Sets a string widget configuration value

Usage

$core_v2_widget.SetStringValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetUnitValue

Sets a unit widget configuration value

Usage

$core_v2_widget.SetUnitValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

SetUrlListValue

Sets a URL list widget configuration value

Usage

$core_v2_widget.SetUrlListValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valueIList<string>ValueRequired

SetUrlValue

Sets a URL widget configuration value

Usage

$core_v2_widget.SetUrlValue($propertyName, $value)

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNamestringProperty NameRequired
valuestringValueRequired

UniqueId

Strengthens a given id to be unique across an entire page. Used to explicitly generate safe ids for DOM elements

Usage

#set($stringResponse = $core_v2_widget.UniqueId($id))

Parameters

NameTypeDescriptionRequiredDefaultOptions
idstringNon-unique stringRequired

Return Type

string


  • 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