core_v2_theme Script API

Verint | Telligent Community — Wed, 14 May 2025 17:08:26 GMT

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

Enables scripted content fragments to get contextual and configuration data related to the theme.

Methods

GetBoolValue

Returns the boolean theme configuration value specified by the property name

Velocity

#set($booleanResponse = $core_v2_theme.GetBoolValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var booleanResponse = core_v2_theme.GetBoolValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Boolean Script API Type\|Boolean]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Boolean Script API Type|Boolean]]

GetColorValue

Returns the color theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetColorValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetCustomValue

Returns the custom theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetCustomValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetDateTimeValue

Returns the DateTime theme configuration value specified by the property name

Velocity

#set($dateTimeResponse = $core_v2_theme.GetDateTimeValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var dateTimeResponse = core_v2_theme.GetDateTimeValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[DateTime Script API Type\|DateTime]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[DateTime Script API Type|DateTime]]

GetDoubleValue

Returns the double theme configuration value specified by the property name

Velocity

#set($numberResponse = $core_v2_theme.GetDoubleValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var numberResponse = core_v2_theme.GetDoubleValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Number Script API Type|Number]]

GetGuidValue

Returns the Guid theme configuration value specified by the property name

Velocity

#set($guidResponse = $core_v2_theme.GetGuidValue($propertyName, $inheritanceDepth))

JavaScript

var guidResponse = core_v2_theme.GetGuidValue(propertyName, inheritanceDepth);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Guid Script API Type|Guid]]

GetHtmlValue

Returns the HTML theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetHtmlValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetIntValue

Returns the integer theme configuration value specified by the property name

Velocity

#set($numberResponse = $core_v2_theme.GetIntValue($propertyName, $defaultValue, $inheritanceDepth))

JavaScript

var numberResponse = core_v2_theme.GetIntValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Number Script API Type|Number]]

GetPaletteColorValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteColorValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteColorValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`[[String Script API Type\|String]]`	Palette Type Id	Required
paletteId	`[[String Script API Type\|String]]`	Palette Id	Required
valueId	`[[String Script API Type\|String]]`	Value Id	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetPaletteDoubleValue

Velocity

#set($numberResponse = $core_v2_theme.GetPaletteDoubleValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var numberResponse = core_v2_theme.GetPaletteDoubleValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`[[String Script API Type\|String]]`	Palette Type Id	Required
paletteId	`[[String Script API Type\|String]]`	Palette Id	Required
valueId	`[[String Script API Type\|String]]`	Value Id	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Number Script API Type|Number]]

GetPaletteIntValue

Velocity

#set($numberResponse = $core_v2_theme.GetPaletteIntValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var numberResponse = core_v2_theme.GetPaletteIntValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`[[String Script API Type\|String]]`	Palette Type Id	Required
paletteId	`[[String Script API Type\|String]]`	Palette Id	Required
valueId	`[[String Script API Type\|String]]`	Value Id	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[Number Script API Type|Number]]

GetPaletteStringValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteStringValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteStringValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`[[String Script API Type\|String]]`	Palette Type Id	Required
paletteId	`[[String Script API Type\|String]]`	Palette Id	Required
valueId	`[[String Script API Type\|String]]`	Value Id	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetPaletteUnitValue

Velocity

#set($stringResponse = $core_v2_theme.GetPaletteUnitValue($paletteTypeId, $paletteId, $valueId, $defaultValue, $inheritanceDepth))

JavaScript

var stringResponse = core_v2_theme.GetPaletteUnitValue(paletteTypeId, paletteId, valueId, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
paletteTypeId	`[[String Script API Type\|String]]`	Palette Type Id	Required
paletteId	`[[String Script API Type\|String]]`	Palette Id	Required
valueId	`[[String Script API Type\|String]]`	Value Id	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetStringValue

Returns the string theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetStringValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetUnitValue

Returns the Unit theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetUnitValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

GetUrlListValue

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

Velocity

#set($listResponse = $core_v2_theme.GetUrlListValue($propertyName, $inheritanceDepth))

JavaScript

var listResponse = core_v2_theme.GetUrlListValue(propertyName, inheritanceDepth);

Parameters

Name	Type	Description	Required	Default	Options
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[List Script API Type|List]] of [[String Script API Type|String]]

GetUrlValue

Returns the URL theme configuration value specified by the property name

Velocity

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

JavaScript

var stringResponse = core_v2_theme.GetUrlValue(propertyName, defaultValue, inheritanceDepth);

Parameters

Name	Type	Description	Required
propertyName	`[[String Script API Type\|String]]`	Property Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required
inheritanceDepth	`[[Number Script API Type\|Number]]`	Inheritance Depth	Required

Returns

[[String Script API Type|String]]

ToString

Velocity

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

JavaScript

var stringResponse = core_v2_theme.ToString();

Returns

[[String Script API Type|String]]