Enables Scripted Content Fragments to use Calendars
- Properties
- Create
- GetTags
- HasAnonymousPermission
- HasPermission
- IsSubscribed
- List
- ListFeatured
- MergeFeaturedLists
- SetSubscribed
- Show
- Update
Properties
Name | Access | Type | Description |
---|---|---|---|
ApplicationTypeId | Read | Guid | Application Type Id |
ContentTypeId | Read | Guid | Content Type Id |
Current | Read | Calendar | Current |
TotalLicensedRemaining | Read | Int32 | Total Licensed Remaining |
Methods
Create
Create Overload 1
Velocity
#set($calendarResponse = $calendar_v1_calendars.Create($groupId, $name, $description, $userId))
JavaScript
var calendarResponse = calendar_v1_calendars.Create(groupId, name, description, userId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
name | String | Name | Required | ||
description | String | Description | Required | ||
userId | Int32 | User Id | Required |
Create Overload 2
Velocity
#set($calendarResponse = $calendar_v1_calendars.Create($groupId, $name, $description, "%{ _ExtendedAttributes_NAME = $_ExtendedAttributes_NAMEArg, CreatingUserId = $creatingUserIdArg }"))
JavaScript
var calendarResponse = calendar_v1_calendars.Create(groupId, name, description, { _ExtendedAttributes_NAME: _ExtendedAttributes_NAMEArg, CreatingUserId: creatingUserIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
groupId | Int32 | Group Id | Required | ||
name | String | Name | Required | ||
description | String | Description | Required | ||
options | Options | Set of optional parameters including: | Required | ||
_ExtendedAttributes_NAME | String | Additional information about the calendar that may be used by third party plugins | Optional | ||
CreatingUserId | Int32 | Id of creating user. Defaults to Accessing UserId | Optional |
Returns
GetTags
Velocity
#set($pagedListResponse = $calendar_v1_calendars.GetTags($calendarId))
JavaScript
var pagedListResponse = calendar_v1_calendars.GetTags(calendarId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required |
Returns
HasAnonymousPermission
OBSOLETE IN 11.0. Use $core_v3_permission.CheckPermission instead, using the anonymous system account's user id.
Velocity
#set($booleanResponse = $calendar_v1_calendars.HasAnonymousPermission($calendarId, $permission))
JavaScript
var booleanResponse = calendar_v1_calendars.HasAnonymousPermission(calendarId, permission);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
permission | String | Calendar Permission Id | Required |
Returns
Boolean
HasPermission
HasPermission Overload 1
Checks accessing user permission for a calendar
Velocity
#set($booleanResponse = $calendar_v1_calendars.HasPermission($calendarId, $permission))
JavaScript
var booleanResponse = calendar_v1_calendars.HasPermission(calendarId, permission);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
permission | String | Calendar Permission Name | Required |
HasPermission Overload 2
Checks accessing user permission for a calendar
Velocity
#set($booleanResponse = $calendar_v1_calendars.HasPermission($calendarId, $permission))
JavaScript
var booleanResponse = calendar_v1_calendars.HasPermission(calendarId, permission);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
permission | Guid | Calendar Permission Id | Required |
Returns
Boolean
IsSubscribed
Velocity
#set($booleanResponse = $calendar_v1_calendars.IsSubscribed($calendarId))
JavaScript
var booleanResponse = calendar_v1_calendars.IsSubscribed(calendarId);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required |
Returns
Boolean
List
Velocity
#set($pagedListResponse = $calendar_v1_calendars.List("%{ ApplicationIds = $applicationIdsArg, CalendarContext = $calendarContextArg, CalendarCreator = $calendarCreatorArg, CalendarId = $calendarIdArg, CalendarReferenceId = $calendarReferenceIdArg, FilterByCalendarIdList = $filterByCalendarIdListArg, FilterByReferenceIdList = $filterByReferenceIdListArg, NameQuery = $nameQueryArg, PageIndex = $pageIndexArg, PageSize = $pageSizeArg, SortBy = $sortByArg, SortOrder = $sortOrderArg }"))
JavaScript
var pagedListResponse = calendar_v1_calendars.List({ ApplicationIds: applicationIdsArg, 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 |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
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 | ||
CalendarCreator | Int32 | Calendar Creator | Optional | ||
CalendarId | Int32 | Calendar Id | Optional | ||
CalendarReferenceId | Int32 | 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 | Int32 | Page Index | Optional | 0 | |
PageSize | Int32 | Page Size | Optional | 999 | |
SortBy | String | Sort By | Optional | Name | ApplicationIdsOrder, CreateDate, Name |
SortOrder | String | Sort Order | Optional | Ascending | Ascending, Descending |
Returns
ListFeatured
Velocity
#set($apiListResponse = $calendar_v1_calendars.ListFeatured("%{ Count = $countArg, GroupId = $groupIdArg, UserId = $userIdArg }"))
JavaScript
var apiListResponse = calendar_v1_calendars.ListFeatured({ Count: countArg, GroupId: groupIdArg, UserId: userIdArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
Count | Int32 | Count | Optional | ||
GroupId | Int32 | Group Id | Optional | ||
UserId | Int32 | User Id | Optional |
Returns
MergeFeaturedLists
Velocity
#set($apiListResponse = $calendar_v1_calendars.MergeFeaturedLists($featured, $calendarFeatured, $count))
JavaScript
var apiListResponse = calendar_v1_calendars.MergeFeaturedLists(featured, calendarFeatured, count);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
featured | ApiList of Feature | Featured | Required | ||
calendarFeatured | ApiList of Feature | Calendar Featured | Required | ||
count | Int32 | Count | Required |
Returns
SetSubscribed
Velocity
$calendar_v1_calendars.SetSubscribed($calendarId, $subscribe)
JavaScript
calendar_v1_calendars.SetSubscribed(calendarId, subscribe);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
subscribe | Boolean | Subscribe | Required |
Returns
NothingShow
Show Overload 1
Velocity
#set($calendarResponse = $calendar_v1_calendars.Show("%{ Id = $idArg }"))
JavaScript
var calendarResponse = calendar_v1_calendars.Show({ Id: idArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
options | Options | Set of optional parameters including: | Required | ||
Id | Int32 | Id | Optional |
Show Overload 2
Velocity
#set($calendarResponse = $calendar_v1_calendars.Show($id))
JavaScript
var calendarResponse = calendar_v1_calendars.Show(id);
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id | Required |
Returns
Update
Velocity
#set($calendarResponse = $calendar_v1_calendars.Update($calendarId, "%{ _ExtendedAttributes_NAME = $_ExtendedAttributes_NAMEArg, Description = $descriptionArg, Name = $nameArg }"))
JavaScript
var calendarResponse = calendar_v1_calendars.Update(calendarId, { _ExtendedAttributes_NAME: _ExtendedAttributes_NAMEArg, Description: descriptionArg, Name: nameArg });
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
options | Options | Set of optional parameters including: | Required | ||
_ExtendedAttributes_NAME | String | Additional information about the calendar that may be used by third party plugins | Optional | ||
Description | String | Description | Optional | ||
Name | String | Name | Optional |