calendar_v1_urls Script API

Enables Scripted Content Fragments to use Calendars Urls

AddCalendar
AddEvent
CalendarGroupRss
CalendarRss
Current
DownloadEvent
EditCalendar
EditEvent
Event
EventCommentRSS
GroupHome
Home
HomePage
IsCalendarUrl
IsSafeUrl
RegisteredUsers
TagBrowser

Methods

AddCalendar

AddCalendar Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.AddCalendar($groupId))

JavaScript

var stringResponse = calendar_v1_urls.AddCalendar(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

AddCalendar Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.AddCalendar($groupId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.AddCalendar(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

AddEvent

AddEvent Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.AddEvent($calendarId))

JavaScript

var stringResponse = calendar_v1_urls.AddEvent(calendarId);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required

AddEvent Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.AddEvent($calendarId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.AddEvent(calendarId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

CalendarGroupRss

CalendarGroupRss Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.CalendarGroupRss($groupId))

JavaScript

var stringResponse = calendar_v1_urls.CalendarGroupRss(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

CalendarGroupRss Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.CalendarGroupRss($groupId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.CalendarGroupRss(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

CalendarRss

CalendarRss Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.CalendarRss($calendarId))

JavaScript

var stringResponse = calendar_v1_urls.CalendarRss(calendarId);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required

CalendarRss Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.CalendarRss($calendarId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.CalendarRss(calendarId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Current

Velocity

#set($stringResponse = $calendar_v1_urls.Current())

JavaScript

var stringResponse = calendar_v1_urls.Current();

Returns

String

DownloadEvent

DownloadEvent Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.DownloadEvent($eventId))

JavaScript

var stringResponse = calendar_v1_urls.DownloadEvent(eventId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

DownloadEvent Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.DownloadEvent($eventId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.DownloadEvent(eventId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditCalendar

EditCalendar Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.EditCalendar($calendarId))

JavaScript

var stringResponse = calendar_v1_urls.EditCalendar(calendarId);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required

EditCalendar Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.EditCalendar($calendarId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.EditCalendar(calendarId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EditEvent

EditEvent Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.EditEvent($eventId))

JavaScript

var stringResponse = calendar_v1_urls.EditEvent(eventId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

EditEvent Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.EditEvent($eventId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.EditEvent(eventId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Event

Event Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.Event($eventId))

JavaScript

var stringResponse = calendar_v1_urls.Event(eventId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

Event Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.Event($eventId, $internalOnly))

JavaScript

var stringResponse = calendar_v1_urls.Event(eventId, internalOnly);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
internalOnly	`Boolean`	Internal Only	Required

Event Overload 3

Velocity

#set($stringResponse = $calendar_v1_urls.Event($eventId, $internalOnly, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.Event(eventId, internalOnly, checkPermissions);

Parameters

Name	Type	Description	Required
eventId	`Int32`	Event Id	Required
internalOnly	`Boolean`	Internal Only	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

EventCommentRSS

EventCommentRSS Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.EventCommentRSS($eventId))

JavaScript

var stringResponse = calendar_v1_urls.EventCommentRSS(eventId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

EventCommentRSS Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.EventCommentRSS($eventId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.EventCommentRSS(eventId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

GroupHome

GroupHome Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.GroupHome($groupId))

JavaScript

var stringResponse = calendar_v1_urls.GroupHome(groupId);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required

GroupHome Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.GroupHome($groupId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.GroupHome(groupId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
groupId	`Int32`	Group Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Home

Velocity

#set($stringResponse = $calendar_v1_urls.Home())

JavaScript

var stringResponse = calendar_v1_urls.Home();

Returns

String

HomePage

HomePage Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.HomePage($calendarId))

JavaScript

var stringResponse = calendar_v1_urls.HomePage(calendarId);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required

HomePage Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.HomePage($calendarId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.HomePage(calendarId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

IsCalendarUrl

Velocity

#set($booleanResponse = $calendar_v1_urls.IsCalendarUrl())

JavaScript

var booleanResponse = calendar_v1_urls.IsCalendarUrl();

Returns

Boolean

IsSafeUrl

Velocity

#set($booleanResponse = $calendar_v1_urls.IsSafeUrl($url))

JavaScript

var booleanResponse = calendar_v1_urls.IsSafeUrl(url);

Parameters

Name	Type	Description	Required	Default	Options
url	`String`	Url	Required

Returns

Boolean

RegisteredUsers

RegisteredUsers Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.RegisteredUsers($eventId))

JavaScript

var stringResponse = calendar_v1_urls.RegisteredUsers(eventId);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required

RegisteredUsers Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.RegisteredUsers($eventId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.RegisteredUsers(eventId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

TagBrowser

TagBrowser Overload 1

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser())

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser();

TagBrowser Overload 2

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($tagNames))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(tagNames);

Parameters

Name	Type	Description	Required	Default	Options
tagNames	`Array of String`	Tag Names	Required

TagBrowser Overload 3

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($tagNames))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(tagNames);

Parameters

Name	Type	Description	Required	Default	Options
tagNames	`IList of String`	Tag Names	Required

TagBrowser Overload 4

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required

TagBrowser Overload 5

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId, checkPermissions);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
checkPermissions	`Boolean`	Check Permissions	Required

TagBrowser Overload 6

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId, $tagNames))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId, tagNames);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
tagNames	`Array of String`	Tag Names	Required

TagBrowser Overload 7

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId, $tagNames, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId, tagNames, checkPermissions);

Parameters

Name	Type	Description	Required
calendarId	`Int32`	Calendar Id	Required
tagNames	`Array of String`	Tag Names	Required
checkPermissions	`Boolean`	Check Permissions	Required

TagBrowser Overload 8

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId, $tagNames))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId, tagNames);

Parameters

Name	Type	Description	Required	Default	Options
calendarId	`Int32`	Calendar Id	Required
tagNames	`IList of String`	Tag Names	Required

TagBrowser Overload 9

Velocity

#set($stringResponse = $calendar_v1_urls.TagBrowser($calendarId, $tagNames, $checkPermissions))

JavaScript

var stringResponse = calendar_v1_urls.TagBrowser(calendarId, tagNames, checkPermissions);

Parameters

Name	Type	Description	Required
calendarId	`Int32`	Calendar Id	Required
tagNames	`IList of String`	Tag Names	Required
checkPermissions	`Boolean`	Check Permissions	Required

Returns

String

Recommended