Verint | Telligent Community
Verint | Telligent Community
  • Site
  • User
  • Site
  • Search
  • User
Verint Community 12.x
  • Verint Community
Verint Community 12.x
API Documentation context_v2_propertyRule 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

context_v2_propertyRule Script API


This extension is only available when rendering a macro as a custom property rule for a configuration property. It is not generally available for use by widgets, embeddables, or automations.

  • Properties
  • ClearValue
  • GetBoolValue
  • GetColorValue
  • GetCustomValue
  • GetDataType
  • GetDateTimeValue
  • GetDoubleValue
  • GetGuidValue
  • GetHtmlValue
  • GetIntValue
  • GetStringValue
  • GetUnitValue
  • GetUrlListValue
  • GetUrlValue
  • ResolveResource
  • SetBoolValue
  • SetColorValue
  • SetCustomValue
  • SetDateTimeValue
  • SetDoubleValue
  • SetGuidValue
  • SetHtmlValue
  • SetIntValue
  • SetStringValue
  • SetUnitValue
  • SetUrlListValue
  • SetUrlValue

Properties

NameAccessTypeDescription
ActionReadStringThe purpose of the exection of this property rule. When Action is 'Render', the rule is being executed to be rendered on the client side and an HTML response is required. When Action is 'Execute', the rule is being executed on the server side and no UI is expected.
CanStoreUrlContentsReadBooleanReturns true if the configuration store for this property supports storing referenced URL contents. When URL contents can be stored, local CFS URL references in HTML, Url, UrlList, and configured Custom properties will be saved with this configuration data.
DateFormatStringReadStringThe .net format string used to format a DateTime object into a date string.
DateTimeFormatStringReadStringThe .net format string used to format a DateTime object into a date-and-time string.
FormIdReadStringThe client identifier used by the form. This ID can be used with the dynamicForm jQuery plugin to interace with other properties within the same configuration form. Only available when Action is 'Render'.
InitialValueReadObjectThe current value of the property. Only available when Action is 'Render'.
PropertyReadPropertyThe property associated to the rule.
RuleReadPropertyRuleThe rule being executed.
SerializedInitialValueReadStringThe current value of the property as serialized value. Only available when Action is 'Render'.
TimeFormatStringReadStringThe .net format string used to format a DateTime object into a time string.
UniqueIdReadStringThe unique identifier to use for client rendering. Any additional identifiers required by the rendering of the property should be extended from this one. Only available when Action is 'Render'.
ValidUrlPatternReadStringThe regular expression pattern that can be used to validate a URL.

Methods

ClearValue

Removes the configured value for a property. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.ClearValue($propertyId)

JavaScript

context_v2_propertyRule.ClearValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nothing

GetBoolValue

Returns the boolean widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($nullableResponse = $context_v2_propertyRule.GetBoolValue($propertyId))

JavaScript

var nullableResponse = context_v2_propertyRule.GetBoolValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nullable of Boolean

GetColorValue

Returns the color widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetColorValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetColorValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetCustomValue

Returns the custom widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetCustomValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetCustomValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetDataType

Returns the data type of the requested property. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetDataType($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetDataType(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetDateTimeValue

Returns the DateTime widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($nullableResponse = $context_v2_propertyRule.GetDateTimeValue($propertyId))

JavaScript

var nullableResponse = context_v2_propertyRule.GetDateTimeValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nullable of DateTime

GetDoubleValue

Returns the double widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($nullableResponse = $context_v2_propertyRule.GetDoubleValue($propertyId))

JavaScript

var nullableResponse = context_v2_propertyRule.GetDoubleValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nullable of Double

GetGuidValue

Returns the Guid widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($nullableResponse = $context_v2_propertyRule.GetGuidValue($propertyId))

JavaScript

var nullableResponse = context_v2_propertyRule.GetGuidValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nullable of Guid

GetHtmlValue

Returns the HTML widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetHtmlValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetHtmlValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetIntValue

Returns the integer widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($nullableResponse = $context_v2_propertyRule.GetIntValue($propertyId))

JavaScript

var nullableResponse = context_v2_propertyRule.GetIntValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

Nullable of Int32

GetStringValue

Returns the string widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetStringValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetStringValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetUnitValue

Returns the Unit widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetUnitValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetUnitValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

GetUrlListValue

Returns the URL list widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($iListResponse = $context_v2_propertyRule.GetUrlListValue($propertyId))

JavaScript

var iListResponse = context_v2_propertyRule.GetUrlListValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

IList of String

GetUrlValue

Returns the URL widget configuration value specified by the property name. Only available when Action is 'Execute'.

Velocity

#set($stringResponse = $context_v2_propertyRule.GetUrlValue($propertyId))

JavaScript

var stringResponse = context_v2_propertyRule.GetUrlValue(propertyId);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired

Returns

String

ResolveResource

Resolves a language resource name to a string or defaults to the provided text if the resource is not available.

Velocity

#set($stringResponse = $context_v2_propertyRule.ResolveResource($resourceName, $defaultText))

JavaScript

var stringResponse = context_v2_propertyRule.ResolveResource(resourceName, defaultText);

Parameters

NameTypeDescriptionRequiredDefaultOptions
resourceNameStringResource NameRequired
defaultTextStringDefault TextRequired

Returns

String

SetBoolValue

Sets a boolean widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetBoolValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetBoolValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueNullable of BooleanValueRequired

Returns

Nothing

SetColorValue

Sets a Color widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetColorValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetColorValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetCustomValue

Sets a custom widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetCustomValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetCustomValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetDateTimeValue

Sets a DateTime widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetDateTimeValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetDateTimeValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueNullable of DateTimeValueRequired

Returns

Nothing

SetDoubleValue

Sets a double widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetDoubleValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetDoubleValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueNullable of DoubleValueRequired

Returns

Nothing

SetGuidValue

Sets a guid widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetGuidValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetGuidValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetHtmlValue

Sets an HTML widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetHtmlValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetHtmlValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetIntValue

Sets an integer widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetIntValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetIntValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueNullable of Int32ValueRequired

Returns

Nothing

SetStringValue

Sets a string widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetStringValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetStringValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetUnitValue

Sets a unit widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetUnitValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetUnitValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

SetUrlListValue

Sets a URL list widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetUrlListValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetUrlListValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueIList of StringValueRequired

Returns

Nothing

SetUrlValue

Sets a URL widget configuration value. Only available when Action is 'Execute'.

Velocity

$context_v2_propertyRule.SetUrlValue($propertyId, $value)

JavaScript

context_v2_propertyRule.SetUrlValue(propertyId, value);

Parameters

NameTypeDescriptionRequiredDefaultOptions
propertyIdStringProperty IdRequired
valueStringValueRequired

Returns

Nothing

  • 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