calendar_v1_events Script API

Ben Tiedt — Wed, 20 Nov 2019 14:51:37 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:51:37

Calendar Event Utility methods for scripted widgets

Properties
AggregateByMonth
Create
HasPermission
IncrementViewCount
IsFeatured
IsSubscribed
List
RegistrationTypes
SetFeatured
SetSubscribed
Show
Update

Properties

Name	Access	Type	Description
ContentTypeId	Read	`Guid`	Content Type Id
Current	Read	`[[Event Script API Type\|Event]]`	Current

Methods

AggregateByMonth

Velocity

#set($dictionaryResponse = $calendar_v1_events.AggregateByMonth($events))

JavaScript

var dictionaryResponse = calendar_v1_events.AggregateByMonth(events);

Parameters

Name	Type	Description	Required	Default	Options
events	`IEnumerable of [[Event Script API Type\|Event]]`	Events	Required

Returns

Dictionary of String

Create

Velocity

#set($eventResponse = $calendar_v1_events.Create($calendarId, "%{ Address = $addressArg, AllowAnonymous = $allowAnonymousArg, Body = $bodyArg, EndDate = $endDateArg, Latitude = $latitudeArg, Location = $locationArg, Longitude = $longitudeArg, MaxRegistrations = $maxRegistrationsArg, RegistrationType = $registrationTypeArg, StartDate = $startDateArg, Tags = $tagsArg, TimeZoneId = $timeZoneIdArg, Title = $titleArg, Url = $urlArg }"))

JavaScript

var eventResponse = calendar_v1_events.Create(calendarId, { Address: addressArg, AllowAnonymous: allowAnonymousArg, Body: bodyArg, EndDate: endDateArg, Latitude: latitudeArg, Location: locationArg, Longitude: longitudeArg, MaxRegistrations: maxRegistrationsArg, RegistrationType: registrationTypeArg, StartDate: startDateArg, Tags: tagsArg, TimeZoneId: timeZoneIdArg, Title: titleArg, Url: urlArg });

Parameters

Name	Type	Description	Required
calendarId	`Int32`	Calendar Id	Required
Address	`String`	Address	Optional
AllowAnonymous	`Boolean`	Allow Anonymous	Optional
Body	`String`	Body	Optional
EndDate	`DateTime`	End Date	Optional
Latitude	`Double`	Latitude	Optional
Location	`String`	Location	Optional
Longitude	`Double`	Longitude	Optional
MaxRegistrations	`Int32`	Max Registrations	Optional
RegistrationType	`Int32`	Registration Type	Optional
StartDate	`DateTime`	Start Date	Optional
Tags	`String`	Tags	Optional
TimeZoneId	`String`	Time Zone Id	Optional
Title	`String`	Title	Optional
Url	`String`	Url	Optional

Returns

[[Event Script API Type|Event]]

HasPermission

Velocity

#set($booleanResponse = $calendar_v1_events.HasPermission($eventId, $permission))

JavaScript

var booleanResponse = calendar_v1_events.HasPermission(eventId, permission);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
permission	`Guid`	Permission	Required

Returns

Boolean

IncrementViewCount

Increments the views for the specified event.

Velocity

$calendar_v1_events.IncrementViewCount($eventId)

JavaScript

calendar_v1_events.IncrementViewCount(eventId);

Parameters

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

Returns

Nothing

IsFeatured

Velocity

#set($booleanResponse = $calendar_v1_events.IsFeatured($eventId))

JavaScript

var booleanResponse = calendar_v1_events.IsFeatured(eventId);

Parameters

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

Returns

Boolean

IsSubscribed

Velocity

#set($booleanResponse = $calendar_v1_events.IsSubscribed($eventId))

JavaScript

var booleanResponse = calendar_v1_events.IsSubscribed(eventId);

Parameters

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

Returns

Boolean

List

Velocity

#set($pagedListResponse = $calendar_v1_events.List("%{ CalendarContext = $calendarContextArg, CalendarId = $calendarIdArg, CalendarReferenceId = $calendarReferenceIdArg, CancelledOnly = $cancelledOnlyArg, ContentIds = $contentIdsArg, DateRangeEnd = $dateRangeEndArg, DateRangeStart = $dateRangeStartArg, EventId = $eventIdArg, FilterByCalendarIdList = $filterByCalendarIdListArg, FilterByReferenceIdList = $filterByReferenceIdListArg, IncludeSubGroups = $includeSubGroupsArg, QueryType = $queryTypeArg, RegisteredUserId = $registeredUserIdArg, RegisteredUserRegistrationStatus = $registeredUserRegistrationStatusArg }"))

JavaScript

var pagedListResponse = calendar_v1_events.List({ CalendarContext: calendarContextArg, CalendarId: calendarIdArg, CalendarReferenceId: calendarReferenceIdArg, CancelledOnly: cancelledOnlyArg, ContentIds: contentIdsArg, DateRangeEnd: dateRangeEndArg, DateRangeStart: dateRangeStartArg, EventId: eventIdArg, FilterByCalendarIdList: filterByCalendarIdListArg, FilterByReferenceIdList: filterByReferenceIdListArg, IncludeSubGroups: includeSubGroupsArg, QueryType: queryTypeArg, RegisteredUserId: registeredUserIdArg, RegisteredUserRegistrationStatus: registeredUserRegistrationStatusArg });

Parameters

Name	Type	Description	Required	Options
CalendarContext	`String`	Calendar Context	Optional
CalendarId	`Int32`	Calendar Id	Optional
CalendarReferenceId	`Int32`	Calendar Reference Id	Optional
CancelledOnly	`Boolean`	Cancelled Only	Optional
ContentIds	`String`	Comma separated list of ContentIds. Used to limit to a specific set of calendar events as well as sort order if SortBy is set to ContentIdsOrder	Optional
DateRangeEnd	`DateTime`	Date Range End	Optional
DateRangeStart	`DateTime`	Date Range Start	Optional
EventId	`Int32`	Event Id	Optional
FilterByCalendarIdList	`String`	Filter By Calendar Id List	Optional
FilterByReferenceIdList	`String`	Filter By Reference Id List	Optional
IncludeSubGroups	`Boolean`	Include Sub Groups	Optional
QueryType	`String`	Query Type	Optional
RegisteredUserId	`Int32`	Registered User Id	Optional
RegisteredUserRegistrationStatus	`String`	Registered User Registration Status	Optional	Cancelled, Confirmed, Invited, NotApproved

Returns

[[PagedList Script API Type|PagedList]] of [[Event Script API Type|Event]]

RegistrationTypes

Velocity

#set($apiListResponse = $calendar_v1_events.RegistrationTypes())

JavaScript

var apiListResponse = calendar_v1_events.RegistrationTypes();

Returns

[[ApiList Script API Type|ApiList]] of [[ExtendedAttribute Script API Type|ExtendedAttribute]]

SetFeatured

Velocity

$calendar_v1_events.SetFeatured($eventId, $feature)

JavaScript

calendar_v1_events.SetFeatured(eventId, feature);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
feature	`Boolean`	Feature	Required

Returns

Nothing

SetSubscribed

Velocity

$calendar_v1_events.SetSubscribed($eventId, $subscribe)

JavaScript

calendar_v1_events.SetSubscribed(eventId, subscribe);

Parameters

Name	Type	Description	Required	Default	Options
eventId	`Int32`	Event Id	Required
subscribe	`Boolean`	Subscribe	Required

Returns

Nothing

Show

Show Overload 1

Velocity

#set($eventResponse = $calendar_v1_events.Show($id))

JavaScript

var eventResponse = calendar_v1_events.Show(id);

Parameters

Name	Type	Description	Required	Default	Options
id	`Int32`	Id	Required

Show Overload 2

Velocity

#set($eventResponse = $calendar_v1_events.Show("%{ ContentId = $contentIdArg, Id = $idArg }"))

JavaScript

var eventResponse = calendar_v1_events.Show({ ContentId: contentIdArg, Id: idArg });

Parameters

Name	Type	Description	Required	Default	Options
ContentId	`String`	Content Id	Optional
Id	`Int32`	Id	Optional

Returns

[[Event Script API Type|Event]]

Update

Velocity

#set($eventResponse = $calendar_v1_events.Update($calendarId, $eventId, "%{ Address = $addressArg, AllowAnonymous = $allowAnonymousArg, Body = $bodyArg, EndDate = $endDateArg, Latitude = $latitudeArg, Location = $locationArg, Longitude = $longitudeArg, MaxRegistrations = $maxRegistrationsArg, RegistrationType = $registrationTypeArg, StartDate = $startDateArg, Tags = $tagsArg, Title = $titleArg, Url = $urlArg }"))

JavaScript

var eventResponse = calendar_v1_events.Update(calendarId, eventId, { Address: addressArg, AllowAnonymous: allowAnonymousArg, Body: bodyArg, EndDate: endDateArg, Latitude: latitudeArg, Location: locationArg, Longitude: longitudeArg, MaxRegistrations: maxRegistrationsArg, RegistrationType: registrationTypeArg, StartDate: startDateArg, Tags: tagsArg, Title: titleArg, Url: urlArg });

Parameters

Name	Type	Description	Required
calendarId	`Int32`	Calendar Id	Required
eventId	`Int32`	Event Id	Required
Address	`String`	Address	Optional
AllowAnonymous	`Boolean`	Allow Anonymous	Optional
Body	`String`	Body	Optional
EndDate	`DateTime`	End Date	Optional
Latitude	`Double`	Latitude	Optional
Location	`String`	Location	Optional
Longitude	`Double`	Longitude	Optional
MaxRegistrations	`Int32`	Max Registrations	Optional
RegistrationType	`Int32`	Registration Type	Optional
StartDate	`DateTime`	Start Date	Optional
Tags	`String`	Tags	Optional
Title	`String`	Title	Optional
Url	`String`	Url	Optional

Returns

[[Event Script API Type|Event]]