Event Script API Type

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

Properties
GetExtendedAttributeBool
GetExtendedAttributeDateTime
GetExtendedAttributeGuid
GetExtendedAttributeInt
GetExtendedAttributeString
HasErrors
HasWarnings
HasWarningsOrErrors
HtmlDescription
ThrowErrors

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 Int32`	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	`IList of Error`	Errors
EventCreateDate	Read, Write	`Nullable of DateTime`	Event Create Date
EventCreatorId	Read, Write	`Nullable of Int32`	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 Int32`	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 Double`	Latitude
Longitude	Read, Write	`Nullable of Double`	Longitude
MaximumRegistrationsAllowed	Read, Write	`Nullable of Int32`	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 Int32`	Total Confirmed Registrations
TotalRegistrations	Read, Write	`Nullable of Int32`	Total Registrations
TotalUnconfirmedRegistrations	Read, Write	`Nullable of Int32`	Total Unconfirmed Registrations
Url	Read	`String`	A Url to the content on the site.
User	Read, Write	`User`	User
Warnings	Read	`IList 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($int32Response = $event.GetExtendedAttributeInt($name, $defaultValue))

JavaScript

var int32Response = event.GetExtendedAttributeInt(name, defaultValue);

Parameters

Name	Type	Description	Required	Default	Options
name	`String`	Name	Required
defaultValue	`Int32`	Default Value	Required

Returns

Int32

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

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 = $event.HtmlDescription($target))

JavaScript

var stringResponse = event.HtmlDescription(target);

Parameters

Name	Type	Description	Required	Default	Options
target	`String`	Target	Required

Returns

String

ThrowErrors

Velocity

$event.ThrowErrors()

JavaScript

event.ThrowErrors();

Returns

Nothing

Recommended