日历提供程序是用户日历事件的存储库。日历提供程序 API 允许您对日历、事件、参与者、提醒等执行查询、插入、更新和删除操作。
应用和同步适配器都可以使用日历提供程序 API。规则因调用程序的类型而异。本文档主要介绍如何将日历提供程序 API 用作应用。有关同步适配器有何不同之处的讨论,请参阅同步适配器。
通常,为了读取或写入日历数据,应用的清单必须包含适当的权限,如用户权限中所述。为了使执行常见操作更加容易,日历提供程序提供了一组 intent,如日历 Intent中所述。这些 intent 会将用户带到日历应用以插入、查看和编辑事件。用户与日历应用交互,然后返回到原始应用。因此,您的应用无需请求权限,也无需提供用户界面来查看或创建事件。
基础知识
内容提供程序存储数据并使其可供应用访问。Android 平台提供的(包括日历提供程序在内的)内容提供程序通常以基于关系数据库模型的表格集形式公开数据,其中每一行都是一条记录,每一列都是特定类型和含义的数据。通过日历提供程序 API,应用和同步适配器可以对保存用户日历数据的数据库表进行读写访问。
每个内容提供程序都公开一个公共 URI(封装为 Uri
对象),用于唯一标识其数据集。控制多个数据集(多个表格)的内容提供程序会为每个数据集公开一个单独的 URI。所有提供程序的 URI 都以字符串“content://”开头。这表明数据由内容提供程序控制。日历提供程序为其每个类(表格)定义了 URI 常量。这些 URI 的格式为 <class>.CONTENT_URI
。例如,Events.CONTENT_URI
。
图 1 显示了日历提供程序数据模型的图形表示。它展示了主要表格以及将它们相互关联的字段。

图 1. 日历提供程序数据模型。
一个用户可以拥有多个日历,不同的日历可以关联不同的帐号类型(Google 日历、Exchange 等)。
CalendarContract
定义了日历和事件相关信息的数据模型。这些数据存储在许多表格中,如下所示。
表格(类) | 说明 |
---|---|
此表格包含特定于日历的信息。此表格中的每一行都包含单个日历的详细信息,例如名称、颜色、同步信息等。 | |
CalendarContract.Events |
此表格包含特定于事件的信息。此表格中的每一行都包含单个事件的信息,例如事件标题、位置、开始时间、结束时间等。事件可以发生一次,也可以多次重复。参与者、提醒和扩展属性存储在单独的表格中。它们都具有引用 Events 表中 _ID 的 EVENT_ID 。 |
CalendarContract.Instances |
此表格包含事件每次出现的开始时间和结束时间。此表格中的每一行都代表一次事件出现。对于一次性事件,Instance 与 Event 之间存在 1:1 的映射关系。对于重复性事件,系统会自动生成多行,对应于该事件的多次出现。 |
CalendarContract.Attendees |
此表格包含事件参与者(来宾)信息。每一行代表一个事件的单个来宾。它指定来宾的类型以及来宾对事件的出勤响应。 |
CalendarContract.Reminders |
此表格包含提醒/通知数据。每一行代表一个事件的单个提醒。一个事件可以有多个提醒。每个事件的最大提醒数在 MAX_REMINDERS 中指定,该值由拥有给定日历的同步适配器设置。提醒指定为事件发生前的分钟数,并具有确定如何向用户发出提醒的方法。 |
日历提供程序 API 设计灵活且功能强大。同时,提供良好的最终用户体验并保护日历及其数据的完整性也非常重要。为此,在使用 API 时需要牢记以下几点:
- 插入、更新和查看日历事件。要直接从日历提供程序插入、修改和读取事件,您需要适当的权限。但是,如果您不是要构建一个功能齐全的日历应用或同步适配器,则无需请求这些权限。您可以改用 Android 日历应用支持的 intent,将读写操作交给该应用。当您使用 intent 时,您的应用会将用户发送到日历应用,以便在预填充的表单中执行所需的操作。完成后,他们会返回到您的应用。通过将您的应用设计为通过日历执行常见操作,您可以为用户提供一致、稳健的用户界面。这是推荐的方法。如需了解更多信息,请参阅日历 Intent。
- 同步适配器。同步适配器将用户设备上的日历数据与另一个服务器或数据源同步。在
CalendarContract.Calendars
和CalendarContract.Events
表中,有一些列是保留给同步适配器使用的。提供程序和应用不应修改它们。事实上,除非作为同步适配器访问它们,否则它们是不可见的。有关同步适配器的更多信息,请参阅同步适配器。
用户权限
要读取日历数据,应用必须在其清单文件中包含 READ_CALENDAR
权限。要删除、插入或更新日历数据,它必须包含 WRITE_CALENDAR
权限
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android"...> <uses-sdk android:minSdkVersion="14" /> <uses-permission android:name="android.permission.READ_CALENDAR" /> <uses-permission android:name="android.permission.WRITE_CALENDAR" /> ... </manifest>
日历表格
CalendarContract.Calendars
表格包含单个日历的详细信息。以下日历列可由应用和同步适配器写入。有关支持字段的完整列表,请参阅 CalendarContract.Calendars
参考文档。
常量 | 说明 |
---|---|
NAME |
日历的名称。 |
CALENDAR_DISPLAY_NAME |
向用户显示的此日历的名称。 |
VISIBLE |
一个布尔值,指示是否选择此日历以显示。值为 0 表示不应显示与此日历关联的事件。值为 1 表示应显示与此日历关联的事件。此值会影响 CalendarContract.Instances 表格中行的生成。 |
SYNC_EVENTS |
一个布尔值,指示是否应同步此日历并将其事件存储在设备上。值为 0 表示不同步此日历或不将其事件存储在设备上。值为 1 表示同步此日历的事件并将其事件存储在设备上。 |
所有操作均包含帐号类型
如果您查询 Calendars.ACCOUNT_NAME
,则还必须在 selection 中包含 Calendars.ACCOUNT_TYPE
。这是因为给定的帐号只有在其 ACCOUNT_NAME
和 ACCOUNT_TYPE
都存在时才被视为唯一。 ACCOUNT_TYPE
是注册帐号到 AccountManager
时使用的帐号验证器对应的字符串。对于未与设备帐号关联的日历,还有一个特殊类型的帐号称为 ACCOUNT_TYPE_LOCAL
。 ACCOUNT_TYPE_LOCAL
帐号不会被同步。
查询日历
这是一个示例,展示如何获取特定用户拥有的日历。为简单起见,在此示例中,查询操作显示在用户界面线程(“主线程”)中。在实际应用中,这应该在异步线程中完成,而不是在主线程中。有关更多讨论,请参阅Loader。如果您不仅要读取数据,还要修改数据,请参阅 AsyncQueryHandler
。
Kotlin
// Projection array. Creating indices for this array instead of doing // dynamic lookups improves performance. private val EVENT_PROJECTION: Array<String> = arrayOf( CalendarContract.Calendars._ID, // 0 CalendarContract.Calendars.ACCOUNT_NAME, // 1 CalendarContract.Calendars.CALENDAR_DISPLAY_NAME, // 2 CalendarContract.Calendars.OWNER_ACCOUNT // 3 ) // The indices for the projection array above. private const val PROJECTION_ID_INDEX: Int = 0 private const val PROJECTION_ACCOUNT_NAME_INDEX: Int = 1 private const val PROJECTION_DISPLAY_NAME_INDEX: Int = 2 private const val PROJECTION_OWNER_ACCOUNT_INDEX: Int = 3
Java
// Projection array. Creating indices for this array instead of doing // dynamic lookups improves performance. public static final String[] EVENT_PROJECTION = new String[] { Calendars._ID, // 0 Calendars.ACCOUNT_NAME, // 1 Calendars.CALENDAR_DISPLAY_NAME, // 2 Calendars.OWNER_ACCOUNT // 3 }; // The indices for the projection array above. private static final int PROJECTION_ID_INDEX = 0; private static final int PROJECTION_ACCOUNT_NAME_INDEX = 1; private static final int PROJECTION_DISPLAY_NAME_INDEX = 2; private static final int PROJECTION_OWNER_ACCOUNT_INDEX = 3;
在示例的下一部分中,您构建查询。selection 指定查询的条件。在此示例中,查询正在查找 ACCOUNT_NAME
为“hera@example.com”、ACCOUNT_TYPE
为“com.example”以及 OWNER_ACCOUNT
为“hera@example.com”的日历。如果您想查看用户查看过的所有日历,而不仅仅是用户拥有的日历,请省略 OWNER_ACCOUNT
。查询返回一个 Cursor
对象,您可以使用它来遍历数据库查询返回的结果集。有关在内容提供程序中使用查询的更多讨论,请参阅内容提供程序。
Kotlin
// Run query val uri: Uri = CalendarContract.Calendars.CONTENT_URI val selection: String = "((${CalendarContract.Calendars.ACCOUNT_NAME} = ?) AND (" + "${CalendarContract.Calendars.ACCOUNT_TYPE} = ?) AND (" + "${CalendarContract.Calendars.OWNER_ACCOUNT} = ?))" val selectionArgs: Array<String> = arrayOf("hera@example.com", "com.example", "hera@example.com") val cur: Cursor = contentResolver.query(uri, EVENT_PROJECTION, selection, selectionArgs, null)
Java
// Run query Cursor cur = null; ContentResolver cr = getContentResolver(); Uri uri = Calendars.CONTENT_URI; String selection = "((" + Calendars.ACCOUNT_NAME + " = ?) AND (" + Calendars.ACCOUNT_TYPE + " = ?) AND (" + Calendars.OWNER_ACCOUNT + " = ?))"; String[] selectionArgs = new String[] {"hera@example.com", "com.example", "hera@example.com"}; // Submit the query and get a Cursor object back. cur = cr.query(uri, EVENT_PROJECTION, selection, selectionArgs, null);
下一节使用游标遍历结果集。它使用示例开头设置的常量返回每个字段的值。
Kotlin
// Use the cursor to step through the returned records while (cur.moveToNext()) { // Get the field values val calID: Long = cur.getLong(PROJECTION_ID_INDEX) val displayName: String = cur.getString(PROJECTION_DISPLAY_NAME_INDEX) val accountName: String = cur.getString(PROJECTION_ACCOUNT_NAME_INDEX) val ownerName: String = cur.getString(PROJECTION_OWNER_ACCOUNT_INDEX) // Do something with the values... }
Java
// Use the cursor to step through the returned records while (cur.moveToNext()) { long calID = 0; String displayName = null; String accountName = null; String ownerName = null; // Get the field values calID = cur.getLong(PROJECTION_ID_INDEX); displayName = cur.getString(PROJECTION_DISPLAY_NAME_INDEX); accountName = cur.getString(PROJECTION_ACCOUNT_NAME_INDEX); ownerName = cur.getString(PROJECTION_OWNER_ACCOUNT_INDEX); // Do something with the values... ... }
修改日历
要执行日历更新,您可以将日历的 _ID
作为附加 ID 提供给 Uri (withAppendedId()
),或者作为第一个选择项提供。selection 应以 "_id=?"
开头,第一个 selectionArg
应是日历的 _ID
。您也可以通过在 URI 中编码 ID 进行更新。此示例使用 (withAppendedId()
) 方法更改日历的显示名称
Kotlin
const val DEBUG_TAG: String = "MyActivity" ... val calID: Long = 2 val values = ContentValues().apply { // The new display name for the calendar put(CalendarContract.Calendars.CALENDAR_DISPLAY_NAME, "Trevor's Calendar") } val updateUri: Uri = ContentUris.withAppendedId(CalendarContract.Calendars.CONTENT_URI, calID) val rows: Int = contentResolver.update(updateUri, values, null, null) Log.i(DEBUG_TAG, "Rows updated: $rows")
Java
private static final String DEBUG_TAG = "MyActivity"; ... long calID = 2; ContentValues values = new ContentValues(); // The new display name for the calendar values.put(Calendars.CALENDAR_DISPLAY_NAME, "Trevor's Calendar"); Uri updateUri = ContentUris.withAppendedId(Calendars.CONTENT_URI, calID); int rows = getContentResolver().update(updateUri, values, null, null); Log.i(DEBUG_TAG, "Rows updated: " + rows);
插入日历
日历主要设计由同步适配器管理,因此您只应作为同步适配器插入新日历。在大多数情况下,应用只能对日历进行表面的更改,例如更改显示名称。如果应用需要创建本地日历,可以通过将日历插入作为同步适配器执行,使用 ACCOUNT_TYPE
为 ACCOUNT_TYPE_LOCAL
来完成。 ACCOUNT_TYPE_LOCAL
是一种特殊的帐号类型,适用于未与设备帐号关联的日历。此类型的日历不会同步到服务器。有关同步适配器的讨论,请参阅同步适配器。
事件表格
CalendarContract.Events
表格包含单个事件的详细信息。要添加、更新或删除事件,应用必须在其清单文件中包含 WRITE_CALENDAR
权限。
以下 Events 列可由应用和同步适配器写入。有关支持字段的完整列表,请参阅 CalendarContract.Events
参考文档。
常量 | 说明 |
---|---|
CALENDAR_ID |
事件所属日历的 _ID 。 |
ORGANIZER |
事件组织者(所有者)的电子邮件地址。 |
TITLE |
事件的标题。 |
EVENT_LOCATION |
事件发生地点。 |
DESCRIPTION |
事件的描述。 |
DTSTART |
事件开始时间,以 epoch 以来的 UTC 毫秒为单位。 |
DTEND |
事件结束时间,以 epoch 以来的 UTC 毫秒为单位。 |
EVENT_TIMEZONE |
事件的时区。 |
EVENT_END_TIMEZONE |
事件结束时间的时区。 |
DURATION |
事件持续时间,格式为RFC5545。例如,值为 "PT1H" 表示事件持续一小时,值为 "P2W" 表示持续两周。 |
ALL_DAY |
值为 1 表示此事件占用全天,由本地时区定义。值为 0 表示这是一个普通事件,可能在一天中的任何时间开始和结束。 |
RRULE |
事件格式的重复规则。例如,"FREQ=WEEKLY;COUNT=10;WKST=SU" 。您可以在此处找到更多示例。 |
RDATE |
事件的重复日期。通常,您将 RDATE 与 RRULE 结合使用,以定义重复出现的聚合集。如需更多讨论,请参阅 RFC5545 规范。 |
AVAILABILITY |
此事件是否计为忙碌时间,或是否为可以安排的其他事件的空闲时间。 |
GUESTS_CAN_MODIFY |
来宾是否可以修改事件。 |
GUESTS_CAN_INVITE_OTHERS |
来宾是否可以邀请其他来宾。 |
GUESTS_CAN_SEE_GUESTS |
来宾是否可以看到参与者列表。 |
添加事件
当您的应用插入新事件时,我们建议您使用 INSERT
Intent,如使用 intent 插入事件中所述。但是,如果需要,您可以直接插入事件。本节介绍如何执行此操作。
以下是插入新事件的规则
- 您必须包含
CALENDAR_ID
和DTSTART
。 - 您必须包含
EVENT_TIMEZONE
。要获取系统已安装时区 ID 的列表,请使用getAvailableIDs()
。请注意,如果您通过INSERT
Intent(如使用 intent 插入事件中所述)插入事件,此规则不适用 - 在该场景下,会提供一个默认时区。 - 对于非重复性事件,您必须包含
DTEND
。 - 对于重复性事件,除了
RRULE
或RDATE
外,您必须包含DURATION
。请注意,如果您通过INSERT
Intent(如使用 intent 插入事件中所述)插入事件,此规则不适用 - 在该场景下,您可以结合使用RRULE
和DTSTART
和DTEND
,日历应用会自动将其转换为持续时间。
这是一个插入事件的示例。为简单起见,此操作在 UI 线程中执行。在实际应用中,插入和更新应在异步线程中完成,将操作移动到后台线程。如需了解更多信息,请参阅 AsyncQueryHandler
。
Kotlin
val calID: Long = 3 val startMillis: Long = Calendar.getInstance().run { set(2012, 9, 14, 7, 30) timeInMillis } val endMillis: Long = Calendar.getInstance().run { set(2012, 9, 14, 8, 45) timeInMillis } ... val values = ContentValues().apply { put(CalendarContract.Events.DTSTART, startMillis) put(CalendarContract.Events.DTEND, endMillis) put(CalendarContract.Events.TITLE, "Jazzercise") put(CalendarContract.Events.DESCRIPTION, "Group workout") put(CalendarContract.Events.CALENDAR_ID, calID) put(CalendarContract.Events.EVENT_TIMEZONE, "America/Los_Angeles") } val uri: Uri = contentResolver.insert(CalendarContract.Events.CONTENT_URI, values) // get the event ID that is the last element in the Uri val eventID: Long = uri.lastPathSegment.toLong() // // ... do something with event ID // //
Java
long calID = 3; long startMillis = 0; long endMillis = 0; Calendar beginTime = Calendar.getInstance(); beginTime.set(2012, 9, 14, 7, 30); startMillis = beginTime.getTimeInMillis(); Calendar endTime = Calendar.getInstance(); endTime.set(2012, 9, 14, 8, 45); endMillis = endTime.getTimeInMillis(); ... ContentResolver cr = getContentResolver(); ContentValues values = new ContentValues(); values.put(Events.DTSTART, startMillis); values.put(Events.DTEND, endMillis); values.put(Events.TITLE, "Jazzercise"); values.put(Events.DESCRIPTION, "Group workout"); values.put(Events.CALENDAR_ID, calID); values.put(Events.EVENT_TIMEZONE, "America/Los_Angeles"); Uri uri = cr.insert(Events.CONTENT_URI, values); // get the event ID that is the last element in the Uri long eventID = Long.parseLong(uri.getLastPathSegment()); // // ... do something with event ID // //
注意:请注意此示例如何在创建事件后捕获事件 ID。这是获取事件 ID 的最简单方法。您通常需要事件 ID 来执行其他日历操作,例如向事件添加参与者或提醒。
更新事件
当您的应用想允许用户编辑事件时,我们建议您使用 EDIT
Intent,如使用 intent 编辑事件中所述。但是,如果需要,您可以直接编辑事件。要执行事件更新,您可以将事件的 _ID
作为附加 ID 提供给 Uri (withAppendedId()
),或者作为第一个选择项提供。selection 应以 "_id=?"
开头,第一个 selectionArg
应是事件的 _ID
。您也可以使用不带 ID 的 selection 进行更新。这是一个更新事件的示例。它使用 withAppendedId()
方法更改事件的标题
Kotlin
val DEBUG_TAG = "MyActivity" ... val eventID: Long = 188 ... val values = ContentValues().apply { // The new title for the event put(CalendarContract.Events.TITLE, "Kickboxing") } val updateUri: Uri = ContentUris.withAppendedId(CalendarContract.Events.CONTENT_URI, eventID) val rows: Int = contentResolver.update(updateUri, values, null, null) Log.i(DEBUG_TAG, "Rows updated: $rows")
Java
private static final String DEBUG_TAG = "MyActivity"; ... long eventID = 188; ... ContentResolver cr = getContentResolver(); ContentValues values = new ContentValues(); Uri updateUri = null; // The new title for the event values.put(Events.TITLE, "Kickboxing"); updateUri = ContentUris.withAppendedId(Events.CONTENT_URI, eventID); int rows = cr.update(updateUri, values, null, null); Log.i(DEBUG_TAG, "Rows updated: " + rows);
删除事件
您可以通过其 _ID
作为 URI 上的附加 ID 删除事件,或使用标准选择。如果您使用附加 ID,则不能同时进行选择。删除有两种版本:作为应用和作为同步适配器。应用删除会将 deleted 列设置为 1。此标志告诉同步适配器该行已被删除,并且此删除应传播到服务器。同步适配器删除将事件及其所有相关数据从数据库中移除。这是一个应用通过其 _ID
删除事件的示例
Kotlin
val DEBUG_TAG = "MyActivity" ... val eventID: Long = 201 ... val deleteUri: Uri = ContentUris.withAppendedId(CalendarContract.Events.CONTENT_URI, eventID) val rows: Int = contentResolver.delete(deleteUri, null, null) Log.i(DEBUG_TAG, "Rows deleted: $rows")
Java
private static final String DEBUG_TAG = "MyActivity"; ... long eventID = 201; ... ContentResolver cr = getContentResolver(); Uri deleteUri = null; deleteUri = ContentUris.withAppendedId(Events.CONTENT_URI, eventID); int rows = cr.delete(deleteUri, null, null); Log.i(DEBUG_TAG, "Rows deleted: " + rows);
参与者表格
CalendarContract.Attendees
表的每一行表示事件的单个参与者或来宾。调用 query()
返回具有给定 EVENT_ID
的事件的参与者列表。此 EVENT_ID
必须与特定事件的 _ID
匹配。
下表列出了可写字段。插入新参与者时,您必须包含所有这些字段,但 ATTENDEE_NAME
除外。
常量 | 说明 |
---|---|
EVENT_ID |
事件的 ID。 |
ATTENDEE_NAME |
参与者的姓名。 |
ATTENDEE_EMAIL |
参与者的电子邮件地址。 |
ATTENDEE_RELATIONSHIP |
参与者与事件的关系。以下之一: |
ATTENDEE_TYPE |
参与者类型。以下之一: |
ATTENDEE_STATUS |
参与者的出勤状态。以下之一: |
添加参与者
这是一个向事件添加单个参与者的示例。请注意,EVENT_ID
是必需的
Kotlin
val eventID: Long = 202 ... val values = ContentValues().apply { put(CalendarContract.Attendees.ATTENDEE_NAME, "Trevor") put(CalendarContract.Attendees.ATTENDEE_EMAIL, "trevor@example.com") put( CalendarContract.Attendees.ATTENDEE_RELATIONSHIP, CalendarContract.Attendees.RELATIONSHIP_ATTENDEE ) put(CalendarContract.Attendees.ATTENDEE_TYPE, CalendarContract.Attendees.TYPE_OPTIONAL) put( CalendarContract.Attendees.ATTENDEE_STATUS, CalendarContract.Attendees.ATTENDEE_STATUS_INVITED ) put(CalendarContract.Attendees.EVENT_ID, eventID) } val uri: Uri = contentResolver.insert(CalendarContract.Attendees.CONTENT_URI, values)
Java
long eventID = 202; ... ContentResolver cr = getContentResolver(); ContentValues values = new ContentValues(); values.put(Attendees.ATTENDEE_NAME, "Trevor"); values.put(Attendees.ATTENDEE_EMAIL, "trevor@example.com"); values.put(Attendees.ATTENDEE_RELATIONSHIP, Attendees.RELATIONSHIP_ATTENDEE); values.put(Attendees.ATTENDEE_TYPE, Attendees.TYPE_OPTIONAL); values.put(Attendees.ATTENDEE_STATUS, Attendees.ATTENDEE_STATUS_INVITED); values.put(Attendees.EVENT_ID, eventID); Uri uri = cr.insert(Attendees.CONTENT_URI, values);
提醒表格
CalendarContract.Reminders
表的每一行代表事件的单个提醒。调用 query()
返回具有给定 EVENT_ID
的事件的提醒列表。
下表列出了提醒的可写字段。插入新提醒时必须包含所有这些字段。请注意,同步适配器在 CalendarContract.Calendars
表中指定它们支持的提醒类型。有关详情,请参阅 ALLOWED_REMINDERS
。
常量 | 说明 |
---|---|
EVENT_ID |
事件的 ID。 |
MINUTES |
提醒应在事件发生前多少分钟触发。 |
METHOD |
闹钟方法,在服务器上设置。以下之一: |
添加提醒
此示例向事件添加提醒。提醒在事件发生前 15 分钟触发。
Kotlin
val eventID: Long = 221 ... val values = ContentValues().apply { put(CalendarContract.Reminders.MINUTES, 15) put(CalendarContract.Reminders.EVENT_ID, eventID) put(CalendarContract.Reminders.METHOD, CalendarContract.Reminders.METHOD_ALERT) } val uri: Uri = contentResolver.insert(CalendarContract.Reminders.CONTENT_URI, values)
Java
long eventID = 221; ... ContentResolver cr = getContentResolver(); ContentValues values = new ContentValues(); values.put(Reminders.MINUTES, 15); values.put(Reminders.EVENT_ID, eventID); values.put(Reminders.METHOD, Reminders.METHOD_ALERT); Uri uri = cr.insert(Reminders.CONTENT_URI, values);
实例表格
CalendarContract.Instances
表格包含事件出现的开始时间和结束时间。此表格中的每一行都代表一次事件出现。实例表格不可写,仅提供查询事件出现的方式。
下表列出了您可以针对实例查询的一些字段。请注意,时区由 KEY_TIMEZONE_TYPE
和 KEY_TIMEZONE_INSTANCES
定义。
常量 | 说明 |
---|---|
BEGIN |
实例的开始时间,以 UTC 毫秒为单位。 |
END |
实例的结束时间,以 UTC 毫秒为单位。 |
END_DAY |
实例的儒略结束日,相对于日历的时区。 |
END_MINUTE |
实例的结束分钟,从日历时区的午夜算起。 |
EVENT_ID |
此实例对应事件的 _ID 。 |
START_DAY |
实例的儒略开始日,相对于日历的时区。 |
START_MINUTE |
实例的开始分钟,从日历时区的午夜算起。 |
查询实例表格
要查询 Instances 表格,您需要在 URI 中为查询指定一个时间范围。在此示例中,CalendarContract.Instances
通过实现 CalendarContract.EventsColumns
接口来访问 TITLE
字段。换句话说,TITLE
是通过数据库视图返回的,而不是通过查询原始 CalendarContract.Instances
表格返回的。
Kotlin
const val DEBUG_TAG: String = "MyActivity" val INSTANCE_PROJECTION: Array<String> = arrayOf( CalendarContract.Instances.EVENT_ID, // 0 CalendarContract.Instances.BEGIN, // 1 CalendarContract.Instances.TITLE // 2 ) // The indices for the projection array above. const val PROJECTION_ID_INDEX: Int = 0 const val PROJECTION_BEGIN_INDEX: Int = 1 const val PROJECTION_TITLE_INDEX: Int = 2 // Specify the date range you want to search for recurring // event instances val startMillis: Long = Calendar.getInstance().run { set(2011, 9, 23, 8, 0) timeInMillis } val endMillis: Long = Calendar.getInstance().run { set(2011, 10, 24, 8, 0) timeInMillis } // The ID of the recurring event whose instances you are searching // for in the Instances table val selection: String = "${CalendarContract.Instances.EVENT_ID} = ?" val selectionArgs: Array<String> = arrayOf("207") // Construct the query with the desired date range. val builder: Uri.Builder = CalendarContract.Instances.CONTENT_URI.buildUpon() ContentUris.appendId(builder, startMillis) ContentUris.appendId(builder, endMillis) // Submit the query val cur: Cursor = contentResolver.query( builder.build(), INSTANCE_PROJECTION, selection, selectionArgs, null ) while (cur.moveToNext()) { // Get the field values val eventID: Long = cur.getLong(PROJECTION_ID_INDEX) val beginVal: Long = cur.getLong(PROJECTION_BEGIN_INDEX) val title: String = cur.getString(PROJECTION_TITLE_INDEX) // Do something with the values. Log.i(DEBUG_TAG, "Event: $title") val calendar = Calendar.getInstance().apply { timeInMillis = beginVal } val formatter = SimpleDateFormat("MM/dd/yyyy") Log.i(DEBUG_TAG, "Date: ${formatter.format(calendar.time)}") }
Java
private static final String DEBUG_TAG = "MyActivity"; public static final String[] INSTANCE_PROJECTION = new String[] { Instances.EVENT_ID, // 0 Instances.BEGIN, // 1 Instances.TITLE // 2 }; // The indices for the projection array above. private static final int PROJECTION_ID_INDEX = 0; private static final int PROJECTION_BEGIN_INDEX = 1; private static final int PROJECTION_TITLE_INDEX = 2; ... // Specify the date range you want to search for recurring // event instances Calendar beginTime = Calendar.getInstance(); beginTime.set(2011, 9, 23, 8, 0); long startMillis = beginTime.getTimeInMillis(); Calendar endTime = Calendar.getInstance(); endTime.set(2011, 10, 24, 8, 0); long endMillis = endTime.getTimeInMillis(); Cursor cur = null; ContentResolver cr = getContentResolver(); // The ID of the recurring event whose instances you are searching // for in the Instances table String selection = Instances.EVENT_ID + " = ?"; String[] selectionArgs = new String[] {"207"}; // Construct the query with the desired date range. Uri.Builder builder = Instances.CONTENT_URI.buildUpon(); ContentUris.appendId(builder, startMillis); ContentUris.appendId(builder, endMillis); // Submit the query cur = cr.query(builder.build(), INSTANCE_PROJECTION, selection, selectionArgs, null); while (cur.moveToNext()) { String title = null; long eventID = 0; long beginVal = 0; // Get the field values eventID = cur.getLong(PROJECTION_ID_INDEX); beginVal = cur.getLong(PROJECTION_BEGIN_INDEX); title = cur.getString(PROJECTION_TITLE_INDEX); // Do something with the values. Log.i(DEBUG_TAG, "Event: " + title); Calendar calendar = Calendar.getInstance(); calendar.setTimeInMillis(beginVal); DateFormat formatter = new SimpleDateFormat("MM/dd/yyyy"); Log.i(DEBUG_TAG, "Date: " + formatter.format(calendar.getTime())); } }
日历 Intent
您的应用不需要权限来读取和写入日历数据。它可以改用 Android 日历应用支持的 intent,将读写操作交给该应用。下表列出了日历提供程序支持的 intent
操作 | URI | 说明 | 额外项 |
---|---|---|---|
VIEW |
CalendarContract.CONTENT_URI 引用此 URI。有关使用此 intent 的示例,请参阅使用 intent 查看日历数据。 |
打开日历到 <ms_since_epoch> 指定的时间。 |
无。 |
Events.CONTENT_URI 引用此 URI。有关使用此 intent 的示例,请参阅使用 intent 查看日历数据。 |
查看由 <event_id> 指定的事件。 |
CalendarContract.EXTRA_EVENT_BEGIN_TIME CalendarContract.EXTRA_EVENT_END_TIME |
|
EDIT |
Events.CONTENT_URI 引用此 URI。有关使用此 intent 的示例,请参阅使用 intent 编辑事件。 |
编辑由 <event_id> 指定的事件。 |
CalendarContract.EXTRA_EVENT_BEGIN_TIME CalendarContract.EXTRA_EVENT_END_TIME |
EDIT INSERT |
Events.CONTENT_URI 引用此 URI。有关使用此 intent 的示例,请参阅使用 intent 插入事件。 |
创建事件。 | 下表中列出的任何额外项。 |
下表列出了日历提供程序支持的 intent 额外项
Intent 额外项 | 说明 |
---|---|
Events.TITLE |
事件的名称。 |
CalendarContract.EXTRA_EVENT_BEGIN_TIME |
事件开始时间,以 epoch 以来的毫秒为单位。 |
CalendarContract.EXTRA_EVENT_END_TIME |
事件结束时间,以 epoch 以来的毫秒为单位。 |
CalendarContract.EXTRA_EVENT_ALL_DAY |
一个布尔值,指示事件是否为全天事件。值可以是 true 或 false 。 |
Events.EVENT_LOCATION |
事件的地点。 |
Events.DESCRIPTION |
事件描述。 |
Intent.EXTRA_EMAIL |
邀请对象的电子邮件地址列表,以逗号分隔。 |
Events.RRULE |
事件的重复规则。 |
Events.ACCESS_LEVEL |
事件是私有还是公开。 |
Events.AVAILABILITY |
此事件是否计为忙碌时间,或是否为可以安排的其他事件的空闲时间。 |
以下部分介绍如何使用这些 intent。
使用 intent 插入事件
使用 INSERT
Intent 可以让您的应用将事件插入任务交给日历本身。使用这种方法,您的应用甚至不需要在清单文件中包含 WRITE_CALENDAR
权限。
当用户运行使用此方法的应用时,应用会将他们发送到日历以完成添加事件。 INSERT
Intent 使用额外字段预填充日历中包含事件详细信息的表单。然后用户可以取消事件,根据需要编辑表单,或将事件保存到他们的日历。
这是一个代码片段,安排一个 2012 年 1 月 19 日的事件,从上午 7:30 持续到上午 8:30。请注意以下有关此代码片段的信息:
- 它指定
Events.CONTENT_URI
作为 Uri。 - 它使用
CalendarContract.EXTRA_EVENT_BEGIN_TIME
和CalendarContract.EXTRA_EVENT_END_TIME
额外字段预填充带有事件时间的表单。这些时间的值必须是自 epoch 以来的 UTC 毫秒。 - 它使用
Intent.EXTRA_EMAIL
额外字段提供受邀者的电子邮件地址列表,以逗号分隔。
Kotlin
val startMillis: Long = Calendar.getInstance().run { set(2012, 0, 19, 7, 30) timeInMillis } val endMillis: Long = Calendar.getInstance().run { set(2012, 0, 19, 8, 30) timeInMillis } val intent = Intent(Intent.ACTION_INSERT) .setData(CalendarContract.Events.CONTENT_URI) .putExtra(CalendarContract.EXTRA_EVENT_BEGIN_TIME, startMillis) .putExtra(CalendarContract.EXTRA_EVENT_END_TIME, endMillis) .putExtra(CalendarContract.Events.TITLE, "Yoga") .putExtra(CalendarContract.Events.DESCRIPTION, "Group class") .putExtra(CalendarContract.Events.EVENT_LOCATION, "The gym") .putExtra(CalendarContract.Events.AVAILABILITY, CalendarContract.Events.AVAILABILITY_BUSY) .putExtra(Intent.EXTRA_EMAIL, "rowan@example.com,trevor@example.com") startActivity(intent)
Java
Calendar beginTime = Calendar.getInstance(); beginTime.set(2012, 0, 19, 7, 30); Calendar endTime = Calendar.getInstance(); endTime.set(2012, 0, 19, 8, 30); Intent intent = new Intent(Intent.ACTION_INSERT) .setData(Events.CONTENT_URI) .putExtra(CalendarContract.EXTRA_EVENT_BEGIN_TIME, beginTime.getTimeInMillis()) .putExtra(CalendarContract.EXTRA_EVENT_END_TIME, endTime.getTimeInMillis()) .putExtra(Events.TITLE, "Yoga") .putExtra(Events.DESCRIPTION, "Group class") .putExtra(Events.EVENT_LOCATION, "The gym") .putExtra(Events.AVAILABILITY, Events.AVAILABILITY_BUSY) .putExtra(Intent.EXTRA_EMAIL, "rowan@example.com,trevor@example.com"); startActivity(intent);
使用 intent 编辑事件
您可以直接更新事件,如更新事件中所述。但使用 EDIT
Intent 允许没有权限的应用将事件编辑交给日历应用。当用户在日历中完成事件编辑后,他们会被返回到原始应用。
这是一个 intent 示例,它为指定的事件设置新标题,并允许用户在日历中编辑事件。
Kotlin
val eventID: Long = 208 val uri: Uri = ContentUris.withAppendedId(CalendarContract.Events.CONTENT_URI, eventID) val intent = Intent(Intent.ACTION_EDIT) .setData(uri) .putExtra(CalendarContract.Events.TITLE, "My New Title") startActivity(intent)
Java
long eventID = 208; Uri uri = ContentUris.withAppendedId(Events.CONTENT_URI, eventID); Intent intent = new Intent(Intent.ACTION_EDIT) .setData(uri) .putExtra(Events.TITLE, "My New Title"); startActivity(intent);
使用 intent 查看日历数据
日历提供程序提供两种不同的方式使用 VIEW
Intent
- 打开日历到特定日期。
- 查看事件。
这是一个示例,展示如何打开日历到特定日期
Kotlin
val startMillis: Long ... val builder: Uri.Builder = CalendarContract.CONTENT_URI.buildUpon() .appendPath("time") ContentUris.appendId(builder, startMillis) val intent = Intent(Intent.ACTION_VIEW) .setData(builder.build()) startActivity(intent)
Java
// A date-time specified in milliseconds since the epoch. long startMillis; ... Uri.Builder builder = CalendarContract.CONTENT_URI.buildUpon(); builder.appendPath("time"); ContentUris.appendId(builder, startMillis); Intent intent = new Intent(Intent.ACTION_VIEW) .setData(builder.build()); startActivity(intent);
这是一个示例,展示如何打开事件进行查看
Kotlin
val eventID: Long = 208 ... val uri: Uri = ContentUris.withAppendedId(CalendarContract.Events.CONTENT_URI, eventID) val intent = Intent(Intent.ACTION_VIEW).setData(uri) startActivity(intent)
Java
long eventID = 208; ... Uri uri = ContentUris.withAppendedId(Events.CONTENT_URI, eventID); Intent intent = new Intent(Intent.ACTION_VIEW) .setData(uri); startActivity(intent);
同步适配器
应用和同步适配器访问日历提供程序的方式只有细微的差异
- 同步适配器需要通过将
CALLER_IS_SYNCADAPTER
设置为true
来指定它是一个同步适配器。 - 同步适配器需要在 URI 中提供
ACCOUNT_NAME
和ACCOUNT_TYPE
作为查询参数。 - 与应用或微件相比,同步适配器对更多列具有写入权限。例如,应用只能修改日历的一些特征,例如其名称、显示名称、可见性设置以及日历是否已同步。相比之下,同步适配器不仅可以访问这些列,还可以访问许多其他列,例如日历颜色、时区、访问级别、位置等。但是,同步适配器仅限于其指定的
ACCOUNT_NAME
和ACCOUNT_TYPE
。
这是一个辅助方法,您可以使用它返回用于同步适配器的 URI
Kotlin
fun asSyncAdapter(uri: Uri, account: String, accountType: String): Uri { return uri.buildUpon() .appendQueryParameter(CalendarContract.CALLER_IS_SYNCADAPTER, "true") .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_NAME, account) .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_TYPE, accountType).build() }
Java
static Uri asSyncAdapter(Uri uri, String account, String accountType) { return uri.buildUpon() .appendQueryParameter(android.provider.CalendarContract.CALLER_IS_SYNCADAPTER,"true") .appendQueryParameter(Calendars.ACCOUNT_NAME, account) .appendQueryParameter(Calendars.ACCOUNT_TYPE, accountType).build(); }