Please note that the contents of this offline web site may be out of date. To access the most recent documentation visit the online version .
Note that links that point to online resources are green in color and will open in a new window.
We would love it if you could give us feedback about this material by filling this form (You have to be online to fill it)
Android APIs
protected static interface

CalendarContract.EventsColumns

android.provider.CalendarContract.EventsColumns
Known Indirect Subclasses

Class Overview

Columns from the Events table that other tables join into themselves.

Summary

Constants
int ACCESS_CONFIDENTIAL Confidential is not used by the app.
int ACCESS_DEFAULT Default access is controlled by the server and will be treated as public on the device.
String ACCESS_LEVEL Defines how the event shows up for others when the calendar is shared.
int ACCESS_PRIVATE Private shares the event as a free/busy slot with no details.
int ACCESS_PUBLIC Public makes the contents visible to anyone with access to the calendar.
String ALL_DAY Is the event all day (time zone independent).
String AVAILABILITY If this event counts as busy time or is still free time that can be scheduled over.
int AVAILABILITY_BUSY Indicates that this event takes up time and will conflict with other events.
int AVAILABILITY_FREE Indicates that this event is free time and will not conflict with other events.
int AVAILABILITY_TENTATIVE Indicates that the owner's availability may change, but should be considered busy time that will conflict.
String CALENDAR_ID The _ID of the calendar the event belongs to.
String CAN_INVITE_OTHERS Whether the user can invite others to the event.
String CUSTOM_APP_PACKAGE The package name of the custom app that can provide a richer experience for the event.
String CUSTOM_APP_URI The URI used by the custom app for the event.
String DESCRIPTION The description of the event.
String DISPLAY_COLOR This will be EVENT_COLOR if it is not null; otherwise, this will be CALENDAR_COLOR .
String DTEND The time the event ends in UTC millis since epoch.
String DTSTART The time the event starts in UTC millis since epoch.
String DURATION The duration of the event in RFC2445 format.
String EVENT_COLOR A secondary color for the individual event.
String EVENT_COLOR_KEY A secondary color key for the individual event.
String EVENT_END_TIMEZONE The timezone for the end time of the event.
String EVENT_LOCATION Where the event takes place.
String EVENT_TIMEZONE The timezone for the event.
String EXDATE The recurrence exception dates for the event.
String EXRULE The recurrence exception rule for the event.
String GUESTS_CAN_INVITE_OTHERS Whether guests can invite other guests.
String GUESTS_CAN_MODIFY Whether guests can modify the event.
String GUESTS_CAN_SEE_GUESTS Whether guests can see the list of attendees.
String HAS_ALARM Whether the event has an alarm or not.
String HAS_ATTENDEE_DATA Whether the event has attendee information.
String HAS_EXTENDED_PROPERTIES Whether the event has extended properties or not.
String IS_ORGANIZER Are we the organizer of this event.
String LAST_DATE The last date this event repeats on, or NULL if it never ends.
String LAST_SYNCED Used to indicate that a row is not a real event but an original copy of a locally modified event.
String ORGANIZER Email of the organizer (owner) of the event.
String ORIGINAL_ALL_DAY The allDay status (true or false) of the original recurring event for which this event is an exception.
String ORIGINAL_ID The _ID of the original recurring event for which this event is an exception.
String ORIGINAL_INSTANCE_TIME The original instance time of the recurring event for which this event is an exception.
String ORIGINAL_SYNC_ID The _sync_id of the original recurring event for which this event is an exception.
String RDATE The recurrence dates for the event.
String RRULE The recurrence rule for the event.
String SELF_ATTENDEE_STATUS This is a copy of the attendee status for the owner of this event.
String STATUS The event status.
int STATUS_CANCELED
int STATUS_CONFIRMED
int STATUS_TENTATIVE
String SYNC_DATA1 This column is available for use by sync adapters.
String SYNC_DATA10 This column is available for use by sync adapters.
String SYNC_DATA2 This column is available for use by sync adapters.
String SYNC_DATA3 This column is available for use by sync adapters.
String SYNC_DATA4 This column is available for use by sync adapters.
String SYNC_DATA5 This column is available for use by sync adapters.
String SYNC_DATA6 This column is available for use by sync adapters.
String SYNC_DATA7 This column is available for use by sync adapters.
String SYNC_DATA8 This column is available for use by sync adapters.
String SYNC_DATA9 This column is available for use by sync adapters.
String TITLE The title of the event.
String UID_2445 The UID for events added from the RFC 2445 iCalendar format.

Constants

public static final int ACCESS_CONFIDENTIAL

Confidential is not used by the app.

Constant Value: 1 (0x00000001)

public static final int ACCESS_DEFAULT

Default access is controlled by the server and will be treated as public on the device.

Constant Value: 0 (0x00000000)

public static final String ACCESS_LEVEL

Defines how the event shows up for others when the calendar is shared. Column name.

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

Constant Value: "accessLevel"

public static final int ACCESS_PRIVATE

Private shares the event as a free/busy slot with no details.

Constant Value: 2 (0x00000002)

public static final int ACCESS_PUBLIC

Public makes the contents visible to anyone with access to the calendar.

Constant Value: 3 (0x00000003)

public static final String ALL_DAY

Is the event all day (time zone independent). Column name.

Type: INTEGER (boolean)

Constant Value: "allDay"

public static final String AVAILABILITY

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 )

Constant Value: "availability"

public static final int AVAILABILITY_BUSY

Indicates that this event takes up time and will conflict with other events.

Constant Value: 0 (0x00000000)

public static final int AVAILABILITY_FREE

Indicates that this event is free time and will not conflict with other events.

Constant Value: 1 (0x00000001)

public static final int AVAILABILITY_TENTATIVE

Indicates that the owner's availability may change, but should be considered busy time that will conflict.

Constant Value: 2 (0x00000002)

public static final String CALENDAR_ID

The _ID of the calendar the event belongs to. Column name.

Type: INTEGER

Constant Value: "calendar_id"

public static final String CAN_INVITE_OTHERS

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)

Constant Value: "canInviteOthers"

public static final String CUSTOM_APP_PACKAGE

The package name of the custom app that can provide a richer experience for the event. See the ACTION TYPE ACTION_HANDLE_CUSTOM_EVENT for details. Column name.

Type: TEXT

Constant Value: "customAppPackage"

public static final String CUSTOM_APP_URI

The URI used by the custom app for the event. Column name.

Type: TEXT

Constant Value: "customAppUri"

public static final String DESCRIPTION

The description of the event. Column name.

Type: TEXT

Constant Value: "description"

public static final String DISPLAY_COLOR

This will be EVENT_COLOR if it is not null; otherwise, this will be CALENDAR_COLOR . Read-only value. To modify, write to EVENT_COLOR or CALENDAR_COLOR directly.

Type: INTEGER

Constant Value: "displayColor"

public static final String DTEND

The time the event ends in UTC millis since epoch. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "dtend"

public static final String DTSTART

The time the event starts in UTC millis since epoch. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "dtstart"

public static final String DURATION

The duration of the event in RFC2445 format. Column name.

Type: TEXT (duration in RFC2445 format)

Constant Value: "duration"

public static final String EVENT_COLOR

A secondary color for the individual event. This should only be updated by the sync adapter for a given account.

Type: INTEGER

Constant Value: "eventColor"

public static final String EVENT_COLOR_KEY

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 CalendarContract.Colors table. @see Colors

Type: TEXT

Constant Value: "eventColor_index"

public static final String EVENT_END_TIMEZONE

The timezone for the end time of the event. Column name.

Type: TEXT

Constant Value: "eventEndTimezone"

public static final String EVENT_LOCATION

Where the event takes place. Column name.

Type: TEXT

Constant Value: "eventLocation"

public static final String EVENT_TIMEZONE

The timezone for the event. Column name.

Type: TEXT

Constant Value: "eventTimezone"

public static final String EXDATE

The recurrence exception dates for the event. Column name.

Type: TEXT

Constant Value: "exdate"

public static final String EXRULE

The recurrence exception rule for the event. Column name.

Type: TEXT

Constant Value: "exrule"

public static final String GUESTS_CAN_INVITE_OTHERS

Whether guests can invite other guests. Column name.

Type: INTEGER (boolean)

Constant Value: "guestsCanInviteOthers"

public static final String GUESTS_CAN_MODIFY

Whether guests can modify the event. Column name.

Type: INTEGER (boolean)

Constant Value: "guestsCanModify"

public static final String GUESTS_CAN_SEE_GUESTS

Whether guests can see the list of attendees. Column name.

Type: INTEGER (boolean)

Constant Value: "guestsCanSeeGuests"

public static final String HAS_ALARM

Whether the event has an alarm or not. Column name.

Type: INTEGER (boolean)

Constant Value: "hasAlarm"

public static final String HAS_ATTENDEE_DATA

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)

Constant Value: "hasAttendeeData"

public static final String HAS_EXTENDED_PROPERTIES

Whether the event has extended properties or not. Column name.

Type: INTEGER (boolean)

Constant Value: "hasExtendedProperties"

public static final String IS_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 OWNER_ACCOUNT . Column name.

Type: STRING

Constant Value: "isOrganizer"

public static final String LAST_DATE

The last date this event repeats on, or NULL if it never ends. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "lastDate"

public static final String LAST_SYNCED

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 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)

Constant Value: "lastSynced"

public static final String ORGANIZER

Email of the organizer (owner) of the event. Column name.

Type: STRING

Constant Value: "organizer"

public static final String ORIGINAL_ALL_DAY

The allDay status (true or false) of the original recurring event for which this event is an exception. Column name.

Type: INTEGER (boolean)

Constant Value: "originalAllDay"

public static final String ORIGINAL_ID

The _ID of the original recurring event for which this event is an exception. Column name.

Type: TEXT

Constant Value: "original_id"

public static final String ORIGINAL_INSTANCE_TIME

The original instance time of the recurring event for which this event is an exception. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "originalInstanceTime"

public static final String ORIGINAL_SYNC_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

Constant Value: "original_sync_id"

public static final String RDATE

The recurrence dates for the event. Column name.

Type: TEXT

Constant Value: "rdate"

public static final String RRULE

The recurrence rule for the event. Column name.

Type: TEXT

Constant Value: "rrule"

public static final String SELF_ATTENDEE_STATUS

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)

Constant Value: "selfAttendeeStatus"

public static final String STATUS

The event status. Column name.

Type: INTEGER (one of STATUS_TENTATIVE ...)

Constant Value: "eventStatus"

public static final int STATUS_CANCELED

Constant Value: 2 (0x00000002)

public static final int STATUS_CONFIRMED

Constant Value: 1 (0x00000001)

public static final int STATUS_TENTATIVE

Constant Value: 0 (0x00000000)

public static final String SYNC_DATA1

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data1"

public static final String SYNC_DATA10

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data10"

public static final String SYNC_DATA2

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data2"

public static final String SYNC_DATA3

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data3"

public static final String SYNC_DATA4

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data4"

public static final String SYNC_DATA5

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data5"

public static final String SYNC_DATA6

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data6"

public static final String SYNC_DATA7

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data7"

public static final String SYNC_DATA8

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data8"

public static final String SYNC_DATA9

This column is available for use by sync adapters. Column name.

Type: TEXT

Constant Value: "sync_data9"

public static final String TITLE

The title of the event. Column name.

Type: TEXT

Constant Value: "title"

public static final String UID_2445

The UID for events added from the RFC 2445 iCalendar format. Column name.

Type: TEXT

Constant Value: "uid2445"