Schema Name |
|
Declared in |
|
Data Classes |
|
Availability | Available in Mac OS X v10.4 and later. |
The Calendars schema defines all the entities and properties used to represent a calendar in iCal—entities used to create a calendar object containing multiple event and tasks with associated alarms. Other entities are used to describe details of an event or task such as the frequency, organizer, and attendees of an event.
Figure 1 illustrates some of the entities, attributes, and relationships contained in the Calendars schema.
Important: In this schema, if the time value of a calendar date attribute is not specified, iCal will default it to 12:00 GMT/UTC.
Syncing notes: How applications interpret a Boolean property missing from a pushed record is application dependent. If you omit a Boolean property from a pushed record, iCal assumes you intend to set the value to NO
.
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Someone who attends an event or participates in a task. Below are the attributes and relationships of an Attendee record.
Attribute | Type | Description |
---|---|---|
|
| This attendee’s display name. Available in Mac OS X v10.4 and later. |
|
| An array of strings representing email addresses of those people who delegated participation in an event or task to this attendee. Available in Mac OS X v10.4 and later. |
|
| An array of strings representing the email addresses of people whom an attendee has delegated to participation in an event or task. For example, a manager may delegate participation in an event to his/her staff. Available in Mac OS X v10.4 and later. |
|
| This attendee’s directory entry in an LDAP database. The entry is a URL conforming to RFC 2255. See The LDAP URL Format for details. Available in Mac OS X v10.4 and later. |
|
| This attendee’s email address. Available in Mac OS X v10.4 and later. |
|
| The role of this attendee. Possible values are Available in Mac OS X v10.4 and later. |
|
| Set to Available in Mac OS X v10.4 and later. |
|
| A string that indicates the participation status of this attendee. Possible values are Available in Mac OS X v10.4 and later. |
|
| The type of attendee. Possible values are Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event, Task | The event or task associated with this attendee. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
An alarm that alerts the user of a pending event or task by playing an audio file. Below are the attributes and relationships of an AudioAlarm record.
Attribute | Type | Description |
---|---|---|
|
| Long description of this alarm. Available in Mac OS X v10.4 and later. |
|
| The number of times this alarm will repeat. Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between alarm repeats. Available in Mac OS X v10.4 and later. |
|
| The name of a system sound that plays when this alarm triggers. Available in Mac OS X v10.5 and later. |
|
| Short description of this alarm. Available in Mac OS X v10.4 and later. |
|
| The date/time this alarm will trigger. This is an absolute value. If you set Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between this alarm and the reference date of Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event, Task | The event or task associated with this alarm. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents a group of events and tasks which can have a number of alarms. For example, events associated with work can be grouped together on one calendar and manipulated separately from other events. Below are the attributes and relationships of a Calendar record.
Attribute | Type | Description |
---|---|---|
|
| The color used to display this calendar and its events. Available in Mac OS X v10.5 and later. |
|
| A description of this calendar. Available in Mac OS X v10.4 and later. |
|
| A flag that indicates whether or not this calendar is read only. Set to Available in Mac OS X v10.4 and later. |
|
| The URL for a subscription calendar. Available in Mac OS X v10.5 and later. |
|
| The name of this calendar. Available in Mac OS X v10.4 and later. |
|
| A link to a webpage about this calendar. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event | Events belonging to this calendar. Available in Mac OS X v10.4 and later. |
| Task | Tasks belonging to this calendar. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents an ordered collection of calendars. There can be only one CalendarOrder record. This record is used by iCal and is intended to be read-only to all other clients. Below are the attributes and relationships of a CalendarOrder record.
Attribute | Type | Description |
---|---|---|
|
| A string used to identify this record. Must be set to Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Calendar | All of the calendars in this collection. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.5 and later. |
Represents a CalDAV account used to subscribe to its calendars. For example, if you add a CalDAVAccount
record, iCal attempts to subscribe to it and if successful, display its calendars. There may be multiple CalDAVAccount
records.
Attribute | Type | Description |
---|---|---|
|
| A human-readable name for this account that iCal uses to represent this account and its group of calendars. Available in Mac OS X v10.5 and later. |
|
| Login name for this account. Available in Mac OS X v10.5 and later. |
|
| Full name of the user for this account. Available in Mac OS X v10.5 and later. |
|
| The URL for subscribing to this CalDAV account. Available in Mac OS X v10.5 and later. |
|
| A flag that indicates whether or not to use Kerberos to authenticate this account. Set to Available in Mac OS X v10.5 and later. |
|
| How often in seconds to refresh this account and its calendars in iCal. Available in Mac OS X v10.5 and later. |
|
| The order of this account’s group of calendars in the iCal display of calendars and groups.. Available in Mac OS X v10.5 and later. |
|
| A flag indicating whether or not the principal URI was automatically discovered by iCal. Set to Available in Mac OS X v10.5 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
An alarm that alerts the user of a pending event or task by displaying something. Below are the attributes and relationships of a DisplayAlarm record.
Attribute | Type | Description |
---|---|---|
|
| A description of this alarm. Available in Mac OS X v10.4 and later. |
|
| The number of times this alarm will repeat. Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between alarm repeats. Available in Mac OS X v10.4 and later. |
|
| The date/time this alarm will trigger. This is an absolute value. Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between this alarm and the reference date of Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event, Task | The event or task associated with this alarm. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents a scheduled event or activity that can be displayed on a calendar. Below are the attributes and relationships of an Event record.
Attribute | Type | Description |
---|---|---|
|
| A flag that indicates whether or not this event occurs all day. Set to Available in Mac OS X v10.4 and later. |
|
| The classification of this event. Possible values are Available in Mac OS X v10.4 and later. |
|
| A description of this event. Available in Mac OS X v10.4 and later. |
|
| The end date and time of this event. Available in Mac OS X v10.4 and later. |
|
| An array of calendar dates that are exceptions to the recurrence of this event—dates where this event will not occur. Available in Mac OS X v10.4 and later. |
|
| The date of the floating event in GMT time. Available in Mac OS X v10.5 and later. |
|
| The difference between the fixed date and GMT date of a floating event. Available in Mac OS X v10.5 and later. |
|
| The location where this event will take place. Available in Mac OS X v10.4 and later. |
|
| The original date of a detached event. When you create a recurrent event, a list of occurrences of the event are created. If you change a property of an occurrence of the event, it becomes detached and this attribute is used to record the original occurrence date. Available in Mac OS X v10.4 and later. |
|
| A number from Available in Mac OS X v10.4 and later. |
|
| The start date and time of this event. Available in Mac OS X v10.4 and later. |
|
| A string that indicates the status of this event. Possible values are Available in Mac OS X v10.4 and later. |
|
| A short description of this event. Available in Mac OS X v10.4 and later. |
|
| A link to a webpage about this event. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Attendee | People who are invited to attend this event. Available in Mac OS X v10.4 and later. |
| AudioAlarm | Audio alarms associated with this event. Available in Mac OS X v10.4 and later. |
| Calendar | The calendar this event belongs to. Available in Mac OS X v10.4 and later. |
| Event | Events that were detached from this (recurrent) event. Only detached events have a Available in Mac OS X v10.4 and later. |
| DisplayAlarm | Display alarms associated with this event. Available in Mac OS X v10.4 and later. |
| MailAlarm | Mail alarms associated with this event. Available in Mac OS X v10.4 and later. |
| Event | The parent event of this event. Used only if this is a detached event. Available in Mac OS X v10.4 and later. |
| Organizer | Person or organization that sponsored this event. Available in Mac OS X v10.4 and later. |
| Recurrence | Recurrence that contains frequency details about this event. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
An alarm that alerts the user of a pending event or task by sending email. Below are the attributes and relationships of a MailAlarm record.
Attribute | Type | Description |
---|---|---|
|
| Long description of this alarm. Available in Mac OS X v10.4 and later. |
|
| An array of strings representing email addresses that will receive notification of this alarm. Available in Mac OS X v10.4 and later. |
|
| The number of times this alarm will repeat. Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between alarm repeats. Available in Mac OS X v10.4 and later. |
|
| Short description of this alarm. Available in Mac OS X v10.4 and later. |
|
| The date/time this alarm will trigger. This is an absolute value. Available in Mac OS X v10.4 and later. |
|
| The delay, in seconds, between this alarm and the reference date of Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event, Task | The event or task associated with this alarm. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Person or organization who sponsors or creates an event or task. Below are the attributes and relationships of an Organizer record.
Attribute | Type | Description |
---|---|---|
|
| This organizer’s display name. Available in Mac OS X v10.4 and later. |
|
| This organizer’s directory entry in an LDAP database. The entry is a URL conforming to RFC 2255. See The LDAP URL Format for details. Available in Mac OS X v10.4 and later. |
|
| This organizer’s email address. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
owner | Event, Task | The event or task sponsored by this organizer. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Represents the details of the frequency of which an event or task may occur. Below are the attributes and relationships of a Recurrence record.
Attribute | Type | Description |
---|---|---|
|
| An array of strings representing the days of the week on which this recurrence occurs. Possible string values are Available in Mac OS X v10.4 and later. |
|
| An array of integer numbers used in combination with Available in Mac OS X v10.4 and later. |
|
| An array of numbers, with integer values ranging from Available in Mac OS X v10.4 and later. |
|
| An array of numbers, with integer values ranging from Available in Mac OS X v10.4 and later. |
|
| An array of integer numbers used to specify specific days within an expanded set of occurrences. The numbers specify the index of an expanded sequence of occurrences starting with Available in Mac OS X v10.4 and later. |
|
| An array of numbers, with integer values ranging from Available in Mac OS X v10.4 and later. |
|
| An array of numbers, with integer values ranging from Available in Mac OS X v10.4 and later. |
|
| The number of occurrences generated by this recurrence. Available in Mac OS X v10.4 and later. |
|
| The frequency of this recurrence specified by a constant. Possible values are Available in Mac OS X v10.4 and later. |
|
| A positive integer indicating how often the specified frequency repeats. For example, if Available in Mac OS X v10.4 and later. |
|
| The end date of this recurrence. Available in Mac OS X v10.4 and later. |
|
| A string that indicates the start day of the week. Possible values are Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Event, Task | The event or task in which this recurrence appears. Available in Mac OS X v10.4 and later. |
Entity name |
|
Data class |
|
Availability | Available in Mac OS X v10.4 and later. |
Something that you need to do or accomplish. Below are the attributes and relationships of a Task record.
Attribute | Type | Description |
---|---|---|
|
| A string that indicates the classification of this task. Possible values are Available in Mac OS X v10.4 and later. |
|
| The completion date/time of this task. Available in Mac OS X v10.4 and later. |
|
| A long description of this task. Available in Mac OS X v10.4 and later. |
|
| Due date/time of this task. If the date is specified but not the time, iCal defaults the time to 12:00 GMT/UTC. Available in Mac OS X v10.4 and later. |
|
| A flag that is set to Available in Mac OS X v10.4 and later. |
|
| An array of calendar dates that are exceptions to the recurrence of this event—dates when this event will not occur. Available in Mac OS X v10.4 and later. |
|
| The original date of a detached task. When you create a recurrent task, a list of occurrences of the task is created. If you change a property of an occurrence task, it becomes detached and this attribute is used to record the original occurrence date. Available in Mac OS X v10.4 and later. |
|
| A number from Available in Mac OS X v10.4 and later. |
|
| The start date of this task (must be a date-only value). Available in Mac OS X v10.4 and later. |
|
| A string that indicates the status of this task. Possible values are Available in Mac OS X v10.4 and later. |
|
| A short description of this task. Available in Mac OS X v10.4 and later. |
|
| A link to a webpage about this task. Available in Mac OS X v10.4 and later. |
Relationship | Targets | Description |
---|---|---|
| Attendee | People who will participate in this task. Available in Mac OS X v10.4 and later. |
| AudioAlarm | The audio alarms associated with this task. Available in Mac OS X v10.4 and later. |
| Calendar | The calendar this task belongs to. Available in Mac OS X v10.4 and later. |
| Task | Tasks that are detached from this task. Not used if this is not a recurrent task. Available in Mac OS X v10.4 and later. |
| DisplayAlarm | The display alarms associated with this task. Available in Mac OS X v10.4 and later. |
| MailAlarm | The mail alarms associated with this task. Available in Mac OS X v10.4 and later. |
| Task | The parent task of this task. Not used if this is not a detached task. Available in Mac OS X v10.4 and later. |
| Organizer | The person or organization that initiated this task. Available in Mac OS X v10.4 and later. |
| Recurrence | The recurrence that contains frequency details about this task. Available in Mac OS X v10.4 and later. |
Last updated: 2009-07-07