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)

Added in API level 14

public static final class

CalendarContract.Instances

extends Object
implements BaseColumns CalendarContract.CalendarColumns CalendarContract.EventsColumns

java.lang.Object
↳	android.provider.CalendarContract.Instances

Class Overview

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.

Summary

Constants
String	BEGIN	The beginning time of the instance, in UTC milliseconds.
String	END	The ending time of the instance, in UTC milliseconds.
String	END_DAY	The Julian end day of the instance, relative to the local time zone.
String	END_MINUTE	The end minute of the instance measured from midnight in the local time zone.
String	EVENT_ID	The _id of the event for this instance.
String	START_DAY	The Julian start day of the instance, relative to the local time zone.
String	START_MINUTE	The start minute of the instance measured from midnight in the local time zone.

[Expand]

Inherited Constants

From interface android.provider.BaseColumns

From interface android.provider.CalendarContract.CalendarColumns

From interface android.provider.CalendarContract.EventsColumns

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.

Fields
public static final Uri	CONTENT_BY_DAY_URI	The content:// style URL for querying an instance range by Julian Day.
public static final Uri	CONTENT_SEARCH_BY_DAY_URI	The content:// style URL for querying an instance range with a search term.
public static final Uri	CONTENT_SEARCH_URI	The content:// style URL for querying an instance range with a search term.
public static final Uri	CONTENT_URI	The content:// style URL for querying an instance range.

Public Methods
final static Cursor	query ( ContentResolver cr, String[] projection, long begin, long end) Performs a query to return all visible instances in the given range.
final static Cursor	query ( ContentResolver cr, String[] projection, long begin, long end, String searchQuery) Performs a query to return all visible instances in the given range that match the given query.

[Expand]

Inherited Methods

From class java.lang.Object

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

Constants

public static final String BEGIN

Added in API level 14

The beginning time of the instance, in UTC milliseconds. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "begin"

public static final String END

Added in API level 14

The ending time of the instance, in UTC milliseconds. Column name.

Type: INTEGER (long; millis since epoch)

Constant Value: "end"

public static final String END_DAY

Added in API level 14

The Julian end day of the instance, relative to the local time zone. Column name.

Type: INTEGER (int)

Constant Value: "endDay"

public static final String END_MINUTE

Added in API level 14

The end minute of the instance measured from midnight in the local time zone. Column name.

Type: INTEGER (int)

Constant Value: "endMinute"

public static final String EVENT_ID

Added in API level 14

The _id of the event for this instance. Column name.

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

Constant Value: "event_id"

public static final String START_DAY

Added in API level 14

The Julian start day of the instance, relative to the local time zone. Column name.

Type: INTEGER (int)

Constant Value: "startDay"

public static final String START_MINUTE

Added in API level 14

The start minute of the instance measured from midnight in the local time zone. Column name.

Type: INTEGER (int)

Constant Value: "startMinute"

Fields

public static final Uri CONTENT_BY_DAY_URI

Added in API level 14

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_SEARCH_BY_DAY_URI

Added in API level 14

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_URI

Added in API level 14

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_URI

Added in API level 14

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.

Public Methods

public static final Cursor query ( ContentResolver cr, String[] projection, long begin, long end)

Added in API level 14

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.

Parameters

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

public static final Cursor query ( ContentResolver cr, String[] projection, long begin, long end, String searchQuery)

Added in API level 14

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.

Parameters

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

Results

Interfaces

Classes

Exceptions

CalendarContract.Instances

Class Overview

Summary

Constants

public static final String BEGIN

public static final String END

public static final String END_DAY

public static final String END_MINUTE

public static final String EVENT_ID

public static final String START_DAY

public static final String START_MINUTE

Fields

public static final Uri CONTENT_BY_DAY_URI

public static final Uri CONTENT_SEARCH_BY_DAY_URI

public static final Uri CONTENT_SEARCH_URI

public static final Uri CONTENT_URI

Public Methods

public static final Cursor query ( ContentResolver cr, String[] projection, long begin, long end)

Parameters

Returns

public static final Cursor query ( ContentResolver cr, String[] projection, long begin, long end, String searchQuery)

Parameters

Returns