Enables Scripted Content Fragments to use Calendars
Properties
| Name | Type | Description | Default | Options |
|---|---|---|---|---|
| ApplicationTypeId | Guid | |||
| ContentTypeId | Guid | |||
| Current | Calendar | |||
| TotalLicensedRemaining | int |
Methods
Create
Usage
#set($calendarResponse = $calendar_v1_calendars.Create($groupId, $name, $description, $userId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| groupId | int | Group Id | Required | ||
| name | string | Name | Required | ||
| description | string | Description | Required | ||
| userId | int | User Id | Required |
Return Type
Calendar
GetTags
Usage
#set($pagedListResponse = $calendar_v1_calendars.GetTags($calendarId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required |
Return Type
HasAnonymousPermission
Checks permission for a calendar for a anonymous user
Usage
#set($booleanResponse = $calendar_v1_calendars.HasAnonymousPermission($calendarId, $permission))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required | ||
| permission | string | Calendar Permission Id | Required |
Return Type
bool
HasPermission
Checks accessing user permission for a calendar
Usage
#set($booleanResponse = $calendar_v1_calendars.HasPermission($calendarId, $permission))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required | ||
| permission | string | Calendar Permission Name | Required |
Return Type
bool
HasPermission
Checks accessing user permission for a calendar
Usage
#set($booleanResponse = $calendar_v1_calendars.HasPermission($calendarId, $permission))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required | ||
| permission | Guid | Calendar Permission Id | Required |
Return Type
bool
IsSubscribed
Usage
#set($booleanResponse = $calendar_v1_calendars.IsSubscribed($calendarId))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required |
Return Type
bool
List
Usage
#set($pagedListResponse = $calendar_v1_calendars.List("%{ApplicationIds = $applicationIdsArg, CalendarContext = $calendarContextArg, CalendarContext = $calendarContextArg, CalendarCreator = $calendarCreatorArg, CalendarId = $calendarIdArg, CalendarReferenceId = $calendarReferenceIdArg, FilterByCalendarIdList = $filterByCalendarIdListArg, FilterByReferenceIdList = $filterByReferenceIdListArg, NameQuery = $nameQueryArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| ApplicationIds | string | Comma separated list of ApplicationIds. Used to limit to a specific set of calendars as well as sort order if SortBy is set to ApplicationIdsOrder | Optional | ||
| CalendarContext | string | Calendar Context | Optional | ||
| CalendarContext | string | Calendar Context | Optional | ||
| CalendarCreator | int | Calendar Creator | Optional | ||
| CalendarId | int | Calendar Id | Optional | ||
| CalendarReferenceId | int | Calendar Reference Id | Optional | ||
| FilterByCalendarIdList | string | Filter By Calendar Id List | Optional | ||
| FilterByReferenceIdList | string | Filter By Reference Id List | Optional | ||
| NameQuery | string | Name Query | Optional | ||
| PageIndex | int | Page Index | Optional | 0 | |
| PageSize | int | Page Size | Optional | 999 | |
| SortBy | string | Sort By | Optional | Name | ApplicationIdsOrder, CreateDate, Name |
| SortOrder | string | Sort Order | Optional | Ascending | Ascending, Descending |
Return Type
PagedList<Calendar>
ListFeatured
Usage
#set($apiListResponse = $calendar_v1_calendars.ListFeatured("%{Count = $countArg, GroupId = $groupIdArg, UserId = $userIdArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| Count | int | Count | Optional | ||
| GroupId | int | Group Id | Optional | ||
| UserId | int | User Id | Optional |
Return Type
MergeFeaturedLists
Usage
#set($apiListResponse = $calendar_v1_calendars.MergeFeaturedLists($featured, $calendarFeatured, $count))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| featured | ApiList<Feature> | Featured | Required | ||
| calendarFeatured | ApiList<Feature> | Calendar Featured | Required | ||
| count | int | Count | Required |
Return Type
SetSubscribed
Usage
$calendar_v1_calendars.SetSubscribed($calendarId, $subscribe)
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required | ||
| subscribe | bool | Subscribe | Required |
Show
Usage
#set($calendarResponse = $calendar_v1_calendars.Show("%{Id = $idArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| Id | int | Id | Optional |
Return Type
Calendar
Show
Usage
#set($calendarResponse = $calendar_v1_calendars.Show($id))
Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| id | int | Id | Required |
Return Type
Calendar
Update
Usage
#set($calendarResponse = $calendar_v1_calendars.Update($calendarId, "%{Description = $descriptionArg, Name = $nameArg}"))Parameters
| Name | Type | Description | Required | Default | Options |
|---|---|---|---|---|---|
| calendarId | int | Calendar Id | Required | ||
| Description | string | Description | Optional | ||
| Name | string | Name | Optional |
Return Type
Calendar