Android向系统日历中添加日程事件

Posted 2022-11-22 Vigibord

总结

在项目开发中，我们有预约提醒、定时提醒需求时，可以使用系统日历来辅助提醒；
通过向系统日历中写入事件、设置提醒方式（闹钟），实现到时间自动提醒的功能；

好处：由于提醒功能是交付给系统日历来做，不会出现应用被杀情况，会准时提醒；
坏处：系统日历在提醒时，不能直接再跳转回我们自己的app，只有在提醒文案中加入url，通过调用浏览器来中转；

一般来说实现向系统日历中读写事件：
1.需要有读写日历权限
2.如果没有日历账户需要先创建账户
3.实现日历事件增删改查、提醒功能

申请权限

为了实现在项目中调用系统日历和插入日程事件，我们首先在androidManifest.xml文件中添加相关权限，如下：

<uses-permission android:name="android.permission.READ_CALENDAR" />
<uses-permission android:name="android.permission.WRITE_CALENDAR" />

添加日历相关的uri

系统calendar content provider相关的uri，以下为Android2.2版本以后的uri，之前的就不写了

private static String CALANDER_URL = "content://com.android.calendar/calendars";
private static String CALANDER_EVENT_URL = "content://com.android.calendar/events";
private static String CALANDER_REMIDER_URL = "content://com.android.calendar/reminders";

检查并添加日历账户

1.检查是否有现有存在的账户。存在则返回账户id，否则返回-1

private static int checkCalendarAccount(Context context) 
        Cursor userCursor = context.getContentResolver().query(Uri.parse(CALANDER_URL), null, null, null, null);
        try 
            if (userCursor == null)//查询返回空值
                return -1;
            int count = userCursor.getCount();
            if (count > 0) //存在现有账户，取第一个账户的id返回
                userCursor.moveToFirst();
                return userCursor.getInt(userCursor.getColumnIndex(CalendarContract.Calendars._ID));
             else 
                return -1;
            
         finally 
            if (userCursor != null) 
                userCursor.close();
            
        

2.添加账户。账户创建成功则返回账户id，否则返回-1

private static String CALENDARS_NAME = "test";
private static String CALENDARS_ACCOUNT_NAME = "[e-mail]";
private static String CALENDARS_ACCOUNT_TYPE = "com.android.exchange";
private static String CALENDARS_DISPLAY_NAME = "测试账户";

private static long addCalendarAccount(Context context) 
        TimeZone timeZone = TimeZone.getDefault();
        ContentValues value = new ContentValues();
        value.put(CalendarContract.Calendars.NAME, CALENDARS_NAME);

        value.put(CalendarContract.Calendars.ACCOUNT_NAME, CALENDARS_ACCOUNT_NAME);
        value.put(CalendarContract.Calendars.ACCOUNT_TYPE, CALENDARS_ACCOUNT_TYPE);
        value.put(CalendarContract.Calendars.CALENDAR_DISPLAY_NAME, CALENDARS_DISPLAY_NAME);
        value.put(CalendarContract.Calendars.VISIBLE, 1);
        value.put(CalendarContract.Calendars.CALENDAR_COLOR, Color.BLUE);
        value.put(CalendarContract.Calendars.CALENDAR_ACCESS_LEVEL, CalendarContract.Calendars.CAL_ACCESS_OWNER);
        value.put(CalendarContract.Calendars.SYNC_EVENTS, 1);
        value.put(CalendarContract.Calendars.CALENDAR_TIME_ZONE, timeZone.getID());
        value.put(CalendarContract.Calendars.OWNER_ACCOUNT, CALENDARS_ACCOUNT_NAME);
        value.put(CalendarContract.Calendars.CAN_ORGANIZER_RESPOND, 0);

        Uri calendarUri = Uri.parse(CALANDER_URL);
        calendarUri = calendarUri.buildUpon()
                .appendQueryParameter(CalendarContract.CALLER_IS_SYNCADAPTER, "true")
                .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_NAME, CALENDARS_ACCOUNT_NAME)
                .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_TYPE, CALENDARS_ACCOUNT_TYPE)
                .build();

        Uri result = context.getContentResolver().insert(calendarUri, value);
        long id = result == null ? -1 : ContentUris.parseId(result);
        return id;
    

3.获取账户。如果账户不存在则先创建账户，账户存在获取账户id；获取账户成功返回账户id，否则返回-1

//检查是否已经添加了日历账户，如果没有添加先添加一个日历账户再查询
private static int checkAndAddCalendarAccount(Context context)
        int oldId = checkCalendarAccount(context);
        if( oldId >= 0 )
            return oldId;
        else
            long addId = addCalendarAccount(context);
            if (addId >= 0) 
                return checkCalendarAccount(context);
             else 
                return -1;
            
        

添加日历事件、日程

public static void addCalendarEvent(Context context,String title, String description, long beginTime)
        // 获取日历账户的id
        int calId = checkAndAddCalendarAccount(context);
        if (calId < 0) 
            // 获取账户id失败直接返回，添加日历事件失败
            return;
        

        ContentValues event = new ContentValues();
        event.put("title", title);
        event.put("description", description);
        // 插入账户的id
        event.put("calendar_id", calId);

        Calendar mCalendar = Calendar.getInstance();
        mCalendar.setTimeInMillis(beginTime);//设置开始时间
        long start = mCalendar.getTime().getTime();
        mCalendar.setTimeInMillis(start + ONE_HOUR);//设置终止时间
        long end = mCalendar.getTime().getTime();

        event.put(CalendarContract.Events.DTSTART, start);
        event.put(CalendarContract.Events.DTEND, end);
        event.put(CalendarContract.Events.HAS_ALARM, 1);//设置有闹钟提醒
        event.put(CalendarContract.Events.EVENT_TIMEZONE, "Asia/Shanghai");  //这个是时区，必须有，
        //添加事件
        Uri newEvent = context.getContentResolver().insert(Uri.parse(CALANDER_EVENT_URL), event);
        if (newEvent == null) 
            // 添加日历事件失败直接返回
            return;
        
        //事件提醒的设定
        ContentValues values = new ContentValues();
        values.put(CalendarContract.Reminders.EVENT_ID, ContentUris.parseId(newEvent));
        // 提前10分钟有提醒
        values.put(CalendarContract.Reminders.MINUTES, 10);
        values.put(CalendarContract.Reminders.METHOD, CalendarContract.Reminders.METHOD_ALERT);
        Uri uri = context.getContentResolver().insert(Uri.parse(CALANDER_REMIDER_URL), values);
        if(uri == null) 
            // 添加闹钟提醒失败直接返回
            return;
        

删除日历事件、日程

根据设置的title来查找并删除

public static void deleteCalendarEvent(Context context,String title)
        Cursor eventCursor = context.getContentResolver().query(Uri.parse(CALANDER_EVENT_URL), null, null, null, null);
        try 
            if (eventCursor == null)//查询返回空值
                return;
            if (eventCursor.getCount() > 0) 
                //遍历所有事件，找到title跟需要查询的title一样的项
                for (eventCursor.moveToFirst(); !eventCursor.isAfterLast(); eventCursor.moveToNext()) 
                    String eventTitle = eventCursor.getString(eventCursor.getColumnIndex("title"));
                    if (!TextUtils.isEmpty(title) && title.equals(eventTitle)) 
                        int id = eventCursor.getInt(eventCursor.getColumnIndex(CalendarContract.Calendars._ID));//取得id
                        Uri deleteUri = ContentUris.withAppendedId(Uri.parse(CALANDER_EVENT_URL), id);
                        int rows = context.getContentResolver().delete(deleteUri, null, null);
                        if (rows == -1) 
                            //事件删除失败
                            return;
                        
                    
                
            
         finally 
            if (eventCursor != null) 
                eventCursor.close();
            
        
    

至此，我们就能向系统日历中 查找、添加账户，添加、删除、更新日程事件，添加提醒方式，来实现提醒用户的需求。
再次说明一点，当系统日历弹出提醒的时候并不能直接跳转回自己的app，需要在设置description字段的文本中添加一个html，用户点击html时调用浏览器，由页面中转回自己得app。