CalendarView

Represents a calendar based on a Salesforce object, both standard and custom. These calendars can be created and assigned to users other than the creator. This object is available in API version 48.0 and later.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), undelete(), update(), upsert()

Special Access Rules

All fields and entities referenced by field values must be accessible by the CalendarView creator even if the creator isn’t the CalendarView owner.

Fields

Field	Details
Color	Type string Properties Create, Defaulted on create, Filter, Group, Nillable, Sort, Update Description Represents the color used in the background for records displayed in a user’s calendar view within the user interface.
CurrencyIsoCode	Type picklist Properties Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update Description Available only for organizations with the multicurrency feature enabled. Contains the ISO code for any currency allowed by the organization.
DateHandlingType	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Determined by the data type of the StartField. Valid values include: `Date` `Datetime`
DisplayField	Type string Properties Create, Filter, Group, Sort, Update Description Represents the SobjectType field used as the subject for records displayed in a user’s calendar view within the user interface.
EndField	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description An optional field that represents the sObjectType field used as the end time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field that matches the type in StartField.
FillPattern	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Represents the pattern displayed as the background for records displayed in a user’s calendar view within the user interface. Valid values include: `verticalStripes` `ascDiagonalStripes` `descDiagonalStripes`
IsDisplayed	Type boolean Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Defines whether users can see a calendar’s records in their calendar view in the user interface. When `true`, records are visible in the user’s calendar view. When `false`, records are hidden from the user’s calendar view. The default is `true`.
ListViewFilterId	Type reference Properties Create, Filter, Group, Nillable, Sort, Update Description References the ListView used to filter records represented by the CalendarView. ListView must have the same sObjectType. If no ListViewFilterId is defined, the calendar displays only records with the same owner as the CalendarView.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description A user-provided name that identifies the calendar. This isn’t an enumerated field; it can be any string to a maximum length of 80 characters.
OwnerId	Type reference Properties Create, Defaulted on create, Filter, Group, Sort, Update Description Represents the owner of the CalendarView.
SobjectType	Type picklist Properties Create, Filter, Group, Restricted picklist, Sort Description The type of standard or custom Salesforce object that is used to create records for the CalendarView. Use the API name of the desired SobjectType.
StartField	Type string Properties Create, Filter, Group, Sort, Update Description Represents the SobjectType field used as the start time for records displayed in a user’s calendar view within the user interface. Must be a date or dateTime field type.

Usage

To distribute a CalendarView to multiple users, IDs can be pulled from a group, user list, or profile. For this example, a CalendarView based on opportunity close dates is being distributed to a sales team in a public group, Sales Group:

1Group userGroup = [SELECT Id FROM Group WHERE Name = 'Sales Group' LIMIT 1];
2List<Id> groupId = new List<Id>();
3groupId.add(userGroup.id);
4List<GroupMember> groupMembers = [SELECT UserOrGroupId FROM GroupMember
5   WHERE GroupId IN: groupId];
6
7List<CalendarView> calendarViews = new List<CalendarView>();
8for (GroupMember groupMember : groupMembers) {
9   CalendarView calendarView = new CalendarView(name = 'Opportunity Close
10    Dates', SobjectType = 'Opportunity', StartField = 'CloseDate', DisplayField =
11    'Name', OwnerId = groupMember.UserOrGroupId);
12   calendarViews.add(calendarView);
13}
14insert calendarViews;

Object Reference for Salesforce and Lightning Platform

CalendarView

Supported Calls

Special Access Rules

Fields

Usage