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


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

  • Properties
  • ApplyTokens
  • ClearValue
  • ExecuteEmbeddedFile
  • ExecuteFile
  • GetBoolValue
  • GetColorValue
  • GetCustomValue
  • GetDateTimeValue
  • GetDoubleValue
  • GetEmbeddedFile
  • GetEmbeddedFileByUrl
  • GetEmbeddedFiles
  • GetExecutedEmbeddedFileUrl
  • GetExecutedFileUrl
  • GetExecutionParameterValue
  • GetExecutionParameterValues
  • GetFileDataUrl
  • GetFileUrl
  • GetGuidValue
  • GetHtmlValue
  • GetIntValue
  • GetScheduledFileStatus
  • GetStringValue
  • GetUnitValue
  • GetUrlListValue
  • GetUrlValue
  • Hide
  • RenderEmbeddedFile
  • RenderFile
  • ScheduleFile
  • SetBoolValue
  • SetColorValue
  • SetCustomValue
  • SetDateTimeValue
  • SetDoubleValue
  • SetGuidValue
  • SetHtmlValue
  • SetIntValue
  • SetStringValue
  • SetUnitValue
  • SetUrlListValue
  • SetUrlValue
  • UniqueId

Properties

NameAccessTypeDescription
IsInWidgetPreviewModeReadBooleanReturns true when the widget's containing page, header, or footer is being edited
RegionNameReadStringName of the current widget's region
WrapperElementIdReadStringDOM Id of the current widget's wrapper element

Methods

ApplyTokens

Process tokens, such as resources, in a string

Velocity

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

JavaScript

var stringResponse = core_v2_widget.ApplyTokens(html);

Parameters

NameTypeDescriptionRequiredDefaultOptions
htmlStringHtmlRequired

Returns

String

ClearValue

Removes the configured value for a property.

Velocity

$core_v2_widget.ClearValue($propertyName)

JavaScript

core_v2_widget.ClearValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

Returns

Nothing

ExecuteEmbeddedFile

Velocity

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

JavaScript

var stringResponse = core_v2_widget.ExecuteEmbeddedFile(propertyName, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
fileNameStringFile NameRequired

Returns

String

ExecuteFile

ExecuteFile Overload 1

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

Velocity

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

JavaScript

var objectResponse = core_v2_widget.ExecuteFile(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of attached widget scriptRequired

ExecuteFile Overload 2

Loads, executes, and returns the content of an attached widget script file. If any execution options are defined, the result will not support interaction--objects returned from JavaScript will not support setting properties or executing functions.

Velocity

#set($objectResponse = $core_v2_widget.ExecuteFile($fileName, "%{ DisableAbuseChecking = $disableAbuseCheckingArg, DisableActivityStories = $disableActivityStoriesArg, DisableNotifications = $disableNotificationsArg, Parameters = $parametersArg, RunAsServiceUser = $runAsServiceUserArg, RunAsUserName = $runAsUserNameArg }"))

JavaScript

var objectResponse = core_v2_widget.ExecuteFile(fileName, { DisableAbuseChecking: disableAbuseCheckingArg, DisableActivityStories: disableActivityStoriesArg, DisableNotifications: disableNotificationsArg, Parameters: parametersArg, RunAsServiceUser: runAsServiceUserArg, RunAsUserName: runAsUserNameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of attached widget scriptRequired
optionsOptionsSet of optional parameters including:Required
DisableAbuseCheckingBooleanDisables abuse checking while executing the fileOptionalFalse
DisableActivityStoriesBooleanDisables activity story creation while executing the fileOptionalFalse
DisableNotificationsBooleanDisables notification creation while executing the fileOptionalFalse
ParametersIDictionaryDictionary of parameters to provide to the widget script being executed. Parameters are available through the GetExecutionParameterValue and GetExecutionParameterValues methods.Optional
QueryStringQueryString of parameters to provide to the widget script being executed. Parameters are available through the GetExecutionParameterValue and GetExecutionParameterValues methods.
RunAsServiceUserBooleanExecutes the file as the service user (with full permissions)OptionalFalse
RunAsUserNameStringThe username of the user to execute the file asOptional

Returns

Object

GetBoolValue

GetBoolValue Overload 1

Returns the boolean widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetBoolValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

GetBoolValue Overload 2

Returns the boolean widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetBoolValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueBooleanDefault ValueRequired

Returns

Nullable of Boolean

GetColorValue

Returns the color widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetColorValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

GetCustomValue

Returns the custom widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetCustomValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

GetDateTimeValue

GetDateTimeValue Overload 1

Returns the DateTime widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetDateTimeValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

GetDateTimeValue Overload 2

Returns the DateTime widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetDateTimeValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueDateTimeDefault ValueRequired

Returns

Nullable of DateTime

GetDoubleValue

GetDoubleValue Overload 1

Returns the double widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetDoubleValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

GetDoubleValue Overload 2

Returns the double widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetDoubleValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueDoubleDefault ValueRequired

Returns

Nullable of Double

GetEmbeddedFile

Velocity

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

JavaScript

var fileResponse = core_v2_widget.GetEmbeddedFile(propertyName, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
fileNameStringFile NameRequired

Returns

File

GetEmbeddedFileByUrl

Velocity

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

JavaScript

var fileResponse = core_v2_widget.GetEmbeddedFileByUrl(propertyName, url);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
urlStringUrlRequired

Returns

File

GetEmbeddedFiles

Velocity

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

JavaScript

var iEnumerableResponse = core_v2_widget.GetEmbeddedFiles(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

Returns

IEnumerable of File

GetExecutedEmbeddedFileUrl

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetExecutedEmbeddedFileUrl(propertyName, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
fileNameStringFile NameRequired

Returns

String

GetExecutedFileUrl

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

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetExecutedFileUrl(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of attached widget scriptRequired

Returns

String

GetExecutionParameterValue

Gets an execution parameter value

Velocity

#set($stringResponse = $core_v2_widget.GetExecutionParameterValue($name))

JavaScript

var stringResponse = core_v2_widget.GetExecutionParameterValue(name);

Parameters

NameTypeDescriptionRequiredDefaultOptions
nameStringParameter value keyRequired

Returns

String

GetExecutionParameterValues

Gets all execution parameter values matching a key

Velocity

#set($stringResponse = $core_v2_widget.GetExecutionParameterValues($name))

JavaScript

var stringResponse = core_v2_widget.GetExecutionParameterValues(name);

Parameters

NameTypeDescriptionRequiredDefaultOptions
nameStringParameter value keyRequired

Returns

Array of String

GetFileDataUrl

GetFileDataUrl Overload 1

Returns the data URL representation of the attachment specified by the file name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetFileDataUrl(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringFile NameRequired

GetFileDataUrl Overload 2

Returns the data URL representation of the attachment specified by the file name

Velocity

#set($stringResponse = $core_v2_widget.GetFileDataUrl($fileName, "%{ MimeType = $mimeTypeArg }"))

JavaScript

var stringResponse = core_v2_widget.GetFileDataUrl(fileName, { MimeType: mimeTypeArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringFile NameRequired
optionsOptionsSet of optional parameters including:Required
MimeTypeStringMime type of file. If not provided, determined by file name.Optional

Returns

String

GetFileUrl

Returns an absolute URL for a given widget attachment

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetFileUrl(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of widget attachmentRequired

Returns

String

GetGuidValue

GetGuidValue Overload 1

Returns the Guid widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetGuidValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

GetGuidValue Overload 2

Returns the Guid widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetGuidValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueGuidDefault ValueRequired

Returns

Nullable of Guid

GetHtmlValue

Returns the HTML widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetHtmlValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

GetIntValue

GetIntValue Overload 1

Returns the integer widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetIntValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

GetIntValue Overload 2

Returns the integer widget configuration value specified by the property name

Velocity

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

JavaScript

var nullableResponse = core_v2_widget.GetIntValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueInt32Default ValueRequired

Returns

Nullable of Int32

GetScheduledFileStatus

GetScheduledFileStatus Overload 1

Retrieves the status of a script execution scheduled with a 'ProgressKey' for reporting its status.

Velocity

#set($scheduledFileStatusResponse = $core_v2_widget.GetScheduledFileStatus($key))

JavaScript

var scheduledFileStatusResponse = core_v2_widget.GetScheduledFileStatus(key);

Parameters

NameTypeDescriptionRequiredDefaultOptions
keyStringIdentifier matching the 'ProgressKey' passed to core_v2_widget.ScheduleFile()Required

GetScheduledFileStatus Overload 2

Retrieves the status of a script execution scheduled with a 'ProgressKey' for reporting its status.

Velocity

#set($scheduledFileStatusResponse = $core_v2_widget.GetScheduledFileStatus($key, "%{ IncludeResult = $includeResultArg, RunAsServiceUser = $runAsServiceUserArg, RunAsUserName = $runAsUserNameArg }"))

JavaScript

var scheduledFileStatusResponse = core_v2_widget.GetScheduledFileStatus(key, { IncludeResult: includeResultArg, RunAsServiceUser: runAsServiceUserArg, RunAsUserName: runAsUserNameArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
keyStringIdentifier matching the 'ProgressKey' passed to core_v2_widget.ScheduleFile()Required
optionsOptionsSet of optional parameters including:Required
IncludeResultBooleanIncludes the completion result, when available.OptionalFalse
RunAsServiceUserBooleanRetrieves the status of the script scheduled for execution by the service userOptionalFalse
RunAsUserNameStringRetrieves the status of the script scheduled for execution by a specific userOptional

Returns

ScheduledFileStatus

GetStringValue

Returns the string widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetStringValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

GetUnitValue

Returns the Unit widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetUnitValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

GetUrlListValue

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

Velocity

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

JavaScript

var iListResponse = core_v2_widget.GetUrlListValue(propertyName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired

Returns

IList of String

GetUrlValue

Returns the URL widget configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_widget.GetUrlValue(propertyName, defaultValue);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
defaultValueStringDefault ValueRequired

Returns

String

Hide

Hides the current widget

Velocity

$core_v2_widget.Hide()

JavaScript

core_v2_widget.Hide();

Returns

Nothing

RenderEmbeddedFile

Velocity

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

JavaScript

var stringResponse = core_v2_widget.RenderEmbeddedFile(propertyName, fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
fileNameStringFile NameRequired

Returns

String

RenderFile

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

Velocity

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

JavaScript

var stringResponse = core_v2_widget.RenderFile(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of widget attachmentRequired

Returns

String

ScheduleFile

ScheduleFile Overload 1

Schedules the execution of an attached widget script to be run on the job server.

Velocity

$core_v2_widget.ScheduleFile($fileName)

JavaScript

core_v2_widget.ScheduleFile(fileName);

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of attached widget scriptRequired

ScheduleFile Overload 2

Schedules the execution of an attached widget script to be run on the job server.

Velocity

$core_v2_widget.ScheduleFile($fileName, "%{ Durable = $durableArg, Parameters = $parametersArg, ProgressKey = $progressKeyArg, RunAsServiceUser = $runAsServiceUserArg, RunAsUserName = $runAsUserNameArg, StartInSeconds = $startInSecondsArg }")

JavaScript

core_v2_widget.ScheduleFile(fileName, { Durable: durableArg, Parameters: parametersArg, ProgressKey: progressKeyArg, RunAsServiceUser: runAsServiceUserArg, RunAsUserName: runAsUserNameArg, StartInSeconds: startInSecondsArg });

Parameters

NameTypeDescriptionRequiredDefaultOptions
fileNameStringName of attached widget scriptRequired
optionsOptionsSet of optional parameters including:Required
DurableBooleanWhen a script file is executed with a 'ProgressKey' for reporting its progress, 'Durable' controls whether the script continues to run if the initiating user disconnects. When 'true', the script file will continue to run if the initiating user disconnects. When 'false', the script file will request cancellation via context_v2_scheduledFile.IsCancellationRequested 5 seconds after the initiating user disconnects without reconnecting.OptionalTrue
ParametersIDictionaryDictionary of parameters to provide to the widget script executed on the job server. Parameters are available through the GetExecutionParameterValue and GetExecutionParameterValues methods.Optional
QueryStringQueryString of parameters to provide to the widget script executed on the job server. Parameters are available through the GetExecutionParameterValue and GetExecutionParameterValues methods.
ProgressKeyStringArbitrary string identifier for the scheduled file which can be used to retrieve its execution status with core_v2_widget.GetScheduledFileStatus() or to render its execution progress with core_v2_ui.ScheduledFile(). Scripts executed with a 'ProgessKey' are also provided the context_v2_scheduldFile API for reporting their progress.Optional
RunAsServiceUserBooleanExecutes the scheduled script as the service user (with full permissions). Results from files executed as the service user are not guaranteed to be returned to non-initiating users.OptionalFalse
RunAsUserNameStringThe username of the user to execute the scheduled script as. Results from files executed as the alternate users are not guaranteed to be returned to non-initiating users.Optional
StartInSecondsInt32Number of seconds to delay before the scheduled script should start.Optional0

Returns

Nothing

SetBoolValue

Sets a boolean widget configuration value

Velocity

$core_v2_widget.SetBoolValue($propertyName, $value)

JavaScript

core_v2_widget.SetBoolValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueBooleanValueRequired

Returns

Nothing

SetColorValue

Sets a Color widget configuration value

Velocity

$core_v2_widget.SetColorValue($propertyName, $value)

JavaScript

core_v2_widget.SetColorValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetCustomValue

Sets a custom widget configuration value

Velocity

$core_v2_widget.SetCustomValue($propertyName, $value)

JavaScript

core_v2_widget.SetCustomValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetDateTimeValue

Sets a DateTime widget configuration value

Velocity

$core_v2_widget.SetDateTimeValue($propertyName, $value)

JavaScript

core_v2_widget.SetDateTimeValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueDateTimeValueRequired

Returns

Nothing

SetDoubleValue

Sets a double widget configuration value

Velocity

$core_v2_widget.SetDoubleValue($propertyName, $value)

JavaScript

core_v2_widget.SetDoubleValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueDoubleValueRequired

Returns

Nothing

SetGuidValue

Sets a guid widget configuration value

Velocity

$core_v2_widget.SetGuidValue($propertyName, $value)

JavaScript

core_v2_widget.SetGuidValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetHtmlValue

Sets an HTML widget configuration value

Velocity

$core_v2_widget.SetHtmlValue($propertyName, $value)

JavaScript

core_v2_widget.SetHtmlValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetIntValue

Sets an integer widget configuration value

Velocity

$core_v2_widget.SetIntValue($propertyName, $value)

JavaScript

core_v2_widget.SetIntValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueInt32ValueRequired

Returns

Nothing

SetStringValue

Sets a string widget configuration value

Velocity

$core_v2_widget.SetStringValue($propertyName, $value)

JavaScript

core_v2_widget.SetStringValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetUnitValue

Sets a unit widget configuration value

Velocity

$core_v2_widget.SetUnitValue($propertyName, $value)

JavaScript

core_v2_widget.SetUnitValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

SetUrlListValue

Sets a URL list widget configuration value

Velocity

$core_v2_widget.SetUrlListValue($propertyName, $value)

JavaScript

core_v2_widget.SetUrlListValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueIList of StringValueRequired

Returns

Nothing

SetUrlValue

Sets a URL widget configuration value

Velocity

$core_v2_widget.SetUrlValue($propertyName, $value)

JavaScript

core_v2_widget.SetUrlValue(propertyName, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyNameStringProperty NameRequired
valueStringValueRequired

Returns

Nothing

UniqueId

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

Velocity

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

JavaScript

var stringResponse = core_v2_widget.UniqueId(id);

Parameters

NameTypeDescriptionRequiredDefaultOptions
idStringNon-unique stringRequired

Returns

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