context_v2_propertyRule Script API

Verint | Telligent Community — Wed, 14 May 2025 17:07:25 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 17:07:25

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

Name	Access	Type	Description
Action	Read	`[[String Script API Type\|String]]`	The 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.
CanStoreUrlContents	Read	`[[Boolean Script API Type\|Boolean]]`	Returns 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.
DateFormatString	Read	`[[String Script API Type\|String]]`	The .net format string used to format a DateTime object into a date string.
DateTimeFormatString	Read	`[[String Script API Type\|String]]`	The .net format string used to format a DateTime object into a date-and-time string.
FormId	Read	`[[String Script API Type\|String]]`	The 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'.
InitialValue	Read	`[[Object Script API Type\|Object]]`	The current value of the property. Only available when Action is 'Render'.
Property	Read	`[[Property Script API Type\|Property]]`	The property associated to the rule.
Rule	Read	`[[PropertyRule Script API Type\|PropertyRule]]`	The rule being executed.
SerializedInitialValue	Read	`[[String Script API Type\|String]]`	The current value of the property as serialized value. Only available when Action is 'Render'.
TimeFormatString	Read	`[[String Script API Type\|String]]`	The .net format string used to format a DateTime object into a time string.
UniqueId	Read	`[[String Script API Type\|String]]`	The 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'.
ValidUrlPattern	Read	`[[String Script API Type\|String]]`	The 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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[Nullable Script API Type|Nullable]] of [[Boolean Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[Nullable Script API Type|Nullable]] of [[DateTime Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[Nullable Script API Type|Nullable]] of [[Number Script API Type|Number]]

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[Nullable Script API Type|Nullable]] of [[Guid Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[Nullable Script API Type|Nullable]] of [[Number Script API Type|Number]]

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|String]]

GetUrlListValue

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

Velocity

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

JavaScript

var listResponse = context_v2_propertyRule.GetUrlListValue(propertyId);

Parameters

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[List Script API Type|List]] of [[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
resourceName	`[[String Script API Type\|String]]`	Resource Name	Required
defaultText	`[[String Script API Type\|String]]`	Default Text	Required

Returns

[[String Script API Type|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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[List Script API Type\|List]] of [[String Script API Type\|String]]`	Value	Required

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

Name	Type	Description	Required	Default	Options
propertyId	`[[String Script API Type\|String]]`	Property Id	Required
value	`[[String Script API Type\|String]]`	Value	Required

Returns

Nothing

ToString

Velocity

#set($stringResponse = $context_v2_propertyRule.ToString())

JavaScript

var stringResponse = context_v2_propertyRule.ToString();

Returns

[[String Script API Type|String]]