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
Velocity
JavaScript
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 |
Returns
GetTags
Velocity
JavaScript
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
JavaScript
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
JavaScript
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
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
permission | Guid | Calendar Permission Id | Required |
Returns
Boolean
IsSubscribed
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required |
Returns
Boolean
List
Velocity
JavaScript
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 | ||
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
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Count | Int32 | Count | Optional | ||
GroupId | Int32 | Group Id | Optional | ||
UserId | Int32 | User Id | Optional |
Returns
MergeFeaturedLists
Velocity
JavaScript
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
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
subscribe | Boolean | Subscribe | Required |
Returns
NothingShow
Show Overload 1
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
Id | Int32 | Id | Optional |
Show Overload 2
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
id | Int32 | Id | Required |
Returns
Update
Velocity
JavaScript
Parameters
Name | Type | Description | Required | Default | Options |
---|---|---|---|---|---|
calendarId | Int32 | Calendar Id | Required | ||
Description | String | Description | Optional | ||
Name | String | Name | Optional |