Event Script API Type

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

Returns

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`	Name	Required
defaultValue	`DateTime`	Default Value	Required

Returns

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`	Name	Required
defaultValue	`Guid`	Default Value	Required

Returns

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`	Name	Required
defaultValue	`Number`	Default Value	Required

Returns

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`	Name	Required
defaultValue	`String`	Default Value	Required

Returns

String

HasErrors

Velocity

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

JavaScript

var booleanResponse = event.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = event.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = event.HasWarningsOrErrors();

Returns

Boolean

ThrowErrors

Velocity

$event.ThrowErrors()

JavaScript

event.ThrowErrors();

Returns

Nothing

ToString

Velocity

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

JavaScript

var stringResponse = event.ToString();

Returns

String

Recommended