##总结
在项目开发中,我们有预约提醒、定时提醒需求时,可以使用系统日历来辅助提醒;
通过向系统日历中写入事件、设置提醒方式(闹钟),实现到时间自动提醒的功能;
好处:由于提醒功能是交付给系统日历来做,不会出现应用被杀情况,会准时提醒;
坏处:系统日历在提醒时,不能直接再跳转回我们自己的app,只有在提醒文案中加入url,通过调用浏览器来中转;
一般来说实现向系统日历中读写事件:
- 1.需要有读写日历权限
- 2.如果没有日历账户需要先创建账户
- 3.实现日历事件增删改查、提醒功能
###申请权限
为了实现在项目中调用系统日历和插入日程事件,我们首先在AndroidManifest.xml文件中添加相关权限,如下:
1<uses-permission android:name="android.permission.READ_CALENDAR" /> 2<uses-permission android:name="android.permission.WRITE_CALENDAR" />
###添加日历相关的uri
系统calendar content provider相关的uri,以下为Android2.2版本以后的uri,之前的就不写了
1private static String CALANDER_URL = "content://com.android.calendar/calendars"; 2private static String CALANDER_EVENT_URL = "content://com.android.calendar/events"; 3private static String CALANDER_REMIDER_URL = "content://com.android.calendar/reminders";
###检查并添加日历账户
1.检查是否有现有存在的账户。存在则返回账户id,否则返回-1
1private static int checkCalendarAccount(Context context) { 2 Cursor userCursor = context.getContentResolver().query(Uri.parse(CALANDER_URL), null, null, null, null); 3 try { 4 if (userCursor == null)//查询返回空值 5 return -1; 6 int count = userCursor.getCount(); 7 if (count > 0) {//存在现有账户,取第一个账户的id返回 8 userCursor.moveToFirst(); 9 return userCursor.getInt(userCursor.getColumnIndex(CalendarContract.Calendars._ID)); 10 } else { 11 return -1; 12 } 13 } finally { 14 if (userCursor != null) { 15 userCursor.close(); 16 } 17 } 18}
2.添加账户。账户创建成功则返回账户id,否则返回-1
1private static String CALENDARS_NAME = "test"; 2private static String CALENDARS_ACCOUNT_NAME = "test@gmail.com"; 3private static String CALENDARS_ACCOUNT_TYPE = "com.android.exchange"; 4private static String CALENDARS_DISPLAY_NAME = "测试账户"; 5 6private static long addCalendarAccount(Context context) { 7 TimeZone timeZone = TimeZone.getDefault(); 8 ContentValues value = new ContentValues(); 9 value.put(CalendarContract.Calendars.NAME, CALENDARS_NAME); 10 11 value.put(CalendarContract.Calendars.ACCOUNT_NAME, CALENDARS_ACCOUNT_NAME); 12 value.put(CalendarContract.Calendars.ACCOUNT_TYPE, CALENDARS_ACCOUNT_TYPE); 13 value.put(CalendarContract.Calendars.CALENDAR_DISPLAY_NAME, CALENDARS_DISPLAY_NAME); 14 value.put(CalendarContract.Calendars.VISIBLE, 1); 15 value.put(CalendarContract.Calendars.CALENDAR_COLOR, Color.BLUE); 16 value.put(CalendarContract.Calendars.CALENDAR_ACCESS_LEVEL, CalendarContract.Calendars.CAL_ACCESS_OWNER); 17 value.put(CalendarContract.Calendars.SYNC_EVENTS, 1); 18 value.put(CalendarContract.Calendars.CALENDAR_TIME_ZONE, timeZone.getID()); 19 value.put(CalendarContract.Calendars.OWNER_ACCOUNT, CALENDARS_ACCOUNT_NAME); 20 value.put(CalendarContract.Calendars.CAN_ORGANIZER_RESPOND, 0); 21 22 Uri calendarUri = Uri.parse(CALANDER_URL); 23 calendarUri = calendarUri.buildUpon() 24 .appendQueryParameter(CalendarContract.CALLER_IS_SYNCADAPTER, "true") 25 .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_NAME, CALENDARS_ACCOUNT_NAME) 26 .appendQueryParameter(CalendarContract.Calendars.ACCOUNT_TYPE, CALENDARS_ACCOUNT_TYPE) 27 .build(); 28 29 Uri result = context.getContentResolver().insert(calendarUri, value); 30 long id = result == null ? -1 : ContentUris.parseId(result); 31 return id; 32 }
3.获取账户。如果账户不存在则先创建账户,账户存在获取账户id;获取账户成功返回账户id,否则返回-1
1//检查是否已经添加了日历账户,如果没有添加先添加一个日历账户再查询 2private static int checkAndAddCalendarAccount(Context context){ 3 int oldId = checkCalendarAccount(context); 4 if( oldId >= 0 ){ 5 return oldId; 6 }else{ 7 long addId = addCalendarAccount(context); 8 if (addId >= 0) { 9 return checkCalendarAccount(context); 10 } else { 11 return -1; 12 } 13 } 14}
###添加日历事件、日程
1public static void addCalendarEvent(Context context,String title, String description, long beginTime){ 2 // 获取日历账户的id 3 int calId = checkAndAddCalendarAccount(context); 4 if (calId < 0) { 5 // 获取账户id失败直接返回,添加日历事件失败 6 return; 7 } 8 9 ContentValues event = new ContentValues(); 10 event.put("title", title); 11 event.put("description", description); 12 // 插入账户的id 13 event.put("calendar_id", calId); 14 15 Calendar mCalendar = Calendar.getInstance(); 16 mCalendar.setTimeInMillis(beginTime);//设置开始时间 17 long start = mCalendar.getTime().getTime(); 18 mCalendar.setTimeInMillis(start + ONE_HOUR);//设置终止时间 19 long end = mCalendar.getTime().getTime(); 20 21 event.put(CalendarContract.Events.DTSTART, start); 22 event.put(CalendarContract.Events.DTEND, end); 23 event.put(CalendarContract.Events.HAS_ALARM, 1);//设置有闹钟提醒 24 event.put(CalendarContract.Events.EVENT_TIMEZONE, "Asia/Shanghai"); //这个是时区,必须有, 25 //添加事件 26 Uri newEvent = context.getContentResolver().insert(Uri.parse(CALANDER_EVENT_URL), event); 27 if (newEvent == null) { 28 // 添加日历事件失败直接返回 29 return; 30 } 31 //事件提醒的设定 32 ContentValues values = new ContentValues(); 33 values.put(CalendarContract.Reminders.EVENT_ID, ContentUris.parseId(newEvent)); 34 // 提前10分钟有提醒 35 values.put(CalendarContract.Reminders.MINUTES, 10); 36 values.put(CalendarContract.Reminders.METHOD, CalendarContract.Reminders.METHOD_ALERT); 37 Uri uri = context.getContentResolver().insert(Uri.parse(CALANDER_REMIDER_URL), values); 38 if(uri == null) { 39 // 添加闹钟提醒失败直接返回 40 return; 41 } 42}
###删除日历事件、日程
根据设置的title来查找并删除
1public static void deleteCalendarEvent(Context context,String title){ 2 Cursor eventCursor = context.getContentResolver().query(Uri.parse(CALANDER_EVENT_URL), null, null, null, null); 3 try { 4 if (eventCursor == null)//查询返回空值 5 return; 6 if (eventCursor.getCount() > 0) { 7 //遍历所有事件,找到title跟需要查询的title一样的项 8 for (eventCursor.moveToFirst(); !eventCursor.isAfterLast(); eventCursor.moveToNext()) { 9 String eventTitle = eventCursor.getString(eventCursor.getColumnIndex("title")); 10 if (!TextUtils.isEmpty(title) && title.equals(eventTitle)) { 11 int id = eventCursor.getInt(eventCursor.getColumnIndex(CalendarContract.Calendars._ID));//取得id 12 Uri deleteUri = ContentUris.withAppendedId(Uri.parse(CALANDER_EVENT_URL), id); 13 int rows = context.getContentResolver().delete(deleteUri, null, null); 14 if (rows == -1) { 15 //事件删除失败 16 return; 17 } 18 } 19 } 20 } 21 } finally { 22 if (eventCursor != null) { 23 eventCursor.close(); 24 } 25 } 26 }
至此,我们就能向系统日历中 查找、添加账户,添加、删除、更新日程事件,添加提醒方式,来实现提醒用户的需求。
再次说明一点,当系统日历弹出提醒的时候并不能直接跳转回自己的app,需要在设置description字段的文本中添加一个html,用户点击html时调用浏览器,由页面中转回自己得app。