Reminders

Kotlin |Java

class Reminders : BaseColumns, CalendarContract.RemindersColumns, CalendarContract.EventsColumns

kotlin.Any
↳	android.provider.CalendarContract.Reminders

Fields and helpers for accessing reminders for an event. Each row of this table represents a single reminder for an event. Calling query(android.content.ContentResolver,long,java.lang.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:

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 RemindersColumns

`String`	`EVENT_ID` The event the reminder belongs to. Column name. Type: INTEGER (foreign key to the Events table)
`String`	`METHOD` 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).
`Int`	`METHOD_ALARM`
`Int`	`METHOD_ALERT`
`Int`	`METHOD_DEFAULT`
`Int`	`METHOD_EMAIL`
`Int`	`METHOD_SMS`
`String`	`MINUTES` 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
`Int`	`MINUTES_DEFAULT` Passing this as a minutes value will use the default reminder minutes.

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 Cursor!	`query(cr: ContentResolver!, eventId: Long, projection: Array<String!>!)` Queries all reminders associated with the given event.

Properties
static Uri!	`CONTENT_URI`

Public methods

query

Added in API level 14

static fun query(
    cr: ContentResolver!, 
    eventId: Long, 
    projection: Array<String!>!
): Cursor!

Queries all reminders associated with the given event. This is a blocking call and should not be done on the UI thread.

Parameters
`cr`	ContentResolver!: The content resolver to use for the query
`eventId`	Long: The id of the event to retrieve reminders for
`projection`	Array<String!>!: the columns to return in the cursor

Return
`Cursor!`	A Cursor containing all reminders for the event

Properties

CONTENT_URI

Added in API level 14

static val CONTENT_URI: Uri!