Event Script API Type

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

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

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

Properties

Name	Access	Type	Description
AddressString	Read, Write	`[[String Script API Type\|String]]`	Address String
AllowAnonymousRegistrations	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Allow Anonymous Registrations
ApplicationId	Read	`[[Guid Script API Type\|Guid]]`	Application Id
Calendar	Read	`[[Calendar Script API Type\|Calendar]]`	Calendar
CalendarId	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Calendar Id
CancelDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Cancel Date
ContentContainerId	Read	`[[Nullable Script API Type\|Nullable]] of [[Guid Script API Type\|Guid]]`	Content Container Id
ContentId	Read, Write	`[[Guid Script API Type\|Guid]]`	A Guid uniquely identifying the content.
Errors	Read	`[[List Script API Type\|List]] of [[Error Script API Type\|Error]]`	Errors
EventCreateDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Event Create Date
EventCreatorId	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Event Creator Id
EventDateString	Read	`[[String Script API Type\|String]]`	Event Date String
EventDescription	Read, Write	`[[String Script API Type\|String]]`	Event Description
EventEndDate	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[DateTime Script API Type\|DateTime]]`	Event End Date
EventLocation	Read, Write	`[[String Script API Type\|String]]`	Event Location
EventRawDescription	Read, Write	`[[String Script API Type\|String]]`	Event Raw Description
EventReferenceUrl	Read, Write	`[[String Script API Type\|String]]`	Event Reference Url
EventStartDate	Read, Write	`[[DateTime Script API Type\|DateTime]]`	Event Start Date
EventTitle	Read, Write	`[[String Script API Type\|String]]`	Event Title
ExtendedAttributes	Read	`[[ApiList Script API Type\|ApiList]] of [[ExtendedAttribute Script API Type\|ExtendedAttribute]]`	Extended Attributes
Id	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Id
IsCancelled	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Is Cancelled
IsExternal	Read	`[[Boolean Script API Type\|Boolean]]`	Is External
IsFeatured	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Boolean Script API Type\|Boolean]]`	Is Featured
Latitude	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Latitude
Longitude	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Longitude
MaximumRegistrationsAllowed	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Maximum Registrations Allowed
RegistrationType	Read, Write	`[[String Script API Type\|String]]`	Registration Type
SourceType	Read	`[[String Script API Type\|String]]`	Source Type
Tags	Read, Write	`Array of [[String Script API Type\|String]]`	Tags
TimeZone	Read, Write	`[[TimeZoneInfo Script API Type\|TimeZoneInfo]]`	Time Zone
TotalConfirmedRegistrations	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Total Confirmed Registrations
TotalRegistrations	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Total Registrations
TotalUnconfirmedRegistrations	Read, Write	`[[Nullable Script API Type\|Nullable]] of [[Number Script API Type\|Number]]`	Total Unconfirmed Registrations
Url	Read	`[[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 = $event.GetExtendedAttributeBool($name, $defaultValue))

JavaScript

var booleanResponse = event.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 = $event.GetExtendedAttributeDateTime($name, $defaultValue))

JavaScript

var dateTimeResponse = event.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 = $event.GetExtendedAttributeGuid($name, $defaultValue))

JavaScript

var guidResponse = event.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 = $event.GetExtendedAttributeInt($name, $defaultValue))

JavaScript

var numberResponse = event.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 = $event.GetExtendedAttributeString($name, $defaultValue))

JavaScript

var stringResponse = event.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 = $event.HasErrors())

JavaScript

var booleanResponse = event.HasErrors();

Returns

[[Boolean Script API Type|Boolean]]

HasWarnings

Velocity

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

JavaScript

var booleanResponse = event.HasWarnings();

Returns

[[Boolean Script API Type|Boolean]]

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = event.HasWarningsOrErrors();

Returns

[[Boolean Script API Type|Boolean]]

ThrowErrors

Velocity

$event.ThrowErrors()

JavaScript

event.ThrowErrors();

Returns

Nothing

ToString

Velocity

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

JavaScript

var stringResponse = event.ToString();

Returns

[[String Script API Type|String]]