/*
 * Copyright (C) 2006 The Android Open Source Project
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package android.provider;


import android.annotation.SdkConstant;
import android.annotation.SdkConstant.SdkConstantType;
import android.app.Activity;
import android.app.AlarmManager;
import android.app.PendingIntent;
import android.content.ContentProviderClient;
import android.content.ContentResolver;
import android.content.ContentUris;
import android.content.ContentValues;
import android.content.Context;
import android.content.CursorEntityIterator;
import android.content.Entity;
import android.content.EntityIterator;
import android.content.Intent;
import android.database.Cursor;
import android.database.DatabaseUtils;
import android.net.Uri;
import android.os.RemoteException;
import android.text.format.DateUtils;
import android.text.format.Time;
import android.util.Log;

The contract between the calendar provider and applications. Contains definitions for the supported URIs and data columns.

Overview

CalendarContract defines the data model of calendar and event related information. This data is stored in a number of tables:

  • The Calendars table holds the calendar specific information. Each row in this table contains the details for a single calendar, such as the name, color, sync info, etc.
  • The Events table holds the event specific information. Each row in this table has the info for a single event. It contains information such as event title, location, start time, end time, etc. The event can occur one-time or can recur multiple times. Attendees, reminders, and extended properties are stored on separate tables and reference the BaseColumns._ID to link them with the event.
  • The Instances table holds the start and end time for occurrences of an event. Each row in this table represents a single occurrence. For one-time events there will be a 1:1 mapping of instances to events. For recurring events, multiple rows will automatically be generated which correspond to multiple occurrences of that event.
  • The Attendees table holds the event attendee or guest information. Each row represents a single guest of an event. It specifies the type of guest they are and their attendance response for the event.
  • The Reminders table holds the alert/notification data. Each row represents a single alert for an event. An event can have multiple reminders. The number of reminders per event is specified in CalendarColumns.MAX_REMINDERS which is set by the Sync Adapter that owns the given calendar. Reminders are specified in minutes before the event and have a type.
  • The ExtendedProperties table holds opaque data fields used by the sync adapter. The provider takes no action with items in this table except to delete them when their related events are deleted.

Other tables include:

  • SyncState, which contains free-form data maintained by the sync adapters
/** * <p> * The contract between the calendar provider and applications. Contains * definitions for the supported URIs and data columns. * </p> * <h3>Overview</h3> * <p> * CalendarContract defines the data model of calendar and event related * information. This data is stored in a number of tables: * </p> * <ul> * <li>The {@link Calendars} table holds the calendar specific information. Each * row in this table contains the details for a single calendar, such as the * name, color, sync info, etc.</li> * <li>The {@link Events} table holds the event specific information. Each row * in this table has the info for a single event. It contains information such * as event title, location, start time, end time, etc. The event can occur * one-time or can recur multiple times. Attendees, reminders, and extended * properties are stored on separate tables and reference the {@link Events#_ID} * to link them with the event.</li> * <li>The {@link Instances} table holds the start and end time for occurrences * of an event. Each row in this table represents a single occurrence. For * one-time events there will be a 1:1 mapping of instances to events. For * recurring events, multiple rows will automatically be generated which * correspond to multiple occurrences of that event.</li> * <li>The {@link Attendees} table holds the event attendee or guest * information. Each row represents a single guest of an event. It specifies the * type of guest they are and their attendance response for the event.</li> * <li>The {@link Reminders} table holds the alert/notification data. Each row * represents a single alert for an event. An event can have multiple reminders. * The number of reminders per event is specified in * {@link Calendars#MAX_REMINDERS} which is set by the Sync Adapter that owns * the given calendar. Reminders are specified in minutes before the event and * have a type.</li> * <li>The {@link ExtendedProperties} table holds opaque data fields used by the * sync adapter. The provider takes no action with items in this table except to * delete them when their related events are deleted.</li> * </ul> * <p> * Other tables include: * </p> * <ul> * <li> * {@link SyncState}, which contains free-form data maintained by the sync * adapters</li> * </ul> * */
public final class CalendarContract { private static final String TAG = "Calendar";
Broadcast Action: This is the intent that gets fired when an alarm notification needs to be posted for a reminder.
/** * Broadcast Action: This is the intent that gets fired when an alarm * notification needs to be posted for a reminder. * */
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_EVENT_REMINDER = "android.intent.action.EVENT_REMINDER";
Activity Action: Display the event to the user in the custom app as specified in EventsColumns.CUSTOM_APP_PACKAGE. The custom app will be started via Activity.startActivityForResult(Intent, int) and it should call Activity.setResult(int) with Activity.RESULT_OK or Activity.RESULT_CANCELED to acknowledge whether the action was handled or not. The custom app should have an intent filter like the following:
<intent-filter>
   <action android:name="android.provider.calendar.action.HANDLE_CUSTOM_EVENT" />
   <category android:name="android.intent.category.DEFAULT" />
   <data android:mimeType="vnd.android.cursor.item/event" />
</intent-filter>

Input: Intent.getData has the event URI. The extra EXTRA_EVENT_BEGIN_TIME has the start time of the instance. The extra EXTRA_CUSTOM_APP_URI will have the EventsColumns.CUSTOM_APP_URI.

Output: Activity.RESULT_OK if this was handled; otherwise Activity.RESULT_CANCELED.

/** * Activity Action: Display the event to the user in the custom app as * specified in {@link EventsColumns#CUSTOM_APP_PACKAGE}. The custom app * will be started via {@link Activity#startActivityForResult(Intent, int)} * and it should call {@link Activity#setResult(int)} with * {@link Activity#RESULT_OK} or {@link Activity#RESULT_CANCELED} to * acknowledge whether the action was handled or not. * * The custom app should have an intent filter like the following: * <pre> * &lt;intent-filter&gt; * &lt;action android:name="android.provider.calendar.action.HANDLE_CUSTOM_EVENT" /&gt; * &lt;category android:name="android.intent.category.DEFAULT" /&gt; * &lt;data android:mimeType="vnd.android.cursor.item/event" /&gt; * &lt;/intent-filter&gt;</pre> * <p> * Input: {@link Intent#getData} has the event URI. The extra * {@link #EXTRA_EVENT_BEGIN_TIME} has the start time of the instance. The * extra {@link #EXTRA_CUSTOM_APP_URI} will have the * {@link EventsColumns#CUSTOM_APP_URI}. * <p> * Output: {@link Activity#RESULT_OK} if this was handled; otherwise * {@link Activity#RESULT_CANCELED}. */
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) public static final String ACTION_HANDLE_CUSTOM_EVENT = "android.provider.calendar.action.HANDLE_CUSTOM_EVENT";
Intent Extras key: EventsColumns.CUSTOM_APP_URI for the event in the ACTION_HANDLE_CUSTOM_EVENT intent
/** * Intent Extras key: {@link EventsColumns#CUSTOM_APP_URI} for the event in * the {@link #ACTION_HANDLE_CUSTOM_EVENT} intent */
public static final String EXTRA_CUSTOM_APP_URI = "customAppUri";
Intent Extras key: The start time of an event or an instance of a recurring event. (milliseconds since epoch)
/** * Intent Extras key: The start time of an event or an instance of a * recurring event. (milliseconds since epoch) */
public static final String EXTRA_EVENT_BEGIN_TIME = "beginTime";
Intent Extras key: The end time of an event or an instance of a recurring event. (milliseconds since epoch)
/** * Intent Extras key: The end time of an event or an instance of a recurring * event. (milliseconds since epoch) */
public static final String EXTRA_EVENT_END_TIME = "endTime";
Intent Extras key: When creating an event, set this to true to create an all-day event by default
/** * Intent Extras key: When creating an event, set this to true to create an * all-day event by default */
public static final String EXTRA_EVENT_ALL_DAY = "allDay";
This authority is used for writing to or querying from the calendar provider. Note: This is set at first run and cannot be changed without breaking apps that access the provider.
/** * This authority is used for writing to or querying from the calendar * provider. Note: This is set at first run and cannot be changed without * breaking apps that access the provider. */
public static final String AUTHORITY = "com.android.calendar";
The content:// style URL for the top-level calendar authority
/** * The content:// style URL for the top-level calendar authority */
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY);
An optional insert, update or delete URI parameter that allows the caller to specify that it is a sync adapter. The default value is false. If set to true, the modified row is not marked as "dirty" (needs to be synced) and when the provider calls ContentResolver.notifyChange(Uri, ContentObserver, boolean) , the third parameter "syncToNetwork" is set to false. Furthermore, if set to true, the caller must also include SyncColumns.ACCOUNT_NAME and SyncColumns.ACCOUNT_TYPE as query parameters.
See Also:
/** * An optional insert, update or delete URI parameter that allows the caller * to specify that it is a sync adapter. The default value is false. If set * to true, the modified row is not marked as "dirty" (needs to be synced) * and when the provider calls * {@link ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver, boolean)} * , the third parameter "syncToNetwork" is set to false. Furthermore, if * set to true, the caller must also include * {@link Calendars#ACCOUNT_NAME} and {@link Calendars#ACCOUNT_TYPE} as * query parameters. * * @see Uri.Builder#appendQueryParameter(java.lang.String, java.lang.String) */
public static final String CALLER_IS_SYNCADAPTER = "caller_is_syncadapter";
A special account type for calendars not associated with any account. Normally calendars that do not match an account on the device will be removed. Setting the account_type on a calendar to this will prevent it from being wiped if it does not match an existing account.
See Also:
  • ACCOUNT_TYPE.ACCOUNT_TYPE
/** * A special account type for calendars not associated with any account. * Normally calendars that do not match an account on the device will be * removed. Setting the account_type on a calendar to this will prevent it * from being wiped if it does not match an existing account. * * @see SyncColumns#ACCOUNT_TYPE */
public static final String ACCOUNT_TYPE_LOCAL = "LOCAL";
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private CalendarContract() {}
Generic columns for use by sync adapters. The specific functions of these columns are private to the sync adapter. Other clients of the API should not attempt to either read or write this column. These columns are editable as part of the Calendars Uri, but can only be read if accessed through any other Uri.
/** * Generic columns for use by sync adapters. The specific functions of these * columns are private to the sync adapter. Other clients of the API should * not attempt to either read or write this column. These columns are * editable as part of the Calendars Uri, but can only be read if accessed * through any other Uri. */
protected interface CalendarSyncColumns {
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC1 = "cal_sync1";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC2 = "cal_sync2";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC3 = "cal_sync3";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC4 = "cal_sync4";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC5 = "cal_sync5";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC6 = "cal_sync6";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC7 = "cal_sync7";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC8 = "cal_sync8";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC9 = "cal_sync9";
Generic column for use by sync adapters. Column name.

Type: TEXT

/** * Generic column for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String CAL_SYNC10 = "cal_sync10"; }
Columns for Sync information used by Calendars and Events tables. These have specific uses which are expected to be consistent by the app and sync adapter.
/** * Columns for Sync information used by Calendars and Events tables. These * have specific uses which are expected to be consistent by the app and * sync adapter. * */
protected interface SyncColumns extends CalendarSyncColumns {
The account that was used to sync the entry to the device. If the account_type is not CalendarContract.ACCOUNT_TYPE_LOCAL then the name and type must match an account on the device or the calendar will be deleted.

Type: TEXT

/** * The account that was used to sync the entry to the device. If the * account_type is not {@link #ACCOUNT_TYPE_LOCAL} then the name and * type must match an account on the device or the calendar will be * deleted. * <P>Type: TEXT</P> */
public static final String ACCOUNT_NAME = "account_name";
The type of the account that was used to sync the entry to the device. A type of CalendarContract.ACCOUNT_TYPE_LOCAL will keep this event form being deleted if there are no matching accounts on the device.

Type: TEXT

/** * The type of the account that was used to sync the entry to the * device. A type of {@link #ACCOUNT_TYPE_LOCAL} will keep this event * form being deleted if there are no matching accounts on the device. * <P>Type: TEXT</P> */
public static final String ACCOUNT_TYPE = "account_type";
The unique ID for a row assigned by the sync source. NULL if the row has never been synced. This is used as a reference id for exceptions along with BaseColumns._ID.

Type: TEXT

/** * The unique ID for a row assigned by the sync source. NULL if the row * has never been synced. This is used as a reference id for exceptions * along with {@link BaseColumns#_ID}. * <P>Type: TEXT</P> */
public static final String _SYNC_ID = "_sync_id";
Used to indicate that local, unsynced, changes are present.

Type: INTEGER (long)

/** * Used to indicate that local, unsynced, changes are present. * <P>Type: INTEGER (long)</P> */
public static final String DIRTY = "dirty";
Used in conjunction with DIRTY to indicate what packages wrote local changes.

Type: TEXT

/** * Used in conjunction with {@link #DIRTY} to indicate what packages wrote local changes. * <P>Type: TEXT</P> */
public static final String MUTATORS = "mutators";
Whether the row has been deleted but not synced to the server. A deleted row should be ignored.

Type: INTEGER (boolean)

/** * Whether the row has been deleted but not synced to the server. A * deleted row should be ignored. * <P> * Type: INTEGER (boolean) * </P> */
public static final String DELETED = "deleted";
If set to 1 this causes events on this calendar to be duplicated with EventsColumns.LAST_SYNCED set to 1 whenever the event transitions from non-dirty to dirty. The duplicated event will not be expanded in the instances table and will only show up in sync adapter queries of the events table. It will also be deleted when the originating event has its dirty flag cleared by the sync adapter.

Type: INTEGER (boolean)

/** * If set to 1 this causes events on this calendar to be duplicated with * {@link Events#LAST_SYNCED} set to 1 whenever the event * transitions from non-dirty to dirty. The duplicated event will not be * expanded in the instances table and will only show up in sync adapter * queries of the events table. It will also be deleted when the * originating event has its dirty flag cleared by the sync adapter. * <P>Type: INTEGER (boolean)</P> */
public static final String CAN_PARTIALLY_UPDATE = "canPartiallyUpdate"; }
Columns specific to the Calendars Uri that other Uris can query.
/** * Columns specific to the Calendars Uri that other Uris can query. */
protected interface CalendarColumns {
The color of the calendar. This should only be updated by the sync adapter, not other apps, as changing a calendar's color can adversely affect its display.

Type: INTEGER (color value)

/** * The color of the calendar. This should only be updated by the sync * adapter, not other apps, as changing a calendar's color can adversely * affect its display. * <P>Type: INTEGER (color value)</P> */
public static final String CALENDAR_COLOR = "calendar_color";
A key for looking up a color from the Colors table. NULL or an empty string are reserved for indicating that the calendar does not use a key for looking up the color. The provider will update CALENDAR_COLOR automatically when a valid key is written to this column. The key must reference an existing row of the Colors table. @see Colors

Type: TEXT

/** * A key for looking up a color from the {@link Colors} table. NULL or * an empty string are reserved for indicating that the calendar does * not use a key for looking up the color. The provider will update * {@link #CALENDAR_COLOR} automatically when a valid key is written to * this column. The key must reference an existing row of the * {@link Colors} table. @see Colors * <P> * Type: TEXT * </P> */
public static final String CALENDAR_COLOR_KEY = "calendar_color_index";
The display name of the calendar. Column name.

Type: TEXT

/** * The display name of the calendar. Column name. * <P> * Type: TEXT * </P> */
public static final String CALENDAR_DISPLAY_NAME = "calendar_displayName";
The level of access that the user has for the calendar

Type: INTEGER (one of the values below)

/** * The level of access that the user has for the calendar * <P>Type: INTEGER (one of the values below)</P> */
public static final String CALENDAR_ACCESS_LEVEL = "calendar_access_level";
Cannot access the calendar
/** Cannot access the calendar */
public static final int CAL_ACCESS_NONE = 0;
Can only see free/busy information about the calendar
/** Can only see free/busy information about the calendar */
public static final int CAL_ACCESS_FREEBUSY = 100;
Can read all event details
/** Can read all event details */
public static final int CAL_ACCESS_READ = 200;
Can reply yes/no/maybe to an event
/** Can reply yes/no/maybe to an event */
public static final int CAL_ACCESS_RESPOND = 300;
not used
/** not used */
public static final int CAL_ACCESS_OVERRIDE = 400;
Full access to modify the calendar, but not the access control settings
/** Full access to modify the calendar, but not the access control * settings */
public static final int CAL_ACCESS_CONTRIBUTOR = 500;
Full access to modify the calendar, but not the access control settings
/** Full access to modify the calendar, but not the access control * settings */
public static final int CAL_ACCESS_EDITOR = 600;
Full access to the calendar
/** Full access to the calendar */
public static final int CAL_ACCESS_OWNER = 700;
Domain admin
/** Domain admin */
public static final int CAL_ACCESS_ROOT = 800;
Is the calendar selected to be displayed? 0 - do not show events associated with this calendar. 1 - show events associated with this calendar

Type: INTEGER (boolean)

/** * Is the calendar selected to be displayed? * 0 - do not show events associated with this calendar. * 1 - show events associated with this calendar * <P>Type: INTEGER (boolean)</P> */
public static final String VISIBLE = "visible";
The time zone the calendar is associated with.

Type: TEXT

/** * The time zone the calendar is associated with. * <P>Type: TEXT</P> */
public static final String CALENDAR_TIME_ZONE = "calendar_timezone";
Is this calendar synced and are its events stored on the device? 0 - Do not sync this calendar or store events for this calendar. 1 - Sync down events for this calendar.

Type: INTEGER (boolean)

/** * Is this calendar synced and are its events stored on the device? * 0 - Do not sync this calendar or store events for this calendar. * 1 - Sync down events for this calendar. * <p>Type: INTEGER (boolean)</p> */
public static final String SYNC_EVENTS = "sync_events";
The owner account for this calendar, based on the calendar feed. This will be different from the _SYNC_ACCOUNT for delegated calendars. Column name.

Type: String

/** * The owner account for this calendar, based on the calendar feed. * This will be different from the _SYNC_ACCOUNT for delegated calendars. * Column name. * <P>Type: String</P> */
public static final String OWNER_ACCOUNT = "ownerAccount";
Can the organizer respond to the event? If no, the status of the organizer should not be shown by the UI. Defaults to 1. Column name.

Type: INTEGER (boolean)

/** * Can the organizer respond to the event? If no, the status of the * organizer should not be shown by the UI. Defaults to 1. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String CAN_ORGANIZER_RESPOND = "canOrganizerRespond";
Can the organizer modify the time zone of the event? Column name.

Type: INTEGER (boolean)

/** * Can the organizer modify the time zone of the event? Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String CAN_MODIFY_TIME_ZONE = "canModifyTimeZone";
The maximum number of reminders allowed for an event. Column name.

Type: INTEGER

/** * The maximum number of reminders allowed for an event. Column name. * <P>Type: INTEGER</P> */
public static final String MAX_REMINDERS = "maxReminders";
A comma separated list of reminder methods supported for this calendar in the format "#,#,#". Valid types are RemindersColumns.METHOD_DEFAULT, RemindersColumns.METHOD_ALERT, RemindersColumns.METHOD_EMAIL, RemindersColumns.METHOD_SMS, RemindersColumns.METHOD_ALARM. Column name.

Type: TEXT

/** * A comma separated list of reminder methods supported for this * calendar in the format "#,#,#". Valid types are * {@link Reminders#METHOD_DEFAULT}, {@link Reminders#METHOD_ALERT}, * {@link Reminders#METHOD_EMAIL}, {@link Reminders#METHOD_SMS}, * {@link Reminders#METHOD_ALARM}. Column name. * <P>Type: TEXT</P> */
public static final String ALLOWED_REMINDERS = "allowedReminders";
A comma separated list of availability types supported for this calendar in the format "#,#,#". Valid types are EventsColumns.AVAILABILITY_BUSY, EventsColumns.AVAILABILITY_FREE, AVAILABILITY_TENTATIVE.AVAILABILITY_TENTATIVE. Setting this field to only EventsColumns.AVAILABILITY_BUSY should be used to indicate that changing the availability is not supported.
/** * A comma separated list of availability types supported for this * calendar in the format "#,#,#". Valid types are * {@link Events#AVAILABILITY_BUSY}, {@link Events#AVAILABILITY_FREE}, * {@link Events#AVAILABILITY_TENTATIVE}. Setting this field to only * {@link Events#AVAILABILITY_BUSY} should be used to indicate that * changing the availability is not supported. * */
public static final String ALLOWED_AVAILABILITY = "allowedAvailability";
A comma separated list of attendee types supported for this calendar in the format "#,#,#". Valid types are AttendeesColumns.TYPE_NONE, AttendeesColumns.TYPE_OPTIONAL, AttendeesColumns.TYPE_REQUIRED, AttendeesColumns.TYPE_RESOURCE. Setting this field to only AttendeesColumns.TYPE_NONE should be used to indicate that changing the attendee type is not supported.
/** * A comma separated list of attendee types supported for this calendar * in the format "#,#,#". Valid types are {@link Attendees#TYPE_NONE}, * {@link Attendees#TYPE_OPTIONAL}, {@link Attendees#TYPE_REQUIRED}, * {@link Attendees#TYPE_RESOURCE}. Setting this field to only * {@link Attendees#TYPE_NONE} should be used to indicate that changing * the attendee type is not supported. * */
public static final String ALLOWED_ATTENDEE_TYPES = "allowedAttendeeTypes";
Is this the primary calendar for this account. If this column is not explicitly set, the provider will return 1 if SyncColumns.ACCOUNT_NAME is equal to OWNER_ACCOUNT.
/** * Is this the primary calendar for this account. If this column is not explicitly set, the * provider will return 1 if {@link Calendars#ACCOUNT_NAME} is equal to * {@link Calendars#OWNER_ACCOUNT}. */
public static final String IS_PRIMARY = "isPrimary"; }
Class that represents a Calendar Entity. There is one entry per calendar. This is a helper class to make batch operations easier.
/** * Class that represents a Calendar Entity. There is one entry per calendar. * This is a helper class to make batch operations easier. */
public static final class CalendarEntity implements BaseColumns, SyncColumns, CalendarColumns {
The default Uri used when creating a new calendar EntityIterator.
/** * The default Uri used when creating a new calendar EntityIterator. */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/calendar_entities");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private CalendarEntity() {}
Creates an entity iterator for the given cursor. It assumes the cursor contains a calendars query.
Params:
Returns:an EntityIterator of calendars
/** * Creates an entity iterator for the given cursor. It assumes the * cursor contains a calendars query. * * @param cursor query on {@link #CONTENT_URI} * @return an EntityIterator of calendars */
public static EntityIterator newEntityIterator(Cursor cursor) { return new EntityIteratorImpl(cursor); } private static class EntityIteratorImpl extends CursorEntityIterator { public EntityIteratorImpl(Cursor cursor) { super(cursor); } @Override public Entity getEntityAndIncrementCursor(Cursor cursor) throws RemoteException { // we expect the cursor is already at the row we need to read from final long calendarId = cursor.getLong(cursor.getColumnIndexOrThrow(_ID)); // Create the content value ContentValues cv = new ContentValues(); cv.put(_ID, calendarId); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ACCOUNT_NAME); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ACCOUNT_TYPE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, _SYNC_ID); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DIRTY); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, MUTATORS); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC1); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC2); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC3); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC4); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC5); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC6); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC7); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC8); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC9); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC10); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.NAME); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.CALENDAR_DISPLAY_NAME); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, Calendars.CALENDAR_COLOR); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.CALENDAR_COLOR_KEY); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, CALENDAR_ACCESS_LEVEL); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, VISIBLE); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, SYNC_EVENTS); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.CALENDAR_LOCATION); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CALENDAR_TIME_ZONE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.OWNER_ACCOUNT); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, Calendars.CAN_ORGANIZER_RESPOND); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, Calendars.CAN_MODIFY_TIME_ZONE); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, Calendars.MAX_REMINDERS); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, Calendars.CAN_PARTIALLY_UPDATE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.ALLOWED_REMINDERS); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, DELETED); // Create the Entity from the ContentValue Entity entity = new Entity(cv); // Set cursor to next row cursor.moveToNext(); // Return the created Entity return entity; } } }
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 CalendarContract.CALLER_IS_SYNCADAPTER should be set to true and SyncColumns.ACCOUNT_NAME and SyncColumns.ACCOUNT_TYPE must be set in the Uri parameters. See Builder.appendQueryParameter(String, 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 SyncColumns.ACCOUNT_TYPE of CalendarContract.ACCOUNT_TYPE_LOCAL .
Insert
When inserting a new calendar the following fields must be included: The following fields are not required when inserting a Calendar but are generally a good idea to include:
Update
To perform an update on a calendar the BaseColumns._ID of the calendar should be provided either as an appended id to the Uri ( ContentUris.withAppendedId) 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 SyncColumns.ACCOUNT_NAME and SyncColumns.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 BaseColumns._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 BaseColumns._ID is appended to the Uri.

Calendar Columns

The following Calendar columns are writable by both an app and a sync adapter. The following Calendars columns are writable only by a sync adapter
/** * Constants and helpers for the Calendars table, which contains details for * individual calendars. <h3>Operations</h3> All operations can be done * either as an app or as a sync adapter. To perform an operation as a sync * adapter {@link #CALLER_IS_SYNCADAPTER} should be set to true and * {@link #ACCOUNT_NAME} and {@link #ACCOUNT_TYPE} must be set in the Uri * parameters. See * {@link Uri.Builder#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 {@link #ACCOUNT_TYPE} of * {@link #ACCOUNT_TYPE_LOCAL} . * <dl> * <dt><b>Insert</b></dt> * <dd>When inserting a new calendar the following fields must be included: * <ul> * <li>{@link #ACCOUNT_NAME}</li> * <li>{@link #ACCOUNT_TYPE}</li> * <li>{@link #NAME}</li> * <li>{@link #CALENDAR_DISPLAY_NAME}</li> * <li>{@link #CALENDAR_COLOR}</li> * <li>{@link #CALENDAR_ACCESS_LEVEL}</li> * <li>{@link #OWNER_ACCOUNT}</li> * </ul> * The following fields are not required when inserting a Calendar but are * generally a good idea to include: * <ul> * <li>{@link #SYNC_EVENTS} set to 1</li> * <li>{@link #CALENDAR_TIME_ZONE}</li> * <li>{@link #ALLOWED_REMINDERS}</li> * <li>{@link #ALLOWED_AVAILABILITY}</li> * <li>{@link #ALLOWED_ATTENDEE_TYPES}</li> * </ul> * <dt><b>Update</b></dt> * <dd>To perform an update on a calendar the {@link #_ID} of the calendar * should be provided either as an appended id to the Uri ( * {@link ContentUris#withAppendedId}) 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 {@link #ACCOUNT_NAME} and * {@link #ACCOUNT_TYPE} should not be changed after a calendar is created * as this can cause issues for sync adapters. * <dt><b>Delete</b></dt> * <dd>Calendars can be deleted either by the {@link #_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).</dd> * <dt><b>Query</b></dt> * <dd>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 {@link #_ID} * is appended to the Uri.</dd> * </dl> * <h3>Calendar Columns</h3> The following Calendar columns are writable by * both an app and a sync adapter. * <ul> * <li>{@link #NAME}</li> * <li>{@link #CALENDAR_DISPLAY_NAME}</li> * <li>{@link #VISIBLE}</li> * <li>{@link #SYNC_EVENTS}</li> * </ul> * The following Calendars columns are writable only by a sync adapter * <ul> * <li>{@link #ACCOUNT_NAME}</li> * <li>{@link #ACCOUNT_TYPE}</li> * <li>{@link #CALENDAR_COLOR}</li> * <li>{@link #_SYNC_ID}</li> * <li>{@link #DIRTY}</li> * <li>{@link #MUTATORS}</li> * <li>{@link #OWNER_ACCOUNT}</li> * <li>{@link #MAX_REMINDERS}</li> * <li>{@link #ALLOWED_REMINDERS}</li> * <li>{@link #ALLOWED_AVAILABILITY}</li> * <li>{@link #ALLOWED_ATTENDEE_TYPES}</li> * <li>{@link #CAN_MODIFY_TIME_ZONE}</li> * <li>{@link #CAN_ORGANIZER_RESPOND}</li> * <li>{@link #CAN_PARTIALLY_UPDATE}</li> * <li>{@link #CALENDAR_LOCATION}</li> * <li>{@link #CALENDAR_TIME_ZONE}</li> * <li>{@link #CALENDAR_ACCESS_LEVEL}</li> * <li>{@link #DELETED}</li> * <li>{@link #CAL_SYNC1}</li> * <li>{@link #CAL_SYNC2}</li> * <li>{@link #CAL_SYNC3}</li> * <li>{@link #CAL_SYNC4}</li> * <li>{@link #CAL_SYNC5}</li> * <li>{@link #CAL_SYNC6}</li> * <li>{@link #CAL_SYNC7}</li> * <li>{@link #CAL_SYNC8}</li> * <li>{@link #CAL_SYNC9}</li> * <li>{@link #CAL_SYNC10}</li> * </ul> */
public static final class Calendars implements BaseColumns, SyncColumns, CalendarColumns {
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Calendars() {}
The content:// style URL for accessing Calendars
/** * The content:// style URL for accessing Calendars */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/calendars");
The default sort order for this table
/** * The default sort order for this table */
public static final String DEFAULT_SORT_ORDER = CALENDAR_DISPLAY_NAME;
The name of the calendar. Column name.

Type: TEXT

/** * The name of the calendar. Column name. * <P>Type: TEXT</P> */
public static final String NAME = "name";
The default location for the calendar. Column name.

Type: TEXT

/** * The default location for the calendar. Column name. * <P>Type: TEXT</P> */
public static final String CALENDAR_LOCATION = "calendar_location";
These fields are only writable by a sync adapter. To modify them the caller must include CalendarContract.CALLER_IS_SYNCADAPTER, SyncColumns.ACCOUNT_NAME, and SyncColumns.ACCOUNT_TYPE in the Uri's query parameters. TODO move to provider
@hide
/** * These fields are only writable by a sync adapter. To modify them the * caller must include {@link #CALLER_IS_SYNCADAPTER}, * {@link #ACCOUNT_NAME}, and {@link #ACCOUNT_TYPE} in the Uri's query * parameters. TODO move to provider * * @hide */
public static final String[] SYNC_WRITABLE_COLUMNS = new String[] { ACCOUNT_NAME, ACCOUNT_TYPE, _SYNC_ID, DIRTY, MUTATORS, OWNER_ACCOUNT, MAX_REMINDERS, ALLOWED_REMINDERS, 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, }; }
Columns from the Attendees table that other tables join into themselves.
/** * Columns from the Attendees table that other tables join into themselves. */
protected interface AttendeesColumns {
The id of the event. Column name.

Type: INTEGER

/** * The id of the event. Column name. * <P>Type: INTEGER</P> */
public static final String EVENT_ID = "event_id";
The name of the attendee. Column name.

Type: STRING

/** * The name of the attendee. Column name. * <P>Type: STRING</P> */
public static final String ATTENDEE_NAME = "attendeeName";
The email address of the attendee. Column name.

Type: STRING

/** * The email address of the attendee. Column name. * <P>Type: STRING</P> */
public static final String ATTENDEE_EMAIL = "attendeeEmail";
The relationship of the attendee to the user. Column name.

Type: INTEGER (one of RELATIONSHIP_ATTENDEE, ...}.

/** * The relationship of the attendee to the user. Column name. * <P>Type: INTEGER (one of {@link #RELATIONSHIP_ATTENDEE}, ...}.</P> */
public static final String ATTENDEE_RELATIONSHIP = "attendeeRelationship"; public static final int RELATIONSHIP_NONE = 0; public static final int RELATIONSHIP_ATTENDEE = 1; public static final int RELATIONSHIP_ORGANIZER = 2; public static final int RELATIONSHIP_PERFORMER = 3; public static final int RELATIONSHIP_SPEAKER = 4;
The type of attendee. Column name.

Type: Integer (one of TYPE_NONE, TYPE_REQUIRED, TYPE_OPTIONAL, TYPE_RESOURCE)

/** * The type of attendee. Column name. * <P> * Type: Integer (one of {@link #TYPE_NONE}, {@link #TYPE_REQUIRED}, * {@link #TYPE_OPTIONAL}, {@link #TYPE_RESOURCE}) * </P> */
public static final String ATTENDEE_TYPE = "attendeeType"; public static final int TYPE_NONE = 0; public static final int TYPE_REQUIRED = 1; public static final int TYPE_OPTIONAL = 2;
This specifies that an attendee is a resource, like a room, a cabbage, or something and not an actual person.
/** * This specifies that an attendee is a resource, like a room, a * cabbage, or something and not an actual person. */
public static final int TYPE_RESOURCE = 3;
The attendance status of the attendee. Column name.

Type: Integer (one of ATTENDEE_STATUS_ACCEPTED, ...).

/** * The attendance status of the attendee. Column name. * <P>Type: Integer (one of {@link #ATTENDEE_STATUS_ACCEPTED}, ...).</P> */
public static final String ATTENDEE_STATUS = "attendeeStatus"; public static final int ATTENDEE_STATUS_NONE = 0; public static final int ATTENDEE_STATUS_ACCEPTED = 1; public static final int ATTENDEE_STATUS_DECLINED = 2; public static final int ATTENDEE_STATUS_INVITED = 3; public static final int ATTENDEE_STATUS_TENTATIVE = 4;
The identity of the attendee as referenced in Identity.IDENTITY. This is required only if ATTENDEE_ID_NAMESPACE is present. Column name.

Type: STRING

/** * The identity of the attendee as referenced in * {@link ContactsContract.CommonDataKinds.Identity#IDENTITY}. * This is required only if {@link #ATTENDEE_ID_NAMESPACE} is present. Column name. * <P>Type: STRING</P> */
public static final String ATTENDEE_IDENTITY = "attendeeIdentity";
The identity name space of the attendee as referenced in Identity.NAMESPACE. This is required only if ATTENDEE_IDENTITY is present. Column name.

Type: STRING

/** * The identity name space of the attendee as referenced in * {@link ContactsContract.CommonDataKinds.Identity#NAMESPACE}. * This is required only if {@link #ATTENDEE_IDENTITY} is present. Column name. * <P>Type: STRING</P> */
public static final String ATTENDEE_ID_NAMESPACE = "attendeeIdNamespace"; }
Fields and helpers for interacting with Attendees. Each row of this table represents a single attendee or guest of an event. Calling query(ContentResolver, long, String[]) will return a list of attendees for the event with the given eventId. Both apps and sync adapters may write to this table. There are six writable fields and all of them except AttendeesColumns.ATTENDEE_NAME must be included when inserting a new attendee. They are:
/** * Fields and helpers for interacting with Attendees. Each row of this table * represents a single attendee or guest of an event. Calling * {@link #query(ContentResolver, long, String[])} will return a list of attendees for * the event with the given eventId. Both apps and sync adapters may write * to this table. There are six writable fields and all of them except * {@link #ATTENDEE_NAME} must be included when inserting a new attendee. * They are: * <ul> * <li>{@link #EVENT_ID}</li> * <li>{@link #ATTENDEE_NAME}</li> * <li>{@link #ATTENDEE_EMAIL}</li> * <li>{@link #ATTENDEE_RELATIONSHIP}</li> * <li>{@link #ATTENDEE_TYPE}</li> * <li>{@link #ATTENDEE_STATUS}</li> * <li>{@link #ATTENDEE_IDENTITY}</li> * <li>{@link #ATTENDEE_ID_NAMESPACE}</li> * </ul> */
public static final class Attendees implements BaseColumns, AttendeesColumns, EventsColumns {
The content:// style URL for accessing Attendees data
/** * The content:// style URL for accessing Attendees data */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/attendees"); private static final String ATTENDEES_WHERE = Attendees.EVENT_ID + "=?";
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Attendees() {}
Queries all attendees associated with the given event. This is a blocking call and should not be done on the UI thread.
Params:
  • cr – The content resolver to use for the query
  • eventId – The id of the event to retrieve attendees for
  • projection – the columns to return in the cursor
Returns:A Cursor containing all attendees for the event
/** * Queries all attendees associated with the given event. This is a * blocking call and should not be done on the UI thread. * * @param cr The content resolver to use for the query * @param eventId The id of the event to retrieve attendees for * @param projection the columns to return in the cursor * @return A Cursor containing all attendees for the event */
public static final Cursor query(ContentResolver cr, long eventId, String[] projection) { String[] attArgs = {Long.toString(eventId)}; return cr.query(CONTENT_URI, projection, ATTENDEES_WHERE, attArgs /* selection args */, null /* sort order */); } }
Columns from the Events table that other tables join into themselves.
/** * Columns from the Events table that other tables join into themselves. */
protected interface EventsColumns {
The BaseColumns._ID of the calendar the event belongs to. Column name.

Type: INTEGER

/** * The {@link Calendars#_ID} of the calendar the event belongs to. * Column name. * <P>Type: INTEGER</P> */
public static final String CALENDAR_ID = "calendar_id";
The title of the event. Column name.

Type: TEXT

/** * The title of the event. Column name. * <P>Type: TEXT</P> */
public static final String TITLE = "title";
The description of the event. Column name.

Type: TEXT

/** * The description of the event. Column name. * <P>Type: TEXT</P> */
public static final String DESCRIPTION = "description";
Where the event takes place. Column name.

Type: TEXT

/** * Where the event takes place. Column name. * <P>Type: TEXT</P> */
public static final String EVENT_LOCATION = "eventLocation";
A secondary color for the individual event. This should only be updated by the sync adapter for a given account.

Type: INTEGER

/** * A secondary color for the individual event. This should only be * updated by the sync adapter for a given account. * <P>Type: INTEGER</P> */
public static final String EVENT_COLOR = "eventColor";
A secondary color key for the individual event. NULL or an empty string are reserved for indicating that the event does not use a key for looking up the color. The provider will update EVENT_COLOR automatically when a valid key is written to this column. The key must reference an existing row of the Colors table. @see Colors

Type: TEXT

/** * A secondary color key for the individual event. NULL or an empty * string are reserved for indicating that the event does not use a key * for looking up the color. The provider will update * {@link #EVENT_COLOR} automatically when a valid key is written to * this column. The key must reference an existing row of the * {@link Colors} table. @see Colors * <P> * Type: TEXT * </P> */
public static final String EVENT_COLOR_KEY = "eventColor_index";
This will be EVENT_COLOR if it is not null; otherwise, this will be CalendarColumns.CALENDAR_COLOR. Read-only value. To modify, write to EVENT_COLOR or CalendarColumns.CALENDAR_COLOR directly.

Type: INTEGER

/** * This will be {@link #EVENT_COLOR} if it is not null; otherwise, this will be * {@link Calendars#CALENDAR_COLOR}. * Read-only value. To modify, write to {@link #EVENT_COLOR} or * {@link Calendars#CALENDAR_COLOR} directly. *<P> * Type: INTEGER *</P> */
public static final String DISPLAY_COLOR = "displayColor";
The event status. Column name.

Type: INTEGER (one of STATUS_TENTATIVE...)

/** * The event status. Column name. * <P>Type: INTEGER (one of {@link #STATUS_TENTATIVE}...)</P> */
public static final String STATUS = "eventStatus"; public static final int STATUS_TENTATIVE = 0; public static final int STATUS_CONFIRMED = 1; public static final int STATUS_CANCELED = 2;
This is a copy of the attendee status for the owner of this event. This field is copied here so that we can efficiently filter out events that are declined without having to look in the Attendees table. Column name.

Type: INTEGER (int)

/** * This is a copy of the attendee status for the owner of this event. * This field is copied here so that we can efficiently filter out * events that are declined without having to look in the Attendees * table. Column name. * * <P>Type: INTEGER (int)</P> */
public static final String SELF_ATTENDEE_STATUS = "selfAttendeeStatus";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA1 = "sync_data1";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA2 = "sync_data2";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA3 = "sync_data3";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA4 = "sync_data4";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA5 = "sync_data5";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA6 = "sync_data6";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA7 = "sync_data7";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA8 = "sync_data8";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA9 = "sync_data9";
This column is available for use by sync adapters. Column name.

Type: TEXT

/** * This column is available for use by sync adapters. Column name. * <P>Type: TEXT</P> */
public static final String SYNC_DATA10 = "sync_data10";
Used to indicate that a row is not a real event but an original copy of a locally modified event. A copy is made when an event changes from non-dirty to dirty and the event is on a calendar with SyncColumns.CAN_PARTIALLY_UPDATE set to 1. This copy does not get expanded in the instances table and is only visible in queries made by a sync adapter. The copy gets removed when the event is changed back to non-dirty by a sync adapter.

Type: INTEGER (boolean)

/** * Used to indicate that a row is not a real event but an original copy of a locally * modified event. A copy is made when an event changes from non-dirty to dirty and the * event is on a calendar with {@link Calendars#CAN_PARTIALLY_UPDATE} set to 1. This copy * does not get expanded in the instances table and is only visible in queries made by a * sync adapter. The copy gets removed when the event is changed back to non-dirty by a * sync adapter. * <P>Type: INTEGER (boolean)</P> */
public static final String LAST_SYNCED = "lastSynced";
The time the event starts in UTC millis since epoch. Column name.

Type: INTEGER (long; millis since epoch)

/** * The time the event starts in UTC millis since epoch. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String DTSTART = "dtstart";
The time the event ends in UTC millis since epoch. Column name.

Type: INTEGER (long; millis since epoch)

/** * The time the event ends in UTC millis since epoch. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String DTEND = "dtend";
The duration of the event in RFC2445 format. Column name.

Type: TEXT (duration in RFC2445 format)

/** * The duration of the event in RFC2445 format. Column name. * <P>Type: TEXT (duration in RFC2445 format)</P> */
public static final String DURATION = "duration";
The timezone for the event. Column name.

Type: TEXT

/** * The timezone for the event. Column name. * <P>Type: TEXT</P> */
public static final String EVENT_TIMEZONE = "eventTimezone";
The timezone for the end time of the event. Column name.

Type: TEXT

/** * The timezone for the end time of the event. Column name. * <P>Type: TEXT</P> */
public static final String EVENT_END_TIMEZONE = "eventEndTimezone";
Is the event all day (time zone independent). Column name.

Type: INTEGER (boolean)

/** * Is the event all day (time zone independent). Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String ALL_DAY = "allDay";
Defines how the event shows up for others when the calendar is shared. Column name.

Type: INTEGER (One of ACCESS_DEFAULT, ...)

/** * Defines how the event shows up for others when the calendar is * shared. Column name. * <P>Type: INTEGER (One of {@link #ACCESS_DEFAULT}, ...)</P> */
public static final String ACCESS_LEVEL = "accessLevel";
Default access is controlled by the server and will be treated as public on the device.
/** * Default access is controlled by the server and will be treated as * public on the device. */
public static final int ACCESS_DEFAULT = 0;
Confidential is not used by the app.
/** * Confidential is not used by the app. */
public static final int ACCESS_CONFIDENTIAL = 1;
Private shares the event as a free/busy slot with no details.
/** * Private shares the event as a free/busy slot with no details. */
public static final int ACCESS_PRIVATE = 2;
Public makes the contents visible to anyone with access to the calendar.
/** * Public makes the contents visible to anyone with access to the * calendar. */
public static final int ACCESS_PUBLIC = 3;
If this event counts as busy time or is still free time that can be scheduled over. Column name.

Type: INTEGER (One of AVAILABILITY_BUSY, AVAILABILITY_FREE, AVAILABILITY_TENTATIVE)

/** * If this event counts as busy time or is still free time that can be * scheduled over. Column name. * <P> * Type: INTEGER (One of {@link #AVAILABILITY_BUSY}, * {@link #AVAILABILITY_FREE}, {@link #AVAILABILITY_TENTATIVE}) * </P> */
public static final String AVAILABILITY = "availability";
Indicates that this event takes up time and will conflict with other events.
/** * Indicates that this event takes up time and will conflict with other * events. */
public static final int AVAILABILITY_BUSY = 0;
Indicates that this event is free time and will not conflict with other events.
/** * Indicates that this event is free time and will not conflict with * other events. */
public static final int AVAILABILITY_FREE = 1;
Indicates that the owner's availability may change, but should be considered busy time that will conflict.
/** * Indicates that the owner's availability may change, but should be * considered busy time that will conflict. */
public static final int AVAILABILITY_TENTATIVE = 2;
Whether the event has an alarm or not. Column name.

Type: INTEGER (boolean)

/** * Whether the event has an alarm or not. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String HAS_ALARM = "hasAlarm";
Whether the event has extended properties or not. Column name.

Type: INTEGER (boolean)

/** * Whether the event has extended properties or not. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String HAS_EXTENDED_PROPERTIES = "hasExtendedProperties";
The recurrence rule for the event. Column name.

Type: TEXT

/** * The recurrence rule for the event. Column name. * <P>Type: TEXT</P> */
public static final String RRULE = "rrule";
The recurrence dates for the event. Column name.

Type: TEXT

/** * The recurrence dates for the event. Column name. * <P>Type: TEXT</P> */
public static final String RDATE = "rdate";
The recurrence exception rule for the event. Column name.

Type: TEXT

/** * The recurrence exception rule for the event. Column name. * <P>Type: TEXT</P> */
public static final String EXRULE = "exrule";
The recurrence exception dates for the event. Column name.

Type: TEXT

/** * The recurrence exception dates for the event. Column name. * <P>Type: TEXT</P> */
public static final String EXDATE = "exdate";
The BaseColumns._ID of the original recurring event for which this event is an exception. Column name.

Type: TEXT

/** * The {@link Events#_ID} of the original recurring event for which this * event is an exception. Column name. * <P>Type: TEXT</P> */
public static final String ORIGINAL_ID = "original_id";
The _sync_id of the original recurring event for which this event is an exception. The provider should keep the original_id in sync when this is updated. Column name.

Type: TEXT

/** * The _sync_id of the original recurring event for which this event is * an exception. The provider should keep the original_id in sync when * this is updated. Column name. * <P>Type: TEXT</P> */
public static final String ORIGINAL_SYNC_ID = "original_sync_id";
The original instance time of the recurring event for which this event is an exception. Column name.

Type: INTEGER (long; millis since epoch)

/** * The original instance time of the recurring event for which this * event is an exception. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String ORIGINAL_INSTANCE_TIME = "originalInstanceTime";
The allDay status (true or false) of the original recurring event for which this event is an exception. Column name.

Type: INTEGER (boolean)

/** * The allDay status (true or false) of the original recurring event * for which this event is an exception. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String ORIGINAL_ALL_DAY = "originalAllDay";
The last date this event repeats on, or NULL if it never ends. Column name.

Type: INTEGER (long; millis since epoch)

/** * The last date this event repeats on, or NULL if it never ends. Column * name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String LAST_DATE = "lastDate";
Whether the event has attendee information. True if the event has full attendee data, false if the event has information about self only. Column name.

Type: INTEGER (boolean)

/** * Whether the event has attendee information. True if the event * has full attendee data, false if the event has information about * self only. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String HAS_ATTENDEE_DATA = "hasAttendeeData";
Whether guests can modify the event. Column name.

Type: INTEGER (boolean)

/** * Whether guests can modify the event. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String GUESTS_CAN_MODIFY = "guestsCanModify";
Whether guests can invite other guests. Column name.

Type: INTEGER (boolean)

/** * Whether guests can invite other guests. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String GUESTS_CAN_INVITE_OTHERS = "guestsCanInviteOthers";
Whether guests can see the list of attendees. Column name.

Type: INTEGER (boolean)

/** * Whether guests can see the list of attendees. Column name. * <P>Type: INTEGER (boolean)</P> */
public static final String GUESTS_CAN_SEE_GUESTS = "guestsCanSeeGuests";
Email of the organizer (owner) of the event. Column name.

Type: STRING

/** * Email of the organizer (owner) of the event. Column name. * <P>Type: STRING</P> */
public static final String ORGANIZER = "organizer";
Are we the organizer of this event. If this column is not explicitly set, the provider will return 1 if ORGANIZER is equal to CalendarColumns.OWNER_ACCOUNT. Column name.

Type: STRING

/** * Are we the organizer of this event. If this column is not explicitly set, the provider * will return 1 if {@link #ORGANIZER} is equal to {@link Calendars#OWNER_ACCOUNT}. * Column name. * <P>Type: STRING</P> */
public static final String IS_ORGANIZER = "isOrganizer";
Whether the user can invite others to the event. The GUESTS_CAN_INVITE_OTHERS is a setting that applies to an arbitrary guest, while CAN_INVITE_OTHERS indicates if the user can invite others (either through GUESTS_CAN_INVITE_OTHERS or because the user has modify access to the event). Column name.

Type: INTEGER (boolean, readonly)

/** * Whether the user can invite others to the event. The * GUESTS_CAN_INVITE_OTHERS is a setting that applies to an arbitrary * guest, while CAN_INVITE_OTHERS indicates if the user can invite * others (either through GUESTS_CAN_INVITE_OTHERS or because the user * has modify access to the event). Column name. * <P>Type: INTEGER (boolean, readonly)</P> */
public static final String CAN_INVITE_OTHERS = "canInviteOthers";
The package name of the custom app that can provide a richer experience for the event. See the ACTION TYPE CalendarContract.ACTION_HANDLE_CUSTOM_EVENT for details. Column name.

Type: TEXT

/** * The package name of the custom app that can provide a richer * experience for the event. See the ACTION TYPE * {@link CalendarContract#ACTION_HANDLE_CUSTOM_EVENT} for details. * Column name. * <P> Type: TEXT </P> */
public static final String CUSTOM_APP_PACKAGE = "customAppPackage";
The URI used by the custom app for the event. Column name.

Type: TEXT

/** * The URI used by the custom app for the event. Column name. * <P>Type: TEXT</P> */
public static final String CUSTOM_APP_URI = "customAppUri";
The UID for events added from the RFC 2445 iCalendar format. Column name.

Type: TEXT

/** * The UID for events added from the RFC 2445 iCalendar format. * Column name. * <P>Type: TEXT</P> */
public static final String UID_2445 = "uid2445"; }
Class that represents an Event Entity. There is one entry per event. Recurring events show up as a single entry. This is a helper class to make batch operations easier. A ContentResolver or ContentProviderClient is required as the helper does additional queries to add reminders and attendees to each entry.
/** * Class that represents an Event Entity. There is one entry per event. * Recurring events show up as a single entry. This is a helper class to * make batch operations easier. A {@link ContentResolver} or * {@link ContentProviderClient} is required as the helper does additional * queries to add reminders and attendees to each entry. */
public static final class EventsEntity implements BaseColumns, SyncColumns, EventsColumns {
The content:// style URL for this table
/** * The content:// style URL for this table */
public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/event_entities");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private EventsEntity() {}
Creates a new iterator for events
Params:
  • cursor – An event query
  • resolver – For performing additional queries
Returns:an EntityIterator containing one entity per event in the cursor
/** * Creates a new iterator for events * * @param cursor An event query * @param resolver For performing additional queries * @return an EntityIterator containing one entity per event in the * cursor */
public static EntityIterator newEntityIterator(Cursor cursor, ContentResolver resolver) { return new EntityIteratorImpl(cursor, resolver); }
Creates a new iterator for events
Params:
  • cursor – An event query
  • provider – For performing additional queries
Returns:an EntityIterator containing one entity per event in the cursor
/** * Creates a new iterator for events * * @param cursor An event query * @param provider For performing additional queries * @return an EntityIterator containing one entity per event in the * cursor */
public static EntityIterator newEntityIterator(Cursor cursor, ContentProviderClient provider) { return new EntityIteratorImpl(cursor, provider); } private static class EntityIteratorImpl extends CursorEntityIterator { private final ContentResolver mResolver; private final ContentProviderClient mProvider; private static final String[] REMINDERS_PROJECTION = new String[] { Reminders.MINUTES, Reminders.METHOD, }; private static final int COLUMN_MINUTES = 0; private static final int COLUMN_METHOD = 1; private static final String[] ATTENDEES_PROJECTION = new String[] { Attendees.ATTENDEE_NAME, Attendees.ATTENDEE_EMAIL, Attendees.ATTENDEE_RELATIONSHIP, Attendees.ATTENDEE_TYPE, Attendees.ATTENDEE_STATUS, Attendees.ATTENDEE_IDENTITY, Attendees.ATTENDEE_ID_NAMESPACE }; private static final int COLUMN_ATTENDEE_NAME = 0; private static final int COLUMN_ATTENDEE_EMAIL = 1; private static final int COLUMN_ATTENDEE_RELATIONSHIP = 2; private static final int COLUMN_ATTENDEE_TYPE = 3; private static final int COLUMN_ATTENDEE_STATUS = 4; private static final int COLUMN_ATTENDEE_IDENTITY = 5; private static final int COLUMN_ATTENDEE_ID_NAMESPACE = 6; private static final String[] EXTENDED_PROJECTION = new String[] { ExtendedProperties._ID, ExtendedProperties.NAME, ExtendedProperties.VALUE }; private static final int COLUMN_ID = 0; private static final int COLUMN_NAME = 1; private static final int COLUMN_VALUE = 2; private static final String WHERE_EVENT_ID = "event_id=?"; public EntityIteratorImpl(Cursor cursor, ContentResolver resolver) { super(cursor); mResolver = resolver; mProvider = null; } public EntityIteratorImpl(Cursor cursor, ContentProviderClient provider) { super(cursor); mResolver = null; mProvider = provider; } @Override public Entity getEntityAndIncrementCursor(Cursor cursor) throws RemoteException { // we expect the cursor is already at the row we need to read from final long eventId = cursor.getLong(cursor.getColumnIndexOrThrow(Events._ID)); ContentValues cv = new ContentValues(); cv.put(Events._ID, eventId); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, CALENDAR_ID); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, TITLE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, DESCRIPTION); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_LOCATION); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, STATUS); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, SELF_ATTENDEE_STATUS); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DTSTART); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DTEND); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, DURATION); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_TIMEZONE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_END_TIMEZONE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ALL_DAY); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, ACCESS_LEVEL); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, AVAILABILITY); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, EVENT_COLOR); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_COLOR_KEY); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, HAS_ALARM); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, HAS_EXTENDED_PROPERTIES); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, RRULE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, RDATE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EXRULE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EXDATE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORIGINAL_SYNC_ID); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORIGINAL_ID); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, ORIGINAL_INSTANCE_TIME); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, ORIGINAL_ALL_DAY); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, LAST_DATE); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, HAS_ATTENDEE_DATA); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, GUESTS_CAN_INVITE_OTHERS); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, GUESTS_CAN_MODIFY); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, GUESTS_CAN_SEE_GUESTS); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CUSTOM_APP_PACKAGE); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CUSTOM_APP_URI); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, UID_2445); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORGANIZER); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, IS_ORGANIZER); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, _SYNC_ID); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DIRTY); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, MUTATORS); DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, LAST_SYNCED); DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, DELETED); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA1); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA2); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA3); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA4); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA5); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA6); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA7); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA8); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA9); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA10); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC1); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC2); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC3); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC4); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC5); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC6); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC7); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC8); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC9); DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC10); Entity entity = new Entity(cv); Cursor subCursor; if (mResolver != null) { subCursor = mResolver.query(Reminders.CONTENT_URI, REMINDERS_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } else { subCursor = mProvider.query(Reminders.CONTENT_URI, REMINDERS_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } try { while (subCursor.moveToNext()) { ContentValues reminderValues = new ContentValues(); reminderValues.put(Reminders.MINUTES, subCursor.getInt(COLUMN_MINUTES)); reminderValues.put(Reminders.METHOD, subCursor.getInt(COLUMN_METHOD)); entity.addSubValue(Reminders.CONTENT_URI, reminderValues); } } finally { subCursor.close(); } if (mResolver != null) { subCursor = mResolver.query(Attendees.CONTENT_URI, ATTENDEES_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } else { subCursor = mProvider.query(Attendees.CONTENT_URI, ATTENDEES_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } try { while (subCursor.moveToNext()) { ContentValues attendeeValues = new ContentValues(); attendeeValues.put(Attendees.ATTENDEE_NAME, subCursor.getString(COLUMN_ATTENDEE_NAME)); attendeeValues.put(Attendees.ATTENDEE_EMAIL, subCursor.getString(COLUMN_ATTENDEE_EMAIL)); attendeeValues.put(Attendees.ATTENDEE_RELATIONSHIP, subCursor.getInt(COLUMN_ATTENDEE_RELATIONSHIP)); attendeeValues.put(Attendees.ATTENDEE_TYPE, subCursor.getInt(COLUMN_ATTENDEE_TYPE)); attendeeValues.put(Attendees.ATTENDEE_STATUS, subCursor.getInt(COLUMN_ATTENDEE_STATUS)); attendeeValues.put(Attendees.ATTENDEE_IDENTITY, subCursor.getString(COLUMN_ATTENDEE_IDENTITY)); attendeeValues.put(Attendees.ATTENDEE_ID_NAMESPACE, subCursor.getString(COLUMN_ATTENDEE_ID_NAMESPACE)); entity.addSubValue(Attendees.CONTENT_URI, attendeeValues); } } finally { subCursor.close(); } if (mResolver != null) { subCursor = mResolver.query(ExtendedProperties.CONTENT_URI, EXTENDED_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } else { subCursor = mProvider.query(ExtendedProperties.CONTENT_URI, EXTENDED_PROJECTION, WHERE_EVENT_ID, new String[] { Long.toString(eventId) } /* selectionArgs */, null /* sortOrder */); } try { while (subCursor.moveToNext()) { ContentValues extendedValues = new ContentValues(); extendedValues.put(ExtendedProperties._ID, subCursor.getString(COLUMN_ID)); extendedValues.put(ExtendedProperties.NAME, subCursor.getString(COLUMN_NAME)); extendedValues.put(ExtendedProperties.VALUE, subCursor.getString(COLUMN_VALUE)); entity.addSubValue(ExtendedProperties.CONTENT_URI, extendedValues); } } finally { subCursor.close(); } cursor.moveToNext(); return entity; } } }
Constants and helpers for the Events table, which contains details for individual events.

Operations

All operations can be done either as an app or as a sync adapter. To perform an operation as a sync adapter CalendarContract.CALLER_IS_SYNCADAPTER should be set to true and SyncColumns.ACCOUNT_NAME and SyncColumns.ACCOUNT_TYPE must be set in the Uri parameters. See Builder.appendQueryParameter(String, String) for details on adding parameters. Sync adapters have write access to more columns but are restricted to a single account at a time.
Insert
When inserting a new event the following fields must be included:
  • dtstart
  • dtend if the event is non-recurring
  • duration if the event is recurring
  • rrule or rdate if the event is recurring
  • eventTimezone
  • a calendar_id
There are also further requirements when inserting or updating an event. See the section on Writing to Events.
Update
To perform an update of an Event the BaseColumns._ID of the event should be provided either as an appended id to the Uri ( ContentUris.withAppendedId) or as the first selection item--the selection should start with "_id=?" and the first selectionArg should be the _id of the event. Updates may also be done using a selection and no id. Updating an event must respect the same rules as inserting and is further restricted in the fields that can be written. See the section on Writing to Events.
Delete
Events can be deleted either by the BaseColumns._ID as an appended id on the Uri or using any standard selection. If an appended id is used a selection is not allowed. There are two versions of delete: as an app and as a sync adapter. An app delete will set the deleted column on an event and remove all instances of that event. A sync adapter delete will remove the event from the database and all associated data.
Query
Querying the Events table will get you all information about a set of events except their reminders, attendees, and extended properties. There will be one row returned for each event that matches the query selection, or at most a single row if the BaseColumns._ID is appended to the Uri. Recurring events will only return a single row regardless of the number of times that event repeats.

Writing to Events

There are further restrictions on all Updates and Inserts in the Events table:
  • If allDay is set to 1 eventTimezone must be Time.TIMEZONE_UTC and the time must correspond to a midnight boundary.
  • Exceptions are not allowed to recur. If rrule or rdate is not empty, original_id and original_sync_id must be empty.
  • In general a calendar_id should not be modified after insertion. This is not explicitly forbidden but many sync adapters will not behave in an expected way if the calendar_id is modified.
The following Events columns are writable by both an app and a sync adapter. The following Events columns are writable only by a sync adapter The remaining columns are either updated by the provider only or are views into other tables and cannot be changed through the Events table.
/** * Constants and helpers for the Events table, which contains details for * individual events. <h3>Operations</h3> All operations can be done either * as an app or as a sync adapter. To perform an operation as a sync adapter * {@link #CALLER_IS_SYNCADAPTER} should be set to true and * {@link #ACCOUNT_NAME} and {@link #ACCOUNT_TYPE} must be set in the Uri * parameters. See * {@link Uri.Builder#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. * <dl> * <dt><b>Insert</b></dt> * <dd>When inserting a new event the following fields must be included: * <ul> * <li>dtstart</li> * <li>dtend if the event is non-recurring</li> * <li>duration if the event is recurring</li> * <li>rrule or rdate if the event is recurring</li> * <li>eventTimezone</li> * <li>a calendar_id</li> * </ul> * There are also further requirements when inserting or updating an event. * See the section on Writing to Events.</dd> * <dt><b>Update</b></dt> * <dd>To perform an update of an Event the {@link Events#_ID} of the event * should be provided either as an appended id to the Uri ( * {@link ContentUris#withAppendedId}) or as the first selection item--the * selection should start with "_id=?" and the first selectionArg should be * the _id of the event. Updates may also be done using a selection and no * id. Updating an event must respect the same rules as inserting and is * further restricted in the fields that can be written. See the section on * Writing to Events.</dd> * <dt><b>Delete</b></dt> * <dd>Events can be deleted either by the {@link Events#_ID} as an appended * id on the Uri or using any standard selection. If an appended id is used * a selection is not allowed. There are two versions of delete: as an app * and as a sync adapter. An app delete will set the deleted column on an * event and remove all instances of that event. A sync adapter delete will * remove the event from the database and all associated data.</dd> * <dt><b>Query</b></dt> * <dd>Querying the Events table will get you all information about a set of * events except their reminders, attendees, and extended properties. There * will be one row returned for each event that matches the query selection, * or at most a single row if the {@link Events#_ID} is appended to the Uri. * Recurring events will only return a single row regardless of the number * of times that event repeats.</dd> * </dl> * <h3>Writing to Events</h3> There are further restrictions on all Updates * and Inserts in the Events table: * <ul> * <li>If allDay is set to 1 eventTimezone must be {@link Time#TIMEZONE_UTC} * and the time must correspond to a midnight boundary.</li> * <li>Exceptions are not allowed to recur. If rrule or rdate is not empty, * original_id and original_sync_id must be empty.</li> * <li>In general a calendar_id should not be modified after insertion. This * is not explicitly forbidden but many sync adapters will not behave in an * expected way if the calendar_id is modified.</li> * </ul> * The following Events columns are writable by both an app and a sync * adapter. * <ul> * <li>{@link #CALENDAR_ID}</li> * <li>{@link #ORGANIZER}</li> * <li>{@link #TITLE}</li> * <li>{@link #EVENT_LOCATION}</li> * <li>{@link #DESCRIPTION}</li> * <li>{@link #EVENT_COLOR}</li> * <li>{@link #DTSTART}</li> * <li>{@link #DTEND}</li> * <li>{@link #EVENT_TIMEZONE}</li> * <li>{@link #EVENT_END_TIMEZONE}</li> * <li>{@link #DURATION}</li> * <li>{@link #ALL_DAY}</li> * <li>{@link #RRULE}</li> * <li>{@link #RDATE}</li> * <li>{@link #EXRULE}</li> * <li>{@link #EXDATE}</li> * <li>{@link #ORIGINAL_ID}</li> * <li>{@link #ORIGINAL_SYNC_ID}</li> * <li>{@link #ORIGINAL_INSTANCE_TIME}</li> * <li>{@link #ORIGINAL_ALL_DAY}</li> * <li>{@link #ACCESS_LEVEL}</li> * <li>{@link #AVAILABILITY}</li> * <li>{@link #GUESTS_CAN_MODIFY}</li> * <li>{@link #GUESTS_CAN_INVITE_OTHERS}</li> * <li>{@link #GUESTS_CAN_SEE_GUESTS}</li> * <li>{@link #CUSTOM_APP_PACKAGE}</li> * <li>{@link #CUSTOM_APP_URI}</li> * <li>{@link #UID_2445}</li> * </ul> * The following Events columns are writable only by a sync adapter * <ul> * <li>{@link #DIRTY}</li> * <li>{@link #MUTATORS}</li> * <li>{@link #_SYNC_ID}</li> * <li>{@link #SYNC_DATA1}</li> * <li>{@link #SYNC_DATA2}</li> * <li>{@link #SYNC_DATA3}</li> * <li>{@link #SYNC_DATA4}</li> * <li>{@link #SYNC_DATA5}</li> * <li>{@link #SYNC_DATA6}</li> * <li>{@link #SYNC_DATA7}</li> * <li>{@link #SYNC_DATA8}</li> * <li>{@link #SYNC_DATA9}</li> * <li>{@link #SYNC_DATA10}</li> * </ul> * The remaining columns are either updated by the provider only or are * views into other tables and cannot be changed through the Events table. */
public static final class Events implements BaseColumns, SyncColumns, EventsColumns, CalendarColumns {
The content:// style URL for interacting with events. Appending an event id using ContentUris.withAppendedId(Uri, long) will specify a single event.
/** * The content:// style URL for interacting with events. Appending an * event id using {@link ContentUris#withAppendedId(Uri, long)} will * specify a single event. */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/events");
The content:// style URI for recurring event exceptions. Insertions require an appended event ID. Deletion of exceptions requires both the original event ID and the exception event ID (see Builder.appendPath).
/** * The content:// style URI for recurring event exceptions. Insertions require an * appended event ID. Deletion of exceptions requires both the original event ID and * the exception event ID (see {@link Uri.Builder#appendPath}). */
public static final Uri CONTENT_EXCEPTION_URI = Uri.parse("content://" + AUTHORITY + "/exception");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Events() {}
The default sort order for this table
/** * The default sort order for this table */
private static final String DEFAULT_SORT_ORDER = "";
These are columns that should only ever be updated by the provider, either because they are views mapped to another table or because they are used for provider only functionality. TODO move to provider
@hide
/** * These are columns that should only ever be updated by the provider, * either because they are views mapped to another table or because they * are used for provider only functionality. TODO move to provider * * @hide */
public static String[] PROVIDER_WRITABLE_COLUMNS = new String[] { ACCOUNT_NAME, ACCOUNT_TYPE, CAL_SYNC1, CAL_SYNC2, CAL_SYNC3, CAL_SYNC4, CAL_SYNC5, CAL_SYNC6, CAL_SYNC7, CAL_SYNC8, CAL_SYNC9, CAL_SYNC10, ALLOWED_REMINDERS, ALLOWED_ATTENDEE_TYPES, ALLOWED_AVAILABILITY, CALENDAR_ACCESS_LEVEL, CALENDAR_COLOR, CALENDAR_TIME_ZONE, CAN_MODIFY_TIME_ZONE, CAN_ORGANIZER_RESPOND, CALENDAR_DISPLAY_NAME, CAN_PARTIALLY_UPDATE, SYNC_EVENTS, VISIBLE, };
These fields are only writable by a sync adapter. To modify them the caller must include CALLER_IS_SYNCADAPTER, _SYNC_ACCOUNT, and _SYNC_ACCOUNT_TYPE in the query parameters. TODO move to provider.
@hide
/** * These fields are only writable by a sync adapter. To modify them the * caller must include CALLER_IS_SYNCADAPTER, _SYNC_ACCOUNT, and * _SYNC_ACCOUNT_TYPE in the query parameters. TODO move to provider. * * @hide */
public static final String[] SYNC_WRITABLE_COLUMNS = new String[] { _SYNC_ID, DIRTY, MUTATORS, SYNC_DATA1, SYNC_DATA2, SYNC_DATA3, SYNC_DATA4, SYNC_DATA5, SYNC_DATA6, SYNC_DATA7, SYNC_DATA8, SYNC_DATA9, SYNC_DATA10, }; }
Fields and helpers for interacting with Instances. An instance is a single occurrence of an event including time zone specific start and end days and minutes. The instances table is not writable and only provides a way to query event occurrences.
/** * Fields and helpers for interacting with Instances. An instance is a * single occurrence of an event including time zone specific start and end * days and minutes. The instances table is not writable and only provides a * way to query event occurrences. */
public static final class Instances implements BaseColumns, EventsColumns, CalendarColumns { private static final String WHERE_CALENDARS_SELECTED = Calendars.VISIBLE + "=?"; private static final String[] WHERE_CALENDARS_ARGS = { "1" };
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Instances() {}
Performs a query to return all visible instances in the given range. This is a blocking function and should not be done on the UI thread. This will cause an expansion of recurring events to fill this time range if they are not already expanded and will slow down for larger time ranges with many recurring events.
Params:
  • cr – The ContentResolver to use for the query
  • projection – The columns to return
  • begin – The start of the time range to query in UTC millis since epoch
  • end – The end of the time range to query in UTC millis since epoch
Returns:A Cursor containing all instances in the given range
/** * Performs a query to return all visible instances in the given range. * This is a blocking function and should not be done on the UI thread. * This will cause an expansion of recurring events to fill this time * range if they are not already expanded and will slow down for larger * time ranges with many recurring events. * * @param cr The ContentResolver to use for the query * @param projection The columns to return * @param begin The start of the time range to query in UTC millis since * epoch * @param end The end of the time range to query in UTC millis since * epoch * @return A Cursor containing all instances in the given range */
public static final Cursor query(ContentResolver cr, String[] projection, long begin, long end) { Uri.Builder builder = CONTENT_URI.buildUpon(); ContentUris.appendId(builder, begin); ContentUris.appendId(builder, end); return cr.query(builder.build(), projection, WHERE_CALENDARS_SELECTED, WHERE_CALENDARS_ARGS, DEFAULT_SORT_ORDER); }
Performs a query to return all visible instances in the given range that match the given query. This is a blocking function and should not be done on the UI thread. This will cause an expansion of recurring events to fill this time range if they are not already expanded and will slow down for larger time ranges with many recurring events.
Params:
  • cr – The ContentResolver to use for the query
  • projection – The columns to return
  • begin – The start of the time range to query in UTC millis since epoch
  • end – The end of the time range to query in UTC millis since epoch
  • searchQuery – A string of space separated search terms. Segments enclosed by double quotes will be treated as a single term.
Returns:A Cursor of instances matching the search terms in the given time range
/** * Performs a query to return all visible instances in the given range * that match the given query. This is a blocking function and should * not be done on the UI thread. This will cause an expansion of * recurring events to fill this time range if they are not already * expanded and will slow down for larger time ranges with many * recurring events. * * @param cr The ContentResolver to use for the query * @param projection The columns to return * @param begin The start of the time range to query in UTC millis since * epoch * @param end The end of the time range to query in UTC millis since * epoch * @param searchQuery A string of space separated search terms. Segments * enclosed by double quotes will be treated as a single * term. * @return A Cursor of instances matching the search terms in the given * time range */
public static final Cursor query(ContentResolver cr, String[] projection, long begin, long end, String searchQuery) { Uri.Builder builder = CONTENT_SEARCH_URI.buildUpon(); ContentUris.appendId(builder, begin); ContentUris.appendId(builder, end); builder = builder.appendPath(searchQuery); return cr.query(builder.build(), projection, WHERE_CALENDARS_SELECTED, WHERE_CALENDARS_ARGS, DEFAULT_SORT_ORDER); }
The content:// style URL for querying an instance range. The begin and end of the range to query should be added as path segments if this is used directly.
/** * The content:// style URL for querying an instance range. The begin * and end of the range to query should be added as path segments if * this is used directly. */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/instances/when");
The content:// style URL for querying an instance range by Julian Day. The start and end day should be added as path segments if this is used directly.
/** * The content:// style URL for querying an instance range by Julian * Day. The start and end day should be added as path segments if this * is used directly. */
public static final Uri CONTENT_BY_DAY_URI = Uri.parse("content://" + AUTHORITY + "/instances/whenbyday");
The content:// style URL for querying an instance range with a search term. The begin, end, and search string should be appended as path segments if this is used directly.
/** * The content:// style URL for querying an instance range with a search * term. The begin, end, and search string should be appended as path * segments if this is used directly. */
public static final Uri CONTENT_SEARCH_URI = Uri.parse("content://" + AUTHORITY + "/instances/search");
The content:// style URL for querying an instance range with a search term. The start day, end day, and search string should be appended as path segments if this is used directly.
/** * The content:// style URL for querying an instance range with a search * term. The start day, end day, and search string should be appended as * path segments if this is used directly. */
public static final Uri CONTENT_SEARCH_BY_DAY_URI = Uri.parse("content://" + AUTHORITY + "/instances/searchbyday");
The default sort order for this table.
/** * The default sort order for this table. */
private static final String DEFAULT_SORT_ORDER = "begin ASC";
The beginning time of the instance, in UTC milliseconds. Column name.

Type: INTEGER (long; millis since epoch)

/** * The beginning time of the instance, in UTC milliseconds. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String BEGIN = "begin";
The ending time of the instance, in UTC milliseconds. Column name.

Type: INTEGER (long; millis since epoch)

/** * The ending time of the instance, in UTC milliseconds. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String END = "end";
The _id of the event for this instance. Column name.

Type: INTEGER (long, foreign key to the Events table)

/** * The _id of the event for this instance. Column name. * <P>Type: INTEGER (long, foreign key to the Events table)</P> */
public static final String EVENT_ID = "event_id";
The Julian start day of the instance, relative to the local time zone. Column name.

Type: INTEGER (int)

/** * The Julian start day of the instance, relative to the local time * zone. Column name. * <P>Type: INTEGER (int)</P> */
public static final String START_DAY = "startDay";
The Julian end day of the instance, relative to the local time zone. Column name.

Type: INTEGER (int)

/** * The Julian end day of the instance, relative to the local time * zone. Column name. * <P>Type: INTEGER (int)</P> */
public static final String END_DAY = "endDay";
The start minute of the instance measured from midnight in the local time zone. Column name.

Type: INTEGER (int)

/** * The start minute of the instance measured from midnight in the * local time zone. Column name. * <P>Type: INTEGER (int)</P> */
public static final String START_MINUTE = "startMinute";
The end minute of the instance measured from midnight in the local time zone. Column name.

Type: INTEGER (int)

/** * The end minute of the instance measured from midnight in the * local time zone. Column name. * <P>Type: INTEGER (int)</P> */
public static final String END_MINUTE = "endMinute"; } protected interface CalendarCacheColumns {
The key for the setting. Keys are defined in CalendarCache.
/** * The key for the setting. Keys are defined in {@link CalendarCache}. */
public static final String KEY = "key";
The value of the given setting.
/** * The value of the given setting. */
public static final String VALUE = "value"; }
CalendarCache stores some settings for calendar including the current time zone for the instances. These settings are stored using a key/value scheme. A CalendarCacheColumns.KEY must be specified when updating these values.
/** * CalendarCache stores some settings for calendar including the current * time zone for the instances. These settings are stored using a key/value * scheme. A {@link #KEY} must be specified when updating these values. */
public static final class CalendarCache implements CalendarCacheColumns {
The URI to use for retrieving the properties from the Calendar db.
/** * The URI to use for retrieving the properties from the Calendar db. */
public static final Uri URI = Uri.parse("content://" + AUTHORITY + "/properties");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private CalendarCache() {}
They key for updating the use of auto/home time zones in Calendar. Valid values are TIMEZONE_TYPE_AUTO or TIMEZONE_TYPE_HOME.
/** * They key for updating the use of auto/home time zones in Calendar. * Valid values are {@link #TIMEZONE_TYPE_AUTO} or * {@link #TIMEZONE_TYPE_HOME}. */
public static final String KEY_TIMEZONE_TYPE = "timezoneType";
The key for updating the time zone used by the provider when it generates the instances table. This should only be written if the type is set to TIMEZONE_TYPE_HOME. A valid time zone id should be written to this field.
/** * The key for updating the time zone used by the provider when it * generates the instances table. This should only be written if the * type is set to {@link #TIMEZONE_TYPE_HOME}. A valid time zone id * should be written to this field. */
public static final String KEY_TIMEZONE_INSTANCES = "timezoneInstances";
The key for reading the last time zone set by the user. This should only be read by apps and it will be automatically updated whenever KEY_TIMEZONE_INSTANCES is updated with TIMEZONE_TYPE_HOME set.
/** * The key for reading the last time zone set by the user. This should * only be read by apps and it will be automatically updated whenever * {@link #KEY_TIMEZONE_INSTANCES} is updated with * {@link #TIMEZONE_TYPE_HOME} set. */
public static final String KEY_TIMEZONE_INSTANCES_PREVIOUS = "timezoneInstancesPrevious";
The value to write to KEY_TIMEZONE_TYPE if the provider should stay in sync with the device's time zone.
/** * The value to write to {@link #KEY_TIMEZONE_TYPE} if the provider * should stay in sync with the device's time zone. */
public static final String TIMEZONE_TYPE_AUTO = "auto";
The value to write to KEY_TIMEZONE_TYPE if the provider should use a fixed time zone set by the user.
/** * The value to write to {@link #KEY_TIMEZONE_TYPE} if the provider * should use a fixed time zone set by the user. */
public static final String TIMEZONE_TYPE_HOME = "home"; }
A few Calendar globals are needed in the CalendarProvider for expanding the Instances table and these are all stored in the first (and only) row of the CalendarMetaData table.
@hide
/** * A few Calendar globals are needed in the CalendarProvider for expanding * the Instances table and these are all stored in the first (and only) row * of the CalendarMetaData table. * * @hide */
protected interface CalendarMetaDataColumns {
The local timezone that was used for precomputing the fields in the Instances table.
/** * The local timezone that was used for precomputing the fields * in the Instances table. */
public static final String LOCAL_TIMEZONE = "localTimezone";
The minimum time used in expanding the Instances table, in UTC milliseconds.

Type: INTEGER

/** * The minimum time used in expanding the Instances table, * in UTC milliseconds. * <P>Type: INTEGER</P> */
public static final String MIN_INSTANCE = "minInstance";
The maximum time used in expanding the Instances table, in UTC milliseconds.

Type: INTEGER

/** * The maximum time used in expanding the Instances table, * in UTC milliseconds. * <P>Type: INTEGER</P> */
public static final String MAX_INSTANCE = "maxInstance";
The minimum Julian day in the EventDays table.

Type: INTEGER

/** * The minimum Julian day in the EventDays table. * <P>Type: INTEGER</P> */
public static final String MIN_EVENTDAYS = "minEventDays";
The maximum Julian day in the EventDays table.

Type: INTEGER

/** * The maximum Julian day in the EventDays table. * <P>Type: INTEGER</P> */
public static final String MAX_EVENTDAYS = "maxEventDays"; }
@hide
/** * @hide */
public static final class CalendarMetaData implements CalendarMetaDataColumns, BaseColumns {
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private CalendarMetaData() {} } protected interface EventDaysColumns {
The Julian starting day number. Column name.

Type: INTEGER (int)

/** * The Julian starting day number. Column name. * <P>Type: INTEGER (int)</P> */
public static final String STARTDAY = "startDay";
The Julian ending day number. Column name.

Type: INTEGER (int)

/** * The Julian ending day number. Column name. * <P>Type: INTEGER (int)</P> */
public static final String ENDDAY = "endDay"; }
Fields and helpers for querying for a list of days that contain events.
/** * Fields and helpers for querying for a list of days that contain events. */
public static final class EventDays implements EventDaysColumns { public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/instances/groupbyday"); private static final String SELECTION = "selected=1";
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private EventDays() {}
Retrieves the days with events for the Julian days starting at "startDay" for "numDays". It returns a cursor containing startday and endday representing the max range of days for all events beginning on each startday.This is a blocking function and should not be done on the UI thread.
Params:
  • cr – the ContentResolver
  • startDay – the first Julian day in the range
  • numDays – the number of days to load (must be at least 1)
  • projection – the columns to return in the cursor
Returns:a database cursor containing a list of start and end days for events
/** * Retrieves the days with events for the Julian days starting at * "startDay" for "numDays". It returns a cursor containing startday and * endday representing the max range of days for all events beginning on * each startday.This is a blocking function and should not be done on * the UI thread. * * @param cr the ContentResolver * @param startDay the first Julian day in the range * @param numDays the number of days to load (must be at least 1) * @param projection the columns to return in the cursor * @return a database cursor containing a list of start and end days for * events */
public static final Cursor query(ContentResolver cr, int startDay, int numDays, String[] projection) { if (numDays < 1) { return null; } int endDay = startDay + numDays - 1; Uri.Builder builder = CONTENT_URI.buildUpon(); ContentUris.appendId(builder, startDay); ContentUris.appendId(builder, endDay); return cr.query(builder.build(), projection, SELECTION, null /* selection args */, STARTDAY); } } protected interface RemindersColumns {
The event the reminder belongs to. Column name.

Type: INTEGER (foreign key to the Events table)

/** * The event the reminder belongs to. Column name. * <P>Type: INTEGER (foreign key to the Events table)</P> */
public static final String EVENT_ID = "event_id";
The minutes prior to the event that the alarm should ring. -1 specifies that we should use the default value for the system. Column name.

Type: INTEGER

/** * The minutes prior to the event that the alarm should ring. -1 * specifies that we should use the default value for the system. * Column name. * <P>Type: INTEGER</P> */
public static final String MINUTES = "minutes";
Passing this as a minutes value will use the default reminder minutes.
/** * Passing this as a minutes value will use the default reminder * minutes. */
public static final int MINUTES_DEFAULT = -1;
The alarm method, as set on the server. METHOD_DEFAULT, METHOD_ALERT, METHOD_EMAIL, METHOD_SMS and METHOD_ALARM are possible values; the device will only process METHOD_DEFAULT and METHOD_ALERT reminders (the other types are simply stored so we can send the same reminder info back to the server when we make changes).
/** * The alarm method, as set on the server. {@link #METHOD_DEFAULT}, * {@link #METHOD_ALERT}, {@link #METHOD_EMAIL}, {@link #METHOD_SMS} and * {@link #METHOD_ALARM} are possible values; the device will only * process {@link #METHOD_DEFAULT} and {@link #METHOD_ALERT} reminders * (the other types are simply stored so we can send the same reminder * info back to the server when we make changes). */
public static final String METHOD = "method"; public static final int METHOD_DEFAULT = 0; public static final int METHOD_ALERT = 1; public static final int METHOD_EMAIL = 2; public static final int METHOD_SMS = 3; public static final int METHOD_ALARM = 4; }
Fields and helpers for accessing reminders for an event. Each row of this table represents a single reminder for an event. Calling query(ContentResolver, long, String[]) will return a list of reminders for the event with the given eventId. Both apps and sync adapters may write to this table. There are three writable fields and all of them must be included when inserting a new reminder. They are:
/** * Fields and helpers for accessing reminders for an event. Each row of this * table represents a single reminder for an event. Calling * {@link #query(ContentResolver, long, String[])} will return a list of reminders for * the event with the given eventId. Both apps and sync adapters may write * to this table. There are three writable fields and all of them must be * included when inserting a new reminder. They are: * <ul> * <li>{@link #EVENT_ID}</li> * <li>{@link #MINUTES}</li> * <li>{@link #METHOD}</li> * </ul> */
public static final class Reminders implements BaseColumns, RemindersColumns, EventsColumns { private static final String REMINDERS_WHERE = CalendarContract.Reminders.EVENT_ID + "=?"; @SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/reminders");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Reminders() {}
Queries all reminders associated with the given event. This is a blocking call and should not be done on the UI thread.
Params:
  • cr – The content resolver to use for the query
  • eventId – The id of the event to retrieve reminders for
  • projection – the columns to return in the cursor
Returns:A Cursor containing all reminders for the event
/** * Queries all reminders associated with the given event. This is a * blocking call and should not be done on the UI thread. * * @param cr The content resolver to use for the query * @param eventId The id of the event to retrieve reminders for * @param projection the columns to return in the cursor * @return A Cursor containing all reminders for the event */
public static final Cursor query(ContentResolver cr, long eventId, String[] projection) { String[] remArgs = {Long.toString(eventId)}; return cr.query(CONTENT_URI, projection, REMINDERS_WHERE, remArgs /*selection args*/, null /* sort order */); } } protected interface CalendarAlertsColumns {
The event that the alert belongs to. Column name.

Type: INTEGER (foreign key to the Events table)

/** * The event that the alert belongs to. Column name. * <P>Type: INTEGER (foreign key to the Events table)</P> */
public static final String EVENT_ID = "event_id";
The start time of the event, in UTC. Column name.

Type: INTEGER (long; millis since epoch)

/** * The start time of the event, in UTC. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String BEGIN = "begin";
The end time of the event, in UTC. Column name.

Type: INTEGER (long; millis since epoch)

/** * The end time of the event, in UTC. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String END = "end";
The alarm time of the event, in UTC. Column name.

Type: INTEGER (long; millis since epoch)

/** * The alarm time of the event, in UTC. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String ALARM_TIME = "alarmTime";
The creation time of this database entry, in UTC. Useful for debugging missed reminders. Column name.

Type: INTEGER (long; millis since epoch)

/** * The creation time of this database entry, in UTC. * Useful for debugging missed reminders. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String CREATION_TIME = "creationTime";
The time that the alarm broadcast was received by the Calendar app, in UTC. Useful for debugging missed reminders. Column name.

Type: INTEGER (long; millis since epoch)

/** * The time that the alarm broadcast was received by the Calendar app, * in UTC. Useful for debugging missed reminders. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String RECEIVED_TIME = "receivedTime";
The time that the notification was created by the Calendar app, in UTC. Useful for debugging missed reminders. Column name.

Type: INTEGER (long; millis since epoch)

/** * The time that the notification was created by the Calendar app, * in UTC. Useful for debugging missed reminders. Column name. * <P>Type: INTEGER (long; millis since epoch)</P> */
public static final String NOTIFY_TIME = "notifyTime";
The state of this alert. It starts out as STATE_SCHEDULED, then when the alarm goes off, it changes to STATE_FIRED, and then when the user dismisses the alarm it changes to STATE_DISMISSED. Column name.

Type: INTEGER

/** * The state of this alert. It starts out as {@link #STATE_SCHEDULED}, then * when the alarm goes off, it changes to {@link #STATE_FIRED}, and then when * the user dismisses the alarm it changes to {@link #STATE_DISMISSED}. Column * name. * <P>Type: INTEGER</P> */
public static final String STATE = "state";
An alert begins in this state when it is first created.
/** * An alert begins in this state when it is first created. */
public static final int STATE_SCHEDULED = 0;
After a notification for an alert has been created it should be updated to fired.
/** * After a notification for an alert has been created it should be * updated to fired. */
public static final int STATE_FIRED = 1;
Once the user has dismissed the notification the alert's state should be set to dismissed so it is not fired again.
/** * Once the user has dismissed the notification the alert's state should * be set to dismissed so it is not fired again. */
public static final int STATE_DISMISSED = 2;
The number of minutes that this alarm precedes the start time. Column name.

Type: INTEGER

/** * The number of minutes that this alarm precedes the start time. Column * name. * <P>Type: INTEGER</P> */
public static final String MINUTES = "minutes";
The default sort order for this alerts queries
/** * The default sort order for this alerts queries */
public static final String DEFAULT_SORT_ORDER = "begin ASC,title ASC"; }
Fields and helpers for accessing calendar alerts information. These fields are for tracking which alerts have been fired. Scheduled alarms will generate an intent using CalendarContract.ACTION_EVENT_REMINDER. Apps that receive this action may update the CalendarAlertsColumns.STATE for the reminder when they have finished handling it. Apps that have their notifications disabled should not modify the table to ensure that they do not conflict with another app that is generating a notification. In general, apps should not need to write to this table directly except to update the state of a reminder.
/** * Fields and helpers for accessing calendar alerts information. These * fields are for tracking which alerts have been fired. Scheduled alarms * will generate an intent using {@link #ACTION_EVENT_REMINDER}. Apps that * receive this action may update the {@link #STATE} for the reminder when * they have finished handling it. Apps that have their notifications * disabled should not modify the table to ensure that they do not conflict * with another app that is generating a notification. In general, apps * should not need to write to this table directly except to update the * state of a reminder. */
public static final class CalendarAlerts implements BaseColumns, CalendarAlertsColumns, EventsColumns, CalendarColumns {
@hide
/** * @hide */
public static final String TABLE_NAME = "CalendarAlerts";
The Uri for querying calendar alert information
/** * The Uri for querying calendar alert information */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/calendar_alerts");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private CalendarAlerts() {} private static final String WHERE_ALARM_EXISTS = EVENT_ID + "=?" + " AND " + BEGIN + "=?" + " AND " + ALARM_TIME + "=?"; private static final String WHERE_FINDNEXTALARMTIME = ALARM_TIME + ">=?"; private static final String SORT_ORDER_ALARMTIME_ASC = ALARM_TIME + " ASC"; private static final String WHERE_RESCHEDULE_MISSED_ALARMS = STATE + "=" + STATE_SCHEDULED + " AND " + ALARM_TIME + "<?" + " AND " + ALARM_TIME + ">?" + " AND " + END + ">=?";
This URI is for grouping the query results by event_id and begin time. This will return one result per instance of an event. So events with multiple alarms will appear just once, but multiple instances of a repeating event will show up multiple times.
/** * This URI is for grouping the query results by event_id and begin * time. This will return one result per instance of an event. So * events with multiple alarms will appear just once, but multiple * instances of a repeating event will show up multiple times. */
public static final Uri CONTENT_URI_BY_INSTANCE = Uri.parse("content://" + AUTHORITY + "/calendar_alerts/by_instance"); private static final boolean DEBUG = false;
Helper for inserting an alarm time associated with an event TODO move to Provider
@hide
/** * Helper for inserting an alarm time associated with an event TODO move * to Provider * * @hide */
public static final Uri insert(ContentResolver cr, long eventId, long begin, long end, long alarmTime, int minutes) { ContentValues values = new ContentValues(); values.put(CalendarAlerts.EVENT_ID, eventId); values.put(CalendarAlerts.BEGIN, begin); values.put(CalendarAlerts.END, end); values.put(CalendarAlerts.ALARM_TIME, alarmTime); long currentTime = System.currentTimeMillis(); values.put(CalendarAlerts.CREATION_TIME, currentTime); values.put(CalendarAlerts.RECEIVED_TIME, 0); values.put(CalendarAlerts.NOTIFY_TIME, 0); values.put(CalendarAlerts.STATE, STATE_SCHEDULED); values.put(CalendarAlerts.MINUTES, minutes); return cr.insert(CONTENT_URI, values); }
Finds the next alarm after (or equal to) the given time and returns the time of that alarm or -1 if no such alarm exists. This is a blocking call and should not be done on the UI thread. TODO move to provider
Params:
  • cr – the ContentResolver
  • millis – the time in UTC milliseconds
Returns:the next alarm time greater than or equal to "millis", or -1 if no such alarm exists.
@hide
/** * Finds the next alarm after (or equal to) the given time and returns * the time of that alarm or -1 if no such alarm exists. This is a * blocking call and should not be done on the UI thread. TODO move to * provider * * @param cr the ContentResolver * @param millis the time in UTC milliseconds * @return the next alarm time greater than or equal to "millis", or -1 * if no such alarm exists. * @hide */
public static final long findNextAlarmTime(ContentResolver cr, long millis) { String selection = ALARM_TIME + ">=" + millis; // TODO: construct an explicit SQL query so that we can add // "LIMIT 1" to the end and get just one result. String[] projection = new String[] { ALARM_TIME }; Cursor cursor = cr.query(CONTENT_URI, projection, WHERE_FINDNEXTALARMTIME, (new String[] { Long.toString(millis) }), SORT_ORDER_ALARMTIME_ASC); long alarmTime = -1; try { if (cursor != null && cursor.moveToFirst()) { alarmTime = cursor.getLong(0); } } finally { if (cursor != null) { cursor.close(); } } return alarmTime; }
Searches the CalendarAlerts table for alarms that should have fired but have not and then reschedules them. This method can be called at boot time to restore alarms that may have been lost due to a phone reboot. TODO move to provider
Params:
  • cr – the ContentResolver
  • context – the Context
  • manager – the AlarmManager
@hide
/** * Searches the CalendarAlerts table for alarms that should have fired * but have not and then reschedules them. This method can be called at * boot time to restore alarms that may have been lost due to a phone * reboot. TODO move to provider * * @param cr the ContentResolver * @param context the Context * @param manager the AlarmManager * @hide */
public static final void rescheduleMissedAlarms(ContentResolver cr, Context context, AlarmManager manager) { // Get all the alerts that have been scheduled but have not fired // and should have fired by now and are not too old. long now = System.currentTimeMillis(); long ancient = now - DateUtils.DAY_IN_MILLIS; String[] projection = new String[] { ALARM_TIME, }; // TODO: construct an explicit SQL query so that we can add // "GROUPBY" instead of doing a sort and de-dup Cursor cursor = cr.query(CalendarAlerts.CONTENT_URI, projection, WHERE_RESCHEDULE_MISSED_ALARMS, (new String[] { Long.toString(now), Long.toString(ancient), Long.toString(now) }), SORT_ORDER_ALARMTIME_ASC); if (cursor == null) { return; } if (DEBUG) { Log.d(TAG, "missed alarms found: " + cursor.getCount()); } try { long alarmTime = -1; while (cursor.moveToNext()) { long newAlarmTime = cursor.getLong(0); if (alarmTime != newAlarmTime) { if (DEBUG) { Log.w(TAG, "rescheduling missed alarm. alarmTime: " + newAlarmTime); } scheduleAlarm(context, manager, newAlarmTime); alarmTime = newAlarmTime; } } } finally { cursor.close(); } }
Schedules an alarm intent with the system AlarmManager that will notify listeners when a reminder should be fired. The provider will keep scheduled reminders up to date but apps may use this to implement snooze functionality without modifying the reminders table. Scheduled alarms will generate an intent using CalendarContract.ACTION_EVENT_REMINDER. TODO Move to provider
Params:
  • context – A context for referencing system resources
  • manager – The AlarmManager to use or null
  • alarmTime – The time to fire the intent in UTC millis since epoch
@hide
/** * Schedules an alarm intent with the system AlarmManager that will * notify listeners when a reminder should be fired. The provider will * keep scheduled reminders up to date but apps may use this to * implement snooze functionality without modifying the reminders table. * Scheduled alarms will generate an intent using * {@link #ACTION_EVENT_REMINDER}. TODO Move to provider * * @param context A context for referencing system resources * @param manager The AlarmManager to use or null * @param alarmTime The time to fire the intent in UTC millis since * epoch * @hide */
public static void scheduleAlarm(Context context, AlarmManager manager, long alarmTime) { if (DEBUG) { Time time = new Time(); time.set(alarmTime); String schedTime = time.format(" %a, %b %d, %Y %I:%M%P"); Log.d(TAG, "Schedule alarm at " + alarmTime + " " + schedTime); } if (manager == null) { manager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE); } Intent intent = new Intent(ACTION_EVENT_REMINDER); intent.setData(ContentUris.withAppendedId(CalendarContract.CONTENT_URI, alarmTime)); intent.putExtra(ALARM_TIME, alarmTime); intent.setFlags(Intent.FLAG_RECEIVER_INCLUDE_BACKGROUND); PendingIntent pi = PendingIntent.getBroadcast(context, 0, intent, 0); manager.setExactAndAllowWhileIdle(AlarmManager.RTC_WAKEUP, alarmTime, pi); }
Searches for an entry in the CalendarAlerts table that matches the given event id, begin time and alarm time. If one is found then this alarm already exists and this method returns true. TODO Move to provider
Params:
  • cr – the ContentResolver
  • eventId – the event id to match
  • begin – the start time of the event in UTC millis
  • alarmTime – the alarm time of the event in UTC millis
Returns:true if there is already an alarm for the given event with the same start time and alarm time.
@hide
/** * Searches for an entry in the CalendarAlerts table that matches the * given event id, begin time and alarm time. If one is found then this * alarm already exists and this method returns true. TODO Move to * provider * * @param cr the ContentResolver * @param eventId the event id to match * @param begin the start time of the event in UTC millis * @param alarmTime the alarm time of the event in UTC millis * @return true if there is already an alarm for the given event with * the same start time and alarm time. * @hide */
public static final boolean alarmExists(ContentResolver cr, long eventId, long begin, long alarmTime) { // TODO: construct an explicit SQL query so that we can add // "LIMIT 1" to the end and get just one result. String[] projection = new String[] { ALARM_TIME }; Cursor cursor = cr.query(CONTENT_URI, projection, WHERE_ALARM_EXISTS, (new String[] { Long.toString(eventId), Long.toString(begin), Long.toString(alarmTime) }), null); boolean found = false; try { if (cursor != null && cursor.getCount() > 0) { found = true; } } finally { if (cursor != null) { cursor.close(); } } return found; } } protected interface ColorsColumns extends SyncStateContract.Columns {
The type of color, which describes how it should be used. Valid types are TYPE_CALENDAR and TYPE_EVENT. Column name.

Type: INTEGER (NOT NULL)

/** * The type of color, which describes how it should be used. Valid types * are {@link #TYPE_CALENDAR} and {@link #TYPE_EVENT}. Column name. * <P> * Type: INTEGER (NOT NULL) * </P> */
public static final String COLOR_TYPE = "color_type";
This indicateds a color that can be used for calendars.
/** * This indicateds a color that can be used for calendars. */
public static final int TYPE_CALENDAR = 0;
This indicates a color that can be used for events.
/** * This indicates a color that can be used for events. */
public static final int TYPE_EVENT = 1;
The key used to reference this color. This can be any non-empty string, but must be unique for a given Columns.ACCOUNT_TYPE and Columns.ACCOUNT_NAME. Column name.

Type: TEXT

/** * The key used to reference this color. This can be any non-empty * string, but must be unique for a given {@link #ACCOUNT_TYPE} and * {@link #ACCOUNT_NAME}. Column name. * <P> * Type: TEXT * </P> */
public static final String COLOR_KEY = "color_index";
The color as an 8-bit ARGB integer value. Colors should specify alpha as fully opaque (eg 0xFF993322) as the alpha may be ignored or modified for display. It is reccomended that colors be usable with light (near white) text. Apps should not depend on that assumption, however. Column name.

Type: INTEGER (NOT NULL)

/** * The color as an 8-bit ARGB integer value. Colors should specify alpha * as fully opaque (eg 0xFF993322) as the alpha may be ignored or * modified for display. It is reccomended that colors be usable with * light (near white) text. Apps should not depend on that assumption, * however. Column name. * <P> * Type: INTEGER (NOT NULL) * </P> */
public static final String COLOR = "color"; }
Fields for accessing colors available for a given account. Colors are referenced by ColorsColumns.COLOR_KEY which must be unique for a given account name/type. These values can only be updated by the sync adapter. Only ColorsColumns.COLOR may be updated after the initial insert. In addition, a row can only be deleted once all references to that color have been removed from the Calendars or Events tables.
/** * Fields for accessing colors available for a given account. Colors are * referenced by {@link #COLOR_KEY} which must be unique for a given * account name/type. These values can only be updated by the sync * adapter. Only {@link #COLOR} may be updated after the initial insert. In * addition, a row can only be deleted once all references to that color * have been removed from the {@link Calendars} or {@link Events} tables. */
public static final class Colors implements ColorsColumns {
@hide
/** * @hide */
public static final String TABLE_NAME = "Colors";
The Uri for querying color information
/** * The Uri for querying color information */
@SuppressWarnings("hiding") public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/colors");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private Colors() { } } protected interface ExtendedPropertiesColumns {
The event the extended property belongs to. Column name.

Type: INTEGER (foreign key to the Events table)

/** * The event the extended property belongs to. Column name. * <P>Type: INTEGER (foreign key to the Events table)</P> */
public static final String EVENT_ID = "event_id";
The name of the extended property. This is a uri of the form {scheme}#{local-name} convention. Column name.

Type: TEXT

/** * The name of the extended property. This is a uri of the form * {scheme}#{local-name} convention. Column name. * <P>Type: TEXT</P> */
public static final String NAME = "name";
The value of the extended property. Column name.

Type: TEXT

/** * The value of the extended property. Column name. * <P>Type: TEXT</P> */
public static final String VALUE = "value"; }
Fields for accessing the Extended Properties. This is a generic set of name/value pairs for use by sync adapters to add extra information to events. There are three writable columns and all three must be present when inserting a new value. They are:
/** * Fields for accessing the Extended Properties. This is a generic set of * name/value pairs for use by sync adapters to add extra * information to events. There are three writable columns and all three * must be present when inserting a new value. They are: * <ul> * <li>{@link #EVENT_ID}</li> * <li>{@link #NAME}</li> * <li>{@link #VALUE}</li> * </ul> */
public static final class ExtendedProperties implements BaseColumns, ExtendedPropertiesColumns, EventsColumns { public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/extendedproperties");
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private ExtendedProperties() {} // TODO: fill out this class when we actually start utilizing extendedproperties // in the calendar application. }
A table provided for sync adapters to use for storing private sync state data.
See Also:
  • SyncStateContract
/** * A table provided for sync adapters to use for storing private sync state data. * * @see SyncStateContract */
public static final class SyncState implements SyncStateContract.Columns {
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private SyncState() {} private static final String CONTENT_DIRECTORY = SyncStateContract.Constants.CONTENT_DIRECTORY;
The content:// style URI for this table
/** * The content:// style URI for this table */
public static final Uri CONTENT_URI = Uri.withAppendedPath(CalendarContract.CONTENT_URI, CONTENT_DIRECTORY); }
Columns from the EventsRawTimes table
@hide
/** * Columns from the EventsRawTimes table * * @hide */
protected interface EventsRawTimesColumns {
The corresponding event id. Column name.

Type: INTEGER (long)

/** * The corresponding event id. Column name. * <P>Type: INTEGER (long)</P> */
public static final String EVENT_ID = "event_id";
The RFC2445 compliant time the event starts. Column name.

Type: TEXT

/** * The RFC2445 compliant time the event starts. Column name. * <P>Type: TEXT</P> */
public static final String DTSTART_2445 = "dtstart2445";
The RFC2445 compliant time the event ends. Column name.

Type: TEXT

/** * The RFC2445 compliant time the event ends. Column name. * <P>Type: TEXT</P> */
public static final String DTEND_2445 = "dtend2445";
The RFC2445 compliant original instance time of the recurring event for which this event is an exception. Column name.

Type: TEXT

/** * The RFC2445 compliant original instance time of the recurring event * for which this event is an exception. Column name. * <P>Type: TEXT</P> */
public static final String ORIGINAL_INSTANCE_TIME_2445 = "originalInstanceTime2445";
The RFC2445 compliant last date this event repeats on, or NULL if it never ends. Column name.

Type: TEXT

/** * The RFC2445 compliant last date this event repeats on, or NULL if it * never ends. Column name. * <P>Type: TEXT</P> */
public static final String LAST_DATE_2445 = "lastDate2445"; }
@hide
/** * @hide */
public static final class EventsRawTimes implements BaseColumns, EventsRawTimesColumns {
This utility class cannot be instantiated
/** * This utility class cannot be instantiated */
private EventsRawTimes() {} } }