CalendarContract.Calendars

Class Overview

Constants and helpers for the Calendars table, which contains details for individual calendars.

Operations

All operations can be done either as an app or as a sync adapter. To perform an operation as a sync adapter CALLER_IS_SYNCADAPTER should be set to true and ACCOUNT_NAME and ACCOUNT_TYPE must be set in the Uri parameters. See appendQueryParameter(java.lang.String, java.lang.String) for details on adding parameters. Sync adapters have write access to more columns but are restricted to a single account at a time. Calendars are designed to be primarily managed by a sync adapter and inserting new calendars should be done as a sync adapter. For the most part, apps should only update calendars (such as changing the color or display name). If a local calendar is required an app can do so by inserting as a sync adapter and using an ACCOUNT_TYPE of ACCOUNT_TYPE_LOCAL .

Insert

When inserting a new calendar the following fields must be included:

• ACCOUNT_NAME
• ACCOUNT_TYPE
• NAME
• CALENDAR_DISPLAY_NAME
• CALENDAR_COLOR
• CALENDAR_ACCESS_LEVEL
• OWNER_ACCOUNT

The following fields are not required when inserting a Calendar but are generally a good idea to include:

• SYNC_EVENTS set to 1
• CALENDAR_TIME_ZONE
• ALLOWED_REMINDERS
• ALLOWED_AVAILABILITY
• ALLOWED_ATTENDEE_TYPES

Update

To perform an update on a calendar the _ID of the calendar should be provided either as an appended id to the Uri ( withAppendedId(Uri, long)) or as the first selection item--the selection should start with "_id=?" and the first selectionArg should be the _id of the calendar. Calendars may also be updated using a selection without the id. In general, the ACCOUNT_NAME and ACCOUNT_TYPE should not be changed after a calendar is created as this can cause issues for sync adapters.

Delete

Calendars can be deleted either by the _ID as an appended id on the Uri or using any standard selection. Deleting a calendar should generally be handled by a sync adapter as it will remove the calendar from the database and all associated data (aka events).

Query

Querying the Calendars table will get you all information about a set of calendars. There will be one row returned for each calendar that matches the query selection, or at most a single row if the _ID is appended to the Uri.

Calendar Columns

The following Calendar columns are writable by both an app and a sync adapter.

• NAME
• CALENDAR_DISPLAY_NAME
• VISIBLE
• SYNC_EVENTS

The following Calendars columns are writable only by a sync adapter

• ACCOUNT_NAME
• ACCOUNT_TYPE
• CALENDAR_COLOR
• _SYNC_ID
• DIRTY
• MUTATORS
• OWNER_ACCOUNT
• MAX_REMINDERS
• ALLOWED_REMINDERS
• ALLOWED_AVAILABILITY
• ALLOWED_ATTENDEE_TYPES
• CAN_MODIFY_TIME_ZONE
• CAN_ORGANIZER_RESPOND
• CAN_PARTIALLY_UPDATE
• CALENDAR_LOCATION
• CALENDAR_TIME_ZONE
• CALENDAR_ACCESS_LEVEL
• DELETED
• CAL_SYNC1
• CAL_SYNC2
• CAL_SYNC3
• CAL_SYNC4
• CAL_SYNC5
• CAL_SYNC6
• CAL_SYNC7
• CAL_SYNC8
• CAL_SYNC9
• CAL_SYNC10

Summary

Constants
String	CALENDAR_LOCATION	The default location for the calendar.
String	DEFAULT_SORT_ORDER	The default sort order for this table
String	NAME	The name of the calendar.

[Expand] Inherited Constants
From interface android.provider.BaseColumns String _COUNT The count of rows in a directory. String _ID The unique ID for a row.
From interface android.provider.CalendarContract.SyncColumns String ACCOUNT_NAME The account that was used to sync the entry to the device. String ACCOUNT_TYPE The type of the account that was used to sync the entry to the device. String CAN_PARTIALLY_UPDATE If set to 1 this causes events on this calendar to be duplicated with LAST_SYNCED set to 1 whenever the event transitions from non-dirty to dirty. String DELETED Whether the row has been deleted but not synced to the server. String DIRTY Used to indicate that local, unsynced, changes are present. String MUTATORS Used in conjunction with DIRTY to indicate what packages wrote local changes. String _SYNC_ID The unique ID for a row assigned by the sync source.
From interface android.provider.CalendarContract.CalendarColumns String ALLOWED_ATTENDEE_TYPES A comma separated list of attendee types supported for this calendar in the format "#,#,#". String ALLOWED_AVAILABILITY A comma separated list of availability types supported for this calendar in the format "#,#,#". String ALLOWED_REMINDERS A comma separated list of reminder methods supported for this calendar in the format "#,#,#". String CALENDAR_ACCESS_LEVEL The level of access that the user has for the calendar Type: INTEGER (one of the values below) String CALENDAR_COLOR The color of the calendar. String CALENDAR_COLOR_KEY A key for looking up a color from the CalendarContract.Colors table. String CALENDAR_DISPLAY_NAME The display name of the calendar. String CALENDAR_TIME_ZONE The time zone the calendar is associated with. int CAL_ACCESS_CONTRIBUTOR Full access to modify the calendar, but not the access control settings int CAL_ACCESS_EDITOR Full access to modify the calendar, but not the access control settings int CAL_ACCESS_FREEBUSY Can only see free/busy information about the calendar int CAL_ACCESS_NONE Cannot access the calendar int CAL_ACCESS_OVERRIDE not used int CAL_ACCESS_OWNER Full access to the calendar int CAL_ACCESS_READ Can read all event details int CAL_ACCESS_RESPOND Can reply yes/no/maybe to an event int CAL_ACCESS_ROOT Domain admin String CAN_MODIFY_TIME_ZONE Can the organizer modify the time zone of the event? Column name. String CAN_ORGANIZER_RESPOND Can the organizer respond to the event? If no, the status of the organizer should not be shown by the UI. String IS_PRIMARY Is this the primary calendar for this account. String MAX_REMINDERS The maximum number of reminders allowed for an event. String OWNER_ACCOUNT The owner account for this calendar, based on the calendar feed. String SYNC_EVENTS Is this calendar synced and are its events stored on the device? 0 - Do not sync this calendar or store events for this calendar. String VISIBLE Is the calendar selected to be displayed? 0 - do not show events associated with this calendar.
From interface android.provider.CalendarContract.CalendarSyncColumns String CAL_SYNC1 Generic column for use by sync adapters. String CAL_SYNC10 Generic column for use by sync adapters. String CAL_SYNC2 Generic column for use by sync adapters. String CAL_SYNC3 Generic column for use by sync adapters. String CAL_SYNC4 Generic column for use by sync adapters. String CAL_SYNC5 Generic column for use by sync adapters. String CAL_SYNC6 Generic column for use by sync adapters. String CAL_SYNC7 Generic column for use by sync adapters. String CAL_SYNC8 Generic column for use by sync adapters. String CAL_SYNC9 Generic column for use by sync adapters.

Fields
public static final Uri	CONTENT_URI	The content:// style URL for accessing Calendars

[Expand] Inherited Methods

From class java.lang.Object Object clone() Creates and returns a copy of this Object. boolean equals(Object o) Compares this instance with the specified object and indicates if they are equal. void finalize() Invoked when the garbage collector has detected that this instance is no longer reachable. final Class<?> getClass() Returns the unique instance of Class that represents this object's class. int hashCode() Returns an integer hash code for this object. final void notify() Causes a thread which is waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. final void notifyAll() Causes all threads which are waiting on this object's monitor (by means of calling one of the wait() methods) to be woken up. String toString() Returns a string containing a concise, human-readable description of this object. final void wait() Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object. final void wait(long millis, int nanos) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires. final void wait(long millis) Causes the calling thread to wait until another thread calls the notify() or notifyAll() method of this object or until the specified timeout expires.