Calendar 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
ApplicationId	Read, Write	`Guid`	A Guid uniquely identifying the application.
CalendarContext	Read, Write	`String`	Calendar Context
CalendarCreateDate	Read, Write	`Nullable of DateTime`	Calendar Create Date
CalendarDataToken	Read, Write	`String`	Calendar Data Token
CalendarReferenceId	Read, Write	`Nullable of Int32`	Calendar Reference Id
ContentContainerId	Read, Write	`Guid`	Content Container Id
ContentId	Read, Write	`Guid`	A Guid uniquely identifying the content.
CreatorId	Read, Write	`Nullable of Int32`	Creator Id
Description	Read, Write	`String`	Description
Errors	Read	`IList of Error`	Errors
ExtendedAttributes	Read	`ApiList of ExtendedAttribute`	Extended Attributes
Group	Read, Write	`Group`	Group
Id	Read, Write	`Nullable of Int32`	Id
Name	Read, Write	`String`	Name
NodeId	Read, Write	`Guid`	Node Id
Url	Read, Write	`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 = $calendar.GetExtendedAttributeBool($name, $defaultValue))

JavaScript

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

JavaScript

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

JavaScript

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

JavaScript

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

JavaScript

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

JavaScript

var booleanResponse = calendar.HasErrors();

Returns

Boolean

HasWarnings

Velocity

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

JavaScript

var booleanResponse = calendar.HasWarnings();

Returns

Boolean

HasWarningsOrErrors

Velocity

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

JavaScript

var booleanResponse = calendar.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 = $calendar.HtmlDescription($target))

JavaScript

var stringResponse = calendar.HtmlDescription(target);

Parameters

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

Returns

String

ThrowErrors

Velocity

$calendar.ThrowErrors()

JavaScript

calendar.ThrowErrors();

Returns

Nothing

Recommended