EventsEntity

Kotlin |Java

class EventsEntity : BaseColumns, CalendarContract.EventsColumns, CalendarContract.SyncColumns

kotlin.Any
↳	android.provider.CalendarContract.EventsEntity

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.

Summary

Inherited constants

From class 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. Column name. Type: INTEGER (One of `ACCESS_DEFAULT`, ...)
`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). Column name. Type: INTEGER (boolean)
`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`)
`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 `Calendars._ID` of the calendar the event belongs to. Column name. Type: INTEGER
`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)
`String`	`CUSTOM_APP_PACKAGE` 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
`String`	`CUSTOM_APP_URI` The URI used by the custom app for the event. Column name. Type: TEXT
`String`	`DESCRIPTION` The description of the event. Column name. Type: TEXT
`String`	`DISPLAY_COLOR` This will be `EVENT_COLOR` if it is not null; otherwise, this will be `Calendars.CALENDAR_COLOR`. Read-only value. To modify, write to `EVENT_COLOR` or `Calendars.CALENDAR_COLOR` directly. Type: INTEGER
`String`	`DTEND` The time the event ends in UTC millis since epoch. Column name. Type: INTEGER (long; millis since epoch)
`String`	`DTSTART` The time the event starts in UTC millis since epoch. Column name. Type: INTEGER (long; millis since epoch)
`String`	`DURATION` The duration of the event in RFC2445 format. Column name. Type: TEXT (duration in RFC2445 format)
`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
`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 `Colors` table. @see Colors Type: TEXT
`String`	`EVENT_END_TIMEZONE` The timezone for the end time of the event. Column name. Type: TEXT
`String`	`EVENT_LOCATION` Where the event takes place. Column name. Type: TEXT
`String`	`EVENT_TIMEZONE` The timezone for the event. Column name. Type: TEXT
`String`	`EXDATE` The recurrence exception dates for the event. Column name. Type: TEXT
`String`	`EXRULE` The recurrence exception rule for the event. Column name. Type: TEXT
`String`	`GUESTS_CAN_INVITE_OTHERS` Whether guests can invite other guests. Column name. Type: INTEGER (boolean)
`String`	`GUESTS_CAN_MODIFY` Whether guests can modify the event. Column name. Type: INTEGER (boolean)
`String`	`GUESTS_CAN_SEE_GUESTS` Whether guests can see the list of attendees. Column name. Type: INTEGER (boolean)
`String`	`HAS_ALARM` Whether the event has an alarm or not. Column name. Type: INTEGER (boolean)
`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)
`String`	`HAS_EXTENDED_PROPERTIES` Whether the event has extended properties or not. Column name. Type: INTEGER (boolean)
`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 `Calendars.OWNER_ACCOUNT`. Column name. Type: STRING
`String`	`LAST_DATE` The last date this event repeats on, or NULL if it never ends. Column name. Type: INTEGER (long; millis since epoch)
`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 `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. Type: INTEGER (boolean)
`String`	`ORGANIZER` Email of the organizer (owner) of the event. Column name. Type: STRING
`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)
`String`	`ORIGINAL_ID` The `Events._ID` of the original recurring event for which this event is an exception. Column name. Type: TEXT
`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)
`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
`String`	`RDATE` The recurrence dates for the event. Column name. Type: TEXT
`String`	`RRULE` The recurrence rule for the event. Column name. Type: TEXT
`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)
`String`	`STATUS` The event status. Column name. Type: INTEGER (one of `STATUS_TENTATIVE`...)
`Int`	`STATUS_CANCELED`
`Int`	`STATUS_CONFIRMED`
`Int`	`STATUS_TENTATIVE`
`String`	`SYNC_DATA1` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA10` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA2` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA3` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA4` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA5` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA6` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA7` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA8` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`SYNC_DATA9` This column is available for use by sync adapters. Column name. Type: TEXT
`String`	`TITLE` The title of the event. Column name. Type: TEXT
`String`	`UID_2445` The UID for events added from the RFC 2445 iCalendar format. Column name. Type: TEXT

From class SyncColumns

`String`	`ACCOUNT_NAME` The account that was used to sync the entry to the device. If the account_type is not `ACCOUNT_TYPE_LOCAL` then the name and type must match an account on the device or the calendar will be deleted. Type: TEXT
`String`	`ACCOUNT_TYPE` The type of the account that was used to sync the entry to the device. A type of `ACCOUNT_TYPE_LOCAL` will keep this event form being deleted if there are no matching accounts on the device. Type: TEXT
`String`	`CAN_PARTIALLY_UPDATE` If set to 1 this causes events on this calendar to be duplicated with `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. Type: INTEGER (boolean)
`String`	`DELETED` Whether the row has been deleted but not synced to the server. A deleted row should be ignored. Type: INTEGER (boolean)
`String`	`DIRTY` Used to indicate that local, unsynced, changes are present. Type: INTEGER (long)
`String`	`MUTATORS` Used in conjunction with `DIRTY` to indicate what packages wrote local changes. Type: TEXT
`String`	`_SYNC_ID` 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

From class CalendarSyncColumns

`String`	`CAL_SYNC1` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC10` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC2` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC3` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC4` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC5` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC6` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC7` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC8` Generic column for use by sync adapters. Column name. Type: TEXT
`String`	`CAL_SYNC9` Generic column for use by sync adapters. Column name. Type: TEXT

From class BaseColumns

String

_COUNT

The count of rows in a directory.

Type: INTEGER

String

_ID

The unique ID for a row.

Type: INTEGER (long)

Public methods
static EntityIterator!	`newEntityIterator(cursor: Cursor!, provider: ContentProviderClient!)` Creates a new iterator for events
static EntityIterator!	`newEntityIterator(cursor: Cursor!, resolver: ContentResolver!)` Creates a new iterator for events

Properties
static Uri!	`CONTENT_URI` The content:// style URL for this table

Public methods

newEntityIterator

Added in API level 14

static fun newEntityIterator(
    cursor: Cursor!, 
    provider: ContentProviderClient!
): EntityIterator!

Creates a new iterator for events

Parameters
`cursor`	Cursor!: An event query
`provider`	ContentProviderClient!: For performing additional queries

Return
`EntityIterator!`	an EntityIterator containing one entity per event in the cursor

newEntityIterator

Added in API level 14

static fun newEntityIterator(
    cursor: Cursor!, 
    resolver: ContentResolver!
): EntityIterator!

Creates a new iterator for events

Parameters
`cursor`	Cursor!: An event query
`resolver`	ContentResolver!: For performing additional queries

Return
`EntityIterator!`	an EntityIterator containing one entity per event in the cursor

Properties

CONTENT_URI

Added in API level 14

static val CONTENT_URI: Uri!

The content:// style URL for this table