Calendar Script API Type

Verint | Telligent Community — Wed, 14 May 2025 17:03:19 GMT

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

Content created on the site must implement this interface for the social services to support it.

Properties

Name	Access	Type	Description
ApplicationId	Read, Write	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the application.
CalendarContext	Read, Write	`[[String Script API Type\|String]]`	Calendar Context
CalendarCreateDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Calendar Create Date
CalendarDataToken	Read, Write	`[[String Script API Type\|String]]`	Calendar Data Token
CalendarReferenceId	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Calendar Reference Id
ContentContainerId	Read, Write	`[[Guid Script API Type\|Guid]]`	Content Container Id
ContentId	Read, Write	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the content.
CreatorId	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Creator Id
Description	Read, Write	`[[String Script API Type\|String]]`	Description
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
ExtendedAttributes	Read	`[[ApiList Script API Type\|ApiList]] of [[ExtendedAttribute Script API Type\|ExtendedAttribute]]`	Extended Attributes
Group	Read, Write	`[[Group Script API Type\|Group]]`	Group
Id	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Id
Name	Read, Write	`[[String Script API Type\|String]]`	Name
NodeId	Read, Write	`[[Guid Script API Type\|Guid]]`	Node Id
Url	Read, Write	`[[String Script API Type\|String]]`	A Url to the content on the site.
User	Read, Write	`[[User Script API Type\|User]]`	User
Warnings	Read	`[[List Script API Type\|List]] of [[Warning Script API Type\|Warning]]`	Warnings

Methods

GetExtendedAttributeBool

Velocity

#set($booleanResponse = $calendar.GetExtendedAttributeBool($name, $defaultValue))

JavaScript

var booleanResponse = calendar.GetExtendedAttributeBool(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`[[String Script API Type\|String]]`	Name	Required
defaultValue	`[[Boolean Script API Type\|Boolean]]`	Default Value	Required

Returns

[[Boolean Script API Type|Boolean]]

GetExtendedAttributeDateTime

Velocity

#set($dateTimeResponse = $calendar.GetExtendedAttributeDateTime($name, $defaultValue))

JavaScript

var dateTimeResponse = calendar.GetExtendedAttributeDateTime(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`[[String Script API Type\|String]]`	Name	Required
defaultValue	`[[DateTime Script API Type\|DateTime]]`	Default Value	Required

Returns

[[DateTime Script API Type|DateTime]]

GetExtendedAttributeGuid

Velocity

#set($guidResponse = $calendar.GetExtendedAttributeGuid($name, $defaultValue))

JavaScript

var guidResponse = calendar.GetExtendedAttributeGuid(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`[[String Script API Type\|String]]`	Name	Required
defaultValue	`[[Guid Script API Type\|Guid]]`	Default Value	Required

Returns

[[Guid Script API Type|Guid]]

GetExtendedAttributeInt

Velocity

#set($numberResponse = $calendar.GetExtendedAttributeInt($name, $defaultValue))

JavaScript

var numberResponse = calendar.GetExtendedAttributeInt(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`[[String Script API Type\|String]]`	Name	Required
defaultValue	`[[Number Script API Type\|Number]]`	Default Value	Required

Returns

[[Number Script API Type|Number]]

GetExtendedAttributeString

Velocity

#set($stringResponse = $calendar.GetExtendedAttributeString($name, $defaultValue))

JavaScript

var stringResponse = calendar.GetExtendedAttributeString(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`[[String Script API Type\|String]]`	Name	Required
defaultValue	`[[String Script API Type\|String]]`	Default Value	Required

Returns

[[String Script API Type|String]]

HasErrors

Velocity

#set($booleanResponse = $calendar.HasErrors())

JavaScript

var booleanResponse = calendar.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

#set($booleanResponse = $calendar.HasWarnings())

JavaScript

var booleanResponse = calendar.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

#set($booleanResponse = $calendar.HasWarningsOrErrors())

JavaScript

var booleanResponse = calendar.HasWarningsOrErrors();

Returns

[[Boolean Script API Type|Boolean]]

HtmlDescription

Return the Html encoded description of the content (the body, for example). Possible values for “target” are “Web”, “Email”, “WebServices”, or “raw”. When “raw” is specified as the target, the description should not be encoded or have any special rendering done to it.

Velocity

#set($stringResponse = $calendar.HtmlDescription($target))

JavaScript

var stringResponse = calendar.HtmlDescription(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`[[String Script API Type\|String]]`	Target	Required

Returns

[[String Script API Type|String]]

ThrowErrors

Velocity

$calendar.ThrowErrors()

JavaScript

calendar.ThrowErrors();

Returns

Nothing

ToString

Velocity

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

JavaScript

var stringResponse = calendar.ToString();

Returns

[[String Script API Type|String]]