Calendar Event Utility methods for scripted widgets
Methods
AggregateByMonth
Usage
#set($dictionaryResponse = $calendar_v1_events.AggregateByMonth($events))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
events | IEnumerable<Event> | Events | Required |
Return Type
Dictionary<string,IOrderedEnumerable<Event>>
Create
Usage
#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, Title = $titleArg, Url = $urlArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | int | Calendar Id | Required | ||
Address | string | Address | Optional | ||
AllowAnonymous | bool | 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 | int | Max Registrations | Optional | ||
RegistrationType | int | Registration Type | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
Tags | string | Tags | Optional | ||
Title | string | Title | Optional | ||
Url | string | Url | Optional |
Return Type
Event
HasPermission
Usage
#set($booleanResponse = $calendar_v1_events.HasPermission($eventId, $permission))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
eventId | int | Event Id | Required | ||
permission | Guid | Permission | Required |
Return Type
bool
IsFeatured
Usage
#set($booleanResponse = $calendar_v1_events.IsFeatured($eventId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
eventId | int | Event Id | Required |
Return Type
bool
IsSubscribed
Usage
#set($booleanResponse = $calendar_v1_events.IsSubscribed($eventId))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
eventId | int | Event Id | Required |
Return Type
bool
List
Usage
#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}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
CalendarContext | string | Calendar Context | Optional | ||
CalendarId | int | Calendar Id | Optional | ||
CalendarReferenceId | int | Calendar Reference Id | Optional | ||
CancelledOnly | bool | 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 | int | Event Id | Optional | ||
FilterByCalendarIdList | string | Filter By Calendar Id List | Optional | ||
FilterByReferenceIdList | string | Filter By Reference Id List | Optional | ||
IncludeSubGroups | bool | Include Sub Groups | Optional | ||
QueryType | string | Query Type | Optional | ||
RegisteredUserId | int | Registered User Id | Optional | ||
RegisteredUserRegistrationStatus | string | Registered User Registration Status | Optional | Cancelled, Confirmed, Invited, NotApproved |
Return Type
PagedList<Event>
RegistrationTypes
Usage
#set($apiListResponse = $calendar_v1_events.RegistrationTypes())
Return Type
SetFeatured
Usage
$calendar_v1_events.SetFeatured($eventId, $feature)
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
eventId | int | Event Id | Required | ||
feature | bool | Feature | Required |
SetSubscribed
Usage
$calendar_v1_events.SetSubscribed($eventId, $subscribe)
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
eventId | int | Event Id | Required | ||
subscribe | bool | Subscribe | Required |
Show
Usage
#set($eventResponse = $calendar_v1_events.Show("%{ContentId = $contentIdArg, Id = $idArg}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
ContentId | string | Content Id | Optional | ||
Id | int | Id | Optional |
Return Type
Event
Show
Usage
#set($eventResponse = $calendar_v1_events.Show($id))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | int | Id | Required |
Return Type
Event
Update
Usage
#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}"))
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | int | Calendar Id | Required | ||
eventId | int | Event Id | Required | ||
Address | string | Address | Optional | ||
AllowAnonymous | bool | 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 | int | Max Registrations | Optional | ||
RegistrationType | int | Registration Type | Optional | ||
StartDate | DateTime | Start Date | Optional | ||
Tags | string | Tags | Optional | ||
Title | string | Title | Optional | ||
Url | string | Url | Optional |
Return Type
Event