CalendarContract.java revision 0114112203ec55e10c209fded7495a6b70a3e468
1/* 2 * Copyright (C) 2006 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17package android.provider; 18 19 20import android.annotation.SdkConstant; 21import android.annotation.SdkConstant.SdkConstantType; 22import android.app.Activity; 23import android.app.AlarmManager; 24import android.app.PendingIntent; 25import android.content.ContentProviderClient; 26import android.content.ContentResolver; 27import android.content.ContentUris; 28import android.content.ContentValues; 29import android.content.Context; 30import android.content.CursorEntityIterator; 31import android.content.Entity; 32import android.content.EntityIterator; 33import android.content.Intent; 34import android.database.Cursor; 35import android.database.DatabaseUtils; 36import android.net.Uri; 37import android.os.RemoteException; 38import android.text.format.DateUtils; 39import android.text.format.Time; 40import android.util.Log; 41 42/** 43 * <p> 44 * The contract between the calendar provider and applications. Contains 45 * definitions for the supported URIs and data columns. 46 * </p> 47 * <h3>Overview</h3> 48 * <p> 49 * CalendarContract defines the data model of calendar and event related 50 * information. This data is stored in a number of tables: 51 * </p> 52 * <ul> 53 * <li>The {@link Calendars} table holds the calendar specific information. Each 54 * row in this table contains the details for a single calendar, such as the 55 * name, color, sync info, etc.</li> 56 * <li>The {@link Events} table holds the event specific information. Each row 57 * in this table has the info for a single event. It contains information such 58 * as event title, location, start time, end time, etc. The event can occur 59 * one-time or can recur multiple times. Attendees, reminders, and extended 60 * properties are stored on separate tables and reference the {@link Events#_ID} 61 * to link them with the event.</li> 62 * <li>The {@link Instances} table holds the start and end time for occurrences 63 * of an event. Each row in this table represents a single occurrence. For 64 * one-time events there will be a 1:1 mapping of instances to events. For 65 * recurring events, multiple rows will automatically be generated which 66 * correspond to multiple occurrences of that event.</li> 67 * <li>The {@link Attendees} table holds the event attendee or guest 68 * information. Each row represents a single guest of an event. It specifies the 69 * type of guest they are and their attendance response for the event.</li> 70 * <li>The {@link Reminders} table holds the alert/notification data. Each row 71 * represents a single alert for an event. An event can have multiple reminders. 72 * The number of reminders per event is specified in 73 * {@link Calendars#MAX_REMINDERS} which is set by the Sync Adapter that owns 74 * the given calendar. Reminders are specified in minutes before the event and 75 * have a type.</li> 76 * <li>The {@link ExtendedProperties} table holds opaque data fields used by the 77 * sync adapter. The provider takes no action with items in this table except to 78 * delete them when their related events are deleted.</li> 79 * </ul> 80 * <p> 81 * Other tables include: 82 * </p> 83 * <ul> 84 * <li> 85 * {@link SyncState}, which contains free-form data maintained by the sync 86 * adapters</li> 87 * </ul> 88 * 89 */ 90public final class CalendarContract { 91 private static final String TAG = "Calendar"; 92 93 /** 94 * Broadcast Action: This is the intent that gets fired when an alarm 95 * notification needs to be posted for a reminder. 96 * 97 */ 98 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 99 public static final String ACTION_EVENT_REMINDER = "android.intent.action.EVENT_REMINDER"; 100 101 /** 102 * Activity Action: Display the event to the user in the custom app as 103 * specified in {@link EventsColumns#CUSTOM_APP_PACKAGE}. The custom app 104 * will be started via {@link Activity#startActivityForResult(Intent, int)} 105 * and it should call {@link Activity#setResult(int)} with 106 * {@link Activity#RESULT_OK} or {@link Activity#RESULT_CANCELED} to 107 * acknowledge whether the action was handled or not. 108 * 109 * The custom app should have an intent-filter like the following 110 * <pre> 111 * {@code 112 * <intent-filter> 113 * <action android:name="android.provider.calendar.action.HANDLE_CUSTOM_EVENT" /> 114 * <category android:name="android.intent.category.DEFAULT" /> 115 * <data android:mimeType="vnd.android.cursor.item/event" /> 116 * </intent-filter> 117 * } 118 * </pre> 119 * <p> 120 * Input: {@link Intent#getData} has the event URI. The extra 121 * {@link #EXTRA_EVENT_BEGIN_TIME} has the start time of the instance. The 122 * extra {@link #EXTRA_CUSTOM_APP_URI} will have the 123 * {@link EventsColumns#CUSTOM_APP_URI}. 124 * <p> 125 * Output: {@link Activity#RESULT_OK} if this was handled; otherwise 126 * {@link Activity#RESULT_CANCELED} 127 */ 128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION) 129 public static final String ACTION_HANDLE_CUSTOM_EVENT = 130 "android.provider.calendar.action.HANDLE_CUSTOM_EVENT"; 131 132 /** 133 * Intent Extras key: {@link EventsColumns#CUSTOM_APP_URI} for the event in 134 * the {@link #ACTION_HANDLE_CUSTOM_EVENT} intent 135 */ 136 public static final String EXTRA_CUSTOM_APP_URI = "customAppUri"; 137 138 /** 139 * Intent Extras key: The start time of an event or an instance of a 140 * recurring event. (milliseconds since epoch) 141 */ 142 public static final String EXTRA_EVENT_BEGIN_TIME = "beginTime"; 143 144 /** 145 * Intent Extras key: The end time of an event or an instance of a recurring 146 * event. (milliseconds since epoch) 147 */ 148 public static final String EXTRA_EVENT_END_TIME = "endTime"; 149 150 /** 151 * Intent Extras key: When creating an event, set this to true to create an 152 * all-day event by default 153 */ 154 public static final String EXTRA_EVENT_ALL_DAY = "allDay"; 155 156 /** 157 * This authority is used for writing to or querying from the calendar 158 * provider. Note: This is set at first run and cannot be changed without 159 * breaking apps that access the provider. 160 */ 161 public static final String AUTHORITY = "com.android.calendar"; 162 163 /** 164 * The content:// style URL for the top-level calendar authority 165 */ 166 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY); 167 168 /** 169 * An optional insert, update or delete URI parameter that allows the caller 170 * to specify that it is a sync adapter. The default value is false. If set 171 * to true, the modified row is not marked as "dirty" (needs to be synced) 172 * and when the provider calls 173 * {@link ContentResolver#notifyChange(android.net.Uri, android.database.ContentObserver, boolean)} 174 * , the third parameter "syncToNetwork" is set to false. Furthermore, if 175 * set to true, the caller must also include 176 * {@link Calendars#ACCOUNT_NAME} and {@link Calendars#ACCOUNT_TYPE} as 177 * query parameters. 178 * 179 * @see Uri.Builder#appendQueryParameter(java.lang.String, java.lang.String) 180 */ 181 public static final String CALLER_IS_SYNCADAPTER = "caller_is_syncadapter"; 182 183 /** 184 * A special account type for calendars not associated with any account. 185 * Normally calendars that do not match an account on the device will be 186 * removed. Setting the account_type on a calendar to this will prevent it 187 * from being wiped if it does not match an existing account. 188 * 189 * @see SyncColumns#ACCOUNT_TYPE 190 */ 191 public static final String ACCOUNT_TYPE_LOCAL = "LOCAL"; 192 193 /** 194 * This utility class cannot be instantiated 195 */ 196 private CalendarContract() {} 197 198 /** 199 * Generic columns for use by sync adapters. The specific functions of these 200 * columns are private to the sync adapter. Other clients of the API should 201 * not attempt to either read or write this column. These columns are 202 * editable as part of the Calendars Uri, but can only be read if accessed 203 * through any other Uri. 204 */ 205 protected interface CalendarSyncColumns { 206 207 208 /** 209 * Generic column for use by sync adapters. Column name. 210 * <P>Type: TEXT</P> 211 */ 212 public static final String CAL_SYNC1 = "cal_sync1"; 213 214 /** 215 * Generic column for use by sync adapters. Column name. 216 * <P>Type: TEXT</P> 217 */ 218 public static final String CAL_SYNC2 = "cal_sync2"; 219 220 /** 221 * Generic column for use by sync adapters. Column name. 222 * <P>Type: TEXT</P> 223 */ 224 public static final String CAL_SYNC3 = "cal_sync3"; 225 226 /** 227 * Generic column for use by sync adapters. Column name. 228 * <P>Type: TEXT</P> 229 */ 230 public static final String CAL_SYNC4 = "cal_sync4"; 231 232 /** 233 * Generic column for use by sync adapters. Column name. 234 * <P>Type: TEXT</P> 235 */ 236 public static final String CAL_SYNC5 = "cal_sync5"; 237 238 /** 239 * Generic column for use by sync adapters. Column name. 240 * <P>Type: TEXT</P> 241 */ 242 public static final String CAL_SYNC6 = "cal_sync6"; 243 244 /** 245 * Generic column for use by sync adapters. Column name. 246 * <P>Type: TEXT</P> 247 */ 248 public static final String CAL_SYNC7 = "cal_sync7"; 249 250 /** 251 * Generic column for use by sync adapters. Column name. 252 * <P>Type: TEXT</P> 253 */ 254 public static final String CAL_SYNC8 = "cal_sync8"; 255 256 /** 257 * Generic column for use by sync adapters. Column name. 258 * <P>Type: TEXT</P> 259 */ 260 public static final String CAL_SYNC9 = "cal_sync9"; 261 262 /** 263 * Generic column for use by sync adapters. Column name. 264 * <P>Type: TEXT</P> 265 */ 266 public static final String CAL_SYNC10 = "cal_sync10"; 267 } 268 269 /** 270 * Columns for Sync information used by Calendars and Events tables. These 271 * have specific uses which are expected to be consistent by the app and 272 * sync adapter. 273 * 274 */ 275 protected interface SyncColumns extends CalendarSyncColumns { 276 /** 277 * The account that was used to sync the entry to the device. If the 278 * account_type is not {@link #ACCOUNT_TYPE_LOCAL} then the name and 279 * type must match an account on the device or the calendar will be 280 * deleted. 281 * <P>Type: TEXT</P> 282 */ 283 public static final String ACCOUNT_NAME = "account_name"; 284 285 /** 286 * The type of the account that was used to sync the entry to the 287 * device. A type of {@link #ACCOUNT_TYPE_LOCAL} will keep this event 288 * form being deleted if there are no matching accounts on the device. 289 * <P>Type: TEXT</P> 290 */ 291 public static final String ACCOUNT_TYPE = "account_type"; 292 293 /** 294 * The unique ID for a row assigned by the sync source. NULL if the row 295 * has never been synced. This is used as a reference id for exceptions 296 * along with {@link BaseColumns#_ID}. 297 * <P>Type: TEXT</P> 298 */ 299 public static final String _SYNC_ID = "_sync_id"; 300 301 /** 302 * Used to indicate that local, unsynced, changes are present. 303 * <P>Type: INTEGER (long)</P> 304 */ 305 306 public static final String DIRTY = "dirty"; 307 308 /** 309 * Used in conjunction with {@link #DIRTY} to indicate what packages wrote local changes. 310 * <P>Type: TEXT</P> 311 */ 312 public static final String MUTATORS = "mutators"; 313 314 /** 315 * Whether the row has been deleted but not synced to the server. A 316 * deleted row should be ignored. 317 * <P> 318 * Type: INTEGER (boolean) 319 * </P> 320 */ 321 public static final String DELETED = "deleted"; 322 323 /** 324 * If set to 1 this causes events on this calendar to be duplicated with 325 * {@link Events#LAST_SYNCED} set to 1 whenever the event 326 * transitions from non-dirty to dirty. The duplicated event will not be 327 * expanded in the instances table and will only show up in sync adapter 328 * queries of the events table. It will also be deleted when the 329 * originating event has its dirty flag cleared by the sync adapter. 330 * <P>Type: INTEGER (boolean)</P> 331 */ 332 public static final String CAN_PARTIALLY_UPDATE = "canPartiallyUpdate"; 333 } 334 335 /** 336 * Columns specific to the Calendars Uri that other Uris can query. 337 */ 338 protected interface CalendarColumns { 339 /** 340 * The color of the calendar. This should only be updated by the sync 341 * adapter, not other apps, as changing a calendar's color can adversely 342 * affect its display. 343 * <P>Type: INTEGER (color value)</P> 344 */ 345 public static final String CALENDAR_COLOR = "calendar_color"; 346 347 /** 348 * A key for looking up a color from the {@link Colors} table. NULL or 349 * an empty string are reserved for indicating that the calendar does 350 * not use a key for looking up the color. The provider will update 351 * {@link #CALENDAR_COLOR} automatically when a valid key is written to 352 * this column. The key must reference an existing row of the 353 * {@link Colors} table. @see Colors 354 * <P> 355 * Type: TEXT 356 * </P> 357 */ 358 public static final String CALENDAR_COLOR_KEY = "calendar_color_index"; 359 360 /** 361 * The display name of the calendar. Column name. 362 * <P> 363 * Type: TEXT 364 * </P> 365 */ 366 public static final String CALENDAR_DISPLAY_NAME = "calendar_displayName"; 367 368 /** 369 * The level of access that the user has for the calendar 370 * <P>Type: INTEGER (one of the values below)</P> 371 */ 372 public static final String CALENDAR_ACCESS_LEVEL = "calendar_access_level"; 373 374 /** Cannot access the calendar */ 375 public static final int CAL_ACCESS_NONE = 0; 376 /** Can only see free/busy information about the calendar */ 377 public static final int CAL_ACCESS_FREEBUSY = 100; 378 /** Can read all event details */ 379 public static final int CAL_ACCESS_READ = 200; 380 /** Can reply yes/no/maybe to an event */ 381 public static final int CAL_ACCESS_RESPOND = 300; 382 /** not used */ 383 public static final int CAL_ACCESS_OVERRIDE = 400; 384 /** Full access to modify the calendar, but not the access control 385 * settings 386 */ 387 public static final int CAL_ACCESS_CONTRIBUTOR = 500; 388 /** Full access to modify the calendar, but not the access control 389 * settings 390 */ 391 public static final int CAL_ACCESS_EDITOR = 600; 392 /** Full access to the calendar */ 393 public static final int CAL_ACCESS_OWNER = 700; 394 /** Domain admin */ 395 public static final int CAL_ACCESS_ROOT = 800; 396 397 /** 398 * Is the calendar selected to be displayed? 399 * 0 - do not show events associated with this calendar. 400 * 1 - show events associated with this calendar 401 * <P>Type: INTEGER (boolean)</P> 402 */ 403 public static final String VISIBLE = "visible"; 404 405 /** 406 * The time zone the calendar is associated with. 407 * <P>Type: TEXT</P> 408 */ 409 public static final String CALENDAR_TIME_ZONE = "calendar_timezone"; 410 411 /** 412 * Is this calendar synced and are its events stored on the device? 413 * 0 - Do not sync this calendar or store events for this calendar. 414 * 1 - Sync down events for this calendar. 415 * <p>Type: INTEGER (boolean)</p> 416 */ 417 public static final String SYNC_EVENTS = "sync_events"; 418 419 /** 420 * The owner account for this calendar, based on the calendar feed. 421 * This will be different from the _SYNC_ACCOUNT for delegated calendars. 422 * Column name. 423 * <P>Type: String</P> 424 */ 425 public static final String OWNER_ACCOUNT = "ownerAccount"; 426 427 /** 428 * Can the organizer respond to the event? If no, the status of the 429 * organizer should not be shown by the UI. Defaults to 1. Column name. 430 * <P>Type: INTEGER (boolean)</P> 431 */ 432 public static final String CAN_ORGANIZER_RESPOND = "canOrganizerRespond"; 433 434 /** 435 * Can the organizer modify the time zone of the event? Column name. 436 * <P>Type: INTEGER (boolean)</P> 437 */ 438 public static final String CAN_MODIFY_TIME_ZONE = "canModifyTimeZone"; 439 440 /** 441 * The maximum number of reminders allowed for an event. Column name. 442 * <P>Type: INTEGER</P> 443 */ 444 public static final String MAX_REMINDERS = "maxReminders"; 445 446 /** 447 * A comma separated list of reminder methods supported for this 448 * calendar in the format "#,#,#". Valid types are 449 * {@link Reminders#METHOD_DEFAULT}, {@link Reminders#METHOD_ALERT}, 450 * {@link Reminders#METHOD_EMAIL}, {@link Reminders#METHOD_SMS}, 451 * {@link Reminders#METHOD_ALARM}. Column name. 452 * <P>Type: TEXT</P> 453 */ 454 public static final String ALLOWED_REMINDERS = "allowedReminders"; 455 456 /** 457 * A comma separated list of availability types supported for this 458 * calendar in the format "#,#,#". Valid types are 459 * {@link Events#AVAILABILITY_BUSY}, {@link Events#AVAILABILITY_FREE}, 460 * {@link Events#AVAILABILITY_TENTATIVE}. Setting this field to only 461 * {@link Events#AVAILABILITY_BUSY} should be used to indicate that 462 * changing the availability is not supported. 463 * 464 */ 465 public static final String ALLOWED_AVAILABILITY = "allowedAvailability"; 466 467 /** 468 * A comma separated list of attendee types supported for this calendar 469 * in the format "#,#,#". Valid types are {@link Attendees#TYPE_NONE}, 470 * {@link Attendees#TYPE_OPTIONAL}, {@link Attendees#TYPE_REQUIRED}, 471 * {@link Attendees#TYPE_RESOURCE}. Setting this field to only 472 * {@link Attendees#TYPE_NONE} should be used to indicate that changing 473 * the attendee type is not supported. 474 * 475 */ 476 public static final String ALLOWED_ATTENDEE_TYPES = "allowedAttendeeTypes"; 477 478 /** 479 * Is this the primary calendar for this account. If this column is not explicitly set, the 480 * provider will return 1 if {@link Calendars#ACCOUNT_NAME} is equal to 481 * {@link Calendars#OWNER_ACCOUNT}. 482 */ 483 public static final String IS_PRIMARY = "isPrimary"; 484 } 485 486 /** 487 * Class that represents a Calendar Entity. There is one entry per calendar. 488 * This is a helper class to make batch operations easier. 489 */ 490 public static final class CalendarEntity implements BaseColumns, SyncColumns, CalendarColumns { 491 492 /** 493 * The default Uri used when creating a new calendar EntityIterator. 494 */ 495 @SuppressWarnings("hiding") 496 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + 497 "/calendar_entities"); 498 499 /** 500 * This utility class cannot be instantiated 501 */ 502 private CalendarEntity() {} 503 504 /** 505 * Creates an entity iterator for the given cursor. It assumes the 506 * cursor contains a calendars query. 507 * 508 * @param cursor query on {@link #CONTENT_URI} 509 * @return an EntityIterator of calendars 510 */ 511 public static EntityIterator newEntityIterator(Cursor cursor) { 512 return new EntityIteratorImpl(cursor); 513 } 514 515 private static class EntityIteratorImpl extends CursorEntityIterator { 516 517 public EntityIteratorImpl(Cursor cursor) { 518 super(cursor); 519 } 520 521 @Override 522 public Entity getEntityAndIncrementCursor(Cursor cursor) throws RemoteException { 523 // we expect the cursor is already at the row we need to read from 524 final long calendarId = cursor.getLong(cursor.getColumnIndexOrThrow(_ID)); 525 526 // Create the content value 527 ContentValues cv = new ContentValues(); 528 cv.put(_ID, calendarId); 529 530 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ACCOUNT_NAME); 531 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ACCOUNT_TYPE); 532 533 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, _SYNC_ID); 534 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DIRTY); 535 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, MUTATORS); 536 537 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC1); 538 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC2); 539 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC3); 540 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC4); 541 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC5); 542 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC6); 543 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC7); 544 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC8); 545 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC9); 546 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC10); 547 548 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, Calendars.NAME); 549 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 550 Calendars.CALENDAR_DISPLAY_NAME); 551 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 552 Calendars.CALENDAR_COLOR); 553 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 554 Calendars.CALENDAR_COLOR_KEY); 555 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, CALENDAR_ACCESS_LEVEL); 556 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, VISIBLE); 557 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, SYNC_EVENTS); 558 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 559 Calendars.CALENDAR_LOCATION); 560 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CALENDAR_TIME_ZONE); 561 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 562 Calendars.OWNER_ACCOUNT); 563 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 564 Calendars.CAN_ORGANIZER_RESPOND); 565 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 566 Calendars.CAN_MODIFY_TIME_ZONE); 567 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 568 Calendars.MAX_REMINDERS); 569 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 570 Calendars.CAN_PARTIALLY_UPDATE); 571 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 572 Calendars.ALLOWED_REMINDERS); 573 574 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, DELETED); 575 576 // Create the Entity from the ContentValue 577 Entity entity = new Entity(cv); 578 579 // Set cursor to next row 580 cursor.moveToNext(); 581 582 // Return the created Entity 583 return entity; 584 } 585 } 586 } 587 588 /** 589 * Constants and helpers for the Calendars table, which contains details for 590 * individual calendars. <h3>Operations</h3> All operations can be done 591 * either as an app or as a sync adapter. To perform an operation as a sync 592 * adapter {@link #CALLER_IS_SYNCADAPTER} should be set to true and 593 * {@link #ACCOUNT_NAME} and {@link #ACCOUNT_TYPE} must be set in the Uri 594 * parameters. See 595 * {@link Uri.Builder#appendQueryParameter(java.lang.String, java.lang.String)} 596 * for details on adding parameters. Sync adapters have write access to more 597 * columns but are restricted to a single account at a time. Calendars are 598 * designed to be primarily managed by a sync adapter and inserting new 599 * calendars should be done as a sync adapter. For the most part, apps 600 * should only update calendars (such as changing the color or display 601 * name). If a local calendar is required an app can do so by inserting as a 602 * sync adapter and using an {@link #ACCOUNT_TYPE} of 603 * {@link #ACCOUNT_TYPE_LOCAL} . 604 * <dl> 605 * <dt><b>Insert</b></dt> 606 * <dd>When inserting a new calendar the following fields must be included: 607 * <ul> 608 * <li>{@link #ACCOUNT_NAME}</li> 609 * <li>{@link #ACCOUNT_TYPE}</li> 610 * <li>{@link #NAME}</li> 611 * <li>{@link #CALENDAR_DISPLAY_NAME}</li> 612 * <li>{@link #CALENDAR_COLOR}</li> 613 * <li>{@link #CALENDAR_ACCESS_LEVEL}</li> 614 * <li>{@link #OWNER_ACCOUNT}</li> 615 * </ul> 616 * The following fields are not required when inserting a Calendar but are 617 * generally a good idea to include: 618 * <ul> 619 * <li>{@link #SYNC_EVENTS} set to 1</li> 620 * <li>{@link #CALENDAR_TIME_ZONE}</li> 621 * <li>{@link #ALLOWED_REMINDERS}</li> 622 * <li>{@link #ALLOWED_AVAILABILITY}</li> 623 * <li>{@link #ALLOWED_ATTENDEE_TYPES}</li> 624 * </ul> 625 * <dt><b>Update</b></dt> 626 * <dd>To perform an update on a calendar the {@link #_ID} of the calendar 627 * should be provided either as an appended id to the Uri ( 628 * {@link ContentUris#withAppendedId}) or as the first selection item--the 629 * selection should start with "_id=?" and the first selectionArg should be 630 * the _id of the calendar. Calendars may also be updated using a selection 631 * without the id. In general, the {@link #ACCOUNT_NAME} and 632 * {@link #ACCOUNT_TYPE} should not be changed after a calendar is created 633 * as this can cause issues for sync adapters. 634 * <dt><b>Delete</b></dt> 635 * <dd>Calendars can be deleted either by the {@link #_ID} as an appended id 636 * on the Uri or using any standard selection. Deleting a calendar should 637 * generally be handled by a sync adapter as it will remove the calendar 638 * from the database and all associated data (aka events).</dd> 639 * <dt><b>Query</b></dt> 640 * <dd>Querying the Calendars table will get you all information about a set 641 * of calendars. There will be one row returned for each calendar that 642 * matches the query selection, or at most a single row if the {@link #_ID} 643 * is appended to the Uri.</dd> 644 * </dl> 645 * <h3>Calendar Columns</h3> The following Calendar columns are writable by 646 * both an app and a sync adapter. 647 * <ul> 648 * <li>{@link #NAME}</li> 649 * <li>{@link #CALENDAR_DISPLAY_NAME}</li> 650 * <li>{@link #VISIBLE}</li> 651 * <li>{@link #SYNC_EVENTS}</li> 652 * </ul> 653 * The following Calendars columns are writable only by a sync adapter 654 * <ul> 655 * <li>{@link #ACCOUNT_NAME}</li> 656 * <li>{@link #ACCOUNT_TYPE}</li> 657 * <li>{@link #CALENDAR_COLOR}</li> 658 * <li>{@link #_SYNC_ID}</li> 659 * <li>{@link #DIRTY}</li> 660 * <li>{@link #MUTATORS}</li> 661 * <li>{@link #OWNER_ACCOUNT}</li> 662 * <li>{@link #MAX_REMINDERS}</li> 663 * <li>{@link #ALLOWED_REMINDERS}</li> 664 * <li>{@link #ALLOWED_AVAILABILITY}</li> 665 * <li>{@link #ALLOWED_ATTENDEE_TYPES}</li> 666 * <li>{@link #CAN_MODIFY_TIME_ZONE}</li> 667 * <li>{@link #CAN_ORGANIZER_RESPOND}</li> 668 * <li>{@link #CAN_PARTIALLY_UPDATE}</li> 669 * <li>{@link #CALENDAR_LOCATION}</li> 670 * <li>{@link #CALENDAR_TIME_ZONE}</li> 671 * <li>{@link #CALENDAR_ACCESS_LEVEL}</li> 672 * <li>{@link #DELETED}</li> 673 * <li>{@link #CAL_SYNC1}</li> 674 * <li>{@link #CAL_SYNC2}</li> 675 * <li>{@link #CAL_SYNC3}</li> 676 * <li>{@link #CAL_SYNC4}</li> 677 * <li>{@link #CAL_SYNC5}</li> 678 * <li>{@link #CAL_SYNC6}</li> 679 * <li>{@link #CAL_SYNC7}</li> 680 * <li>{@link #CAL_SYNC8}</li> 681 * <li>{@link #CAL_SYNC9}</li> 682 * <li>{@link #CAL_SYNC10}</li> 683 * </ul> 684 */ 685 public static final class Calendars implements BaseColumns, SyncColumns, CalendarColumns { 686 687 /** 688 * This utility class cannot be instantiated 689 */ 690 private Calendars() {} 691 692 /** 693 * The content:// style URL for accessing Calendars 694 */ 695 @SuppressWarnings("hiding") 696 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/calendars"); 697 698 /** 699 * The default sort order for this table 700 */ 701 public static final String DEFAULT_SORT_ORDER = CALENDAR_DISPLAY_NAME; 702 703 /** 704 * The name of the calendar. Column name. 705 * <P>Type: TEXT</P> 706 */ 707 public static final String NAME = "name"; 708 709 /** 710 * The default location for the calendar. Column name. 711 * <P>Type: TEXT</P> 712 */ 713 public static final String CALENDAR_LOCATION = "calendar_location"; 714 715 /** 716 * These fields are only writable by a sync adapter. To modify them the 717 * caller must include {@link #CALLER_IS_SYNCADAPTER}, 718 * {@link #ACCOUNT_NAME}, and {@link #ACCOUNT_TYPE} in the Uri's query 719 * parameters. TODO move to provider 720 * 721 * @hide 722 */ 723 public static final String[] SYNC_WRITABLE_COLUMNS = new String[] { 724 ACCOUNT_NAME, 725 ACCOUNT_TYPE, 726 _SYNC_ID, 727 DIRTY, 728 MUTATORS, 729 OWNER_ACCOUNT, 730 MAX_REMINDERS, 731 ALLOWED_REMINDERS, 732 CAN_MODIFY_TIME_ZONE, 733 CAN_ORGANIZER_RESPOND, 734 CAN_PARTIALLY_UPDATE, 735 CALENDAR_LOCATION, 736 CALENDAR_TIME_ZONE, 737 CALENDAR_ACCESS_LEVEL, 738 DELETED, 739 CAL_SYNC1, 740 CAL_SYNC2, 741 CAL_SYNC3, 742 CAL_SYNC4, 743 CAL_SYNC5, 744 CAL_SYNC6, 745 CAL_SYNC7, 746 CAL_SYNC8, 747 CAL_SYNC9, 748 CAL_SYNC10, 749 }; 750 } 751 752 /** 753 * Columns from the Attendees table that other tables join into themselves. 754 */ 755 protected interface AttendeesColumns { 756 757 /** 758 * The id of the event. Column name. 759 * <P>Type: INTEGER</P> 760 */ 761 public static final String EVENT_ID = "event_id"; 762 763 /** 764 * The name of the attendee. Column name. 765 * <P>Type: STRING</P> 766 */ 767 public static final String ATTENDEE_NAME = "attendeeName"; 768 769 /** 770 * The email address of the attendee. Column name. 771 * <P>Type: STRING</P> 772 */ 773 public static final String ATTENDEE_EMAIL = "attendeeEmail"; 774 775 /** 776 * The relationship of the attendee to the user. Column name. 777 * <P>Type: INTEGER (one of {@link #RELATIONSHIP_ATTENDEE}, ...}.</P> 778 */ 779 public static final String ATTENDEE_RELATIONSHIP = "attendeeRelationship"; 780 781 public static final int RELATIONSHIP_NONE = 0; 782 public static final int RELATIONSHIP_ATTENDEE = 1; 783 public static final int RELATIONSHIP_ORGANIZER = 2; 784 public static final int RELATIONSHIP_PERFORMER = 3; 785 public static final int RELATIONSHIP_SPEAKER = 4; 786 787 /** 788 * The type of attendee. Column name. 789 * <P> 790 * Type: Integer (one of {@link #TYPE_NONE}, {@link #TYPE_REQUIRED}, 791 * {@link #TYPE_OPTIONAL}, {@link #TYPE_RESOURCE}) 792 * </P> 793 */ 794 public static final String ATTENDEE_TYPE = "attendeeType"; 795 796 public static final int TYPE_NONE = 0; 797 public static final int TYPE_REQUIRED = 1; 798 public static final int TYPE_OPTIONAL = 2; 799 /** 800 * This specifies that an attendee is a resource, like a room, a 801 * cabbage, or something and not an actual person. 802 */ 803 public static final int TYPE_RESOURCE = 3; 804 805 /** 806 * The attendance status of the attendee. Column name. 807 * <P>Type: Integer (one of {@link #ATTENDEE_STATUS_ACCEPTED}, ...).</P> 808 */ 809 public static final String ATTENDEE_STATUS = "attendeeStatus"; 810 811 public static final int ATTENDEE_STATUS_NONE = 0; 812 public static final int ATTENDEE_STATUS_ACCEPTED = 1; 813 public static final int ATTENDEE_STATUS_DECLINED = 2; 814 public static final int ATTENDEE_STATUS_INVITED = 3; 815 public static final int ATTENDEE_STATUS_TENTATIVE = 4; 816 817 /** 818 * The identity of the attendee as referenced in 819 * {@link ContactsContract.CommonDataKinds.Identity#IDENTITY}. 820 * This is required only if {@link #ATTENDEE_ID_NAMESPACE} is present. Column name. 821 * <P>Type: STRING</P> 822 */ 823 public static final String ATTENDEE_IDENTITY = "attendeeIdentity"; 824 825 /** 826 * The identity name space of the attendee as referenced in 827 * {@link ContactsContract.CommonDataKinds.Identity#NAMESPACE}. 828 * This is required only if {@link #ATTENDEE_IDENTITY} is present. Column name. 829 * <P>Type: STRING</P> 830 */ 831 public static final String ATTENDEE_ID_NAMESPACE = "attendeeIdNamespace"; 832 } 833 834 /** 835 * Fields and helpers for interacting with Attendees. Each row of this table 836 * represents a single attendee or guest of an event. Calling 837 * {@link #query(ContentResolver, long, String[])} will return a list of attendees for 838 * the event with the given eventId. Both apps and sync adapters may write 839 * to this table. There are six writable fields and all of them except 840 * {@link #ATTENDEE_NAME} must be included when inserting a new attendee. 841 * They are: 842 * <ul> 843 * <li>{@link #EVENT_ID}</li> 844 * <li>{@link #ATTENDEE_NAME}</li> 845 * <li>{@link #ATTENDEE_EMAIL}</li> 846 * <li>{@link #ATTENDEE_RELATIONSHIP}</li> 847 * <li>{@link #ATTENDEE_TYPE}</li> 848 * <li>{@link #ATTENDEE_STATUS}</li> 849 * <li>{@link #ATTENDEE_IDENTITY}</li> 850 * <li>{@link #ATTENDEE_ID_NAMESPACE}</li> 851 * </ul> 852 */ 853 public static final class Attendees implements BaseColumns, AttendeesColumns, EventsColumns { 854 855 /** 856 * The content:// style URL for accessing Attendees data 857 */ 858 @SuppressWarnings("hiding") 859 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/attendees"); 860 private static final String ATTENDEES_WHERE = Attendees.EVENT_ID + "=?"; 861 862 /** 863 * This utility class cannot be instantiated 864 */ 865 private Attendees() {} 866 867 /** 868 * Queries all attendees associated with the given event. This is a 869 * blocking call and should not be done on the UI thread. 870 * 871 * @param cr The content resolver to use for the query 872 * @param eventId The id of the event to retrieve attendees for 873 * @param projection the columns to return in the cursor 874 * @return A Cursor containing all attendees for the event 875 */ 876 public static final Cursor query(ContentResolver cr, long eventId, String[] projection) { 877 String[] attArgs = {Long.toString(eventId)}; 878 return cr.query(CONTENT_URI, projection, ATTENDEES_WHERE, attArgs /* selection args */, 879 null /* sort order */); 880 } 881 } 882 883 /** 884 * Columns from the Events table that other tables join into themselves. 885 */ 886 protected interface EventsColumns { 887 888 /** 889 * The {@link Calendars#_ID} of the calendar the event belongs to. 890 * Column name. 891 * <P>Type: INTEGER</P> 892 */ 893 public static final String CALENDAR_ID = "calendar_id"; 894 895 /** 896 * The title of the event. Column name. 897 * <P>Type: TEXT</P> 898 */ 899 public static final String TITLE = "title"; 900 901 /** 902 * The description of the event. Column name. 903 * <P>Type: TEXT</P> 904 */ 905 public static final String DESCRIPTION = "description"; 906 907 /** 908 * Where the event takes place. Column name. 909 * <P>Type: TEXT</P> 910 */ 911 public static final String EVENT_LOCATION = "eventLocation"; 912 913 /** 914 * A secondary color for the individual event. This should only be 915 * updated by the sync adapter for a given account. 916 * <P>Type: INTEGER</P> 917 */ 918 public static final String EVENT_COLOR = "eventColor"; 919 920 /** 921 * A secondary color key for the individual event. NULL or an empty 922 * string are reserved for indicating that the event does not use a key 923 * for looking up the color. The provider will update 924 * {@link #EVENT_COLOR} automatically when a valid key is written to 925 * this column. The key must reference an existing row of the 926 * {@link Colors} table. @see Colors 927 * <P> 928 * Type: TEXT 929 * </P> 930 */ 931 public static final String EVENT_COLOR_KEY = "eventColor_index"; 932 933 /** 934 * This will be {@link #EVENT_COLOR} if it is not null; otherwise, this will be 935 * {@link Calendars#CALENDAR_COLOR}. 936 * Read-only value. To modify, write to {@link #EVENT_COLOR} or 937 * {@link Calendars#CALENDAR_COLOR} directly. 938 *<P> 939 * Type: INTEGER 940 *</P> 941 */ 942 public static final String DISPLAY_COLOR = "displayColor"; 943 944 /** 945 * The event status. Column name. 946 * <P>Type: INTEGER (one of {@link #STATUS_TENTATIVE}...)</P> 947 */ 948 public static final String STATUS = "eventStatus"; 949 950 public static final int STATUS_TENTATIVE = 0; 951 public static final int STATUS_CONFIRMED = 1; 952 public static final int STATUS_CANCELED = 2; 953 954 /** 955 * This is a copy of the attendee status for the owner of this event. 956 * This field is copied here so that we can efficiently filter out 957 * events that are declined without having to look in the Attendees 958 * table. Column name. 959 * 960 * <P>Type: INTEGER (int)</P> 961 */ 962 public static final String SELF_ATTENDEE_STATUS = "selfAttendeeStatus"; 963 964 /** 965 * This column is available for use by sync adapters. Column name. 966 * <P>Type: TEXT</P> 967 */ 968 public static final String SYNC_DATA1 = "sync_data1"; 969 970 /** 971 * This column is available for use by sync adapters. Column name. 972 * <P>Type: TEXT</P> 973 */ 974 public static final String SYNC_DATA2 = "sync_data2"; 975 976 /** 977 * This column is available for use by sync adapters. Column name. 978 * <P>Type: TEXT</P> 979 */ 980 public static final String SYNC_DATA3 = "sync_data3"; 981 982 /** 983 * This column is available for use by sync adapters. Column name. 984 * <P>Type: TEXT</P> 985 */ 986 public static final String SYNC_DATA4 = "sync_data4"; 987 988 /** 989 * This column is available for use by sync adapters. Column name. 990 * <P>Type: TEXT</P> 991 */ 992 public static final String SYNC_DATA5 = "sync_data5"; 993 994 /** 995 * This column is available for use by sync adapters. Column name. 996 * <P>Type: TEXT</P> 997 */ 998 public static final String SYNC_DATA6 = "sync_data6"; 999 1000 /** 1001 * This column is available for use by sync adapters. Column name. 1002 * <P>Type: TEXT</P> 1003 */ 1004 public static final String SYNC_DATA7 = "sync_data7"; 1005 1006 /** 1007 * This column is available for use by sync adapters. Column name. 1008 * <P>Type: TEXT</P> 1009 */ 1010 public static final String SYNC_DATA8 = "sync_data8"; 1011 1012 /** 1013 * This column is available for use by sync adapters. Column name. 1014 * <P>Type: TEXT</P> 1015 */ 1016 public static final String SYNC_DATA9 = "sync_data9"; 1017 1018 /** 1019 * This column is available for use by sync adapters. Column name. 1020 * <P>Type: TEXT</P> 1021 */ 1022 public static final String SYNC_DATA10 = "sync_data10"; 1023 1024 /** 1025 * Used to indicate that a row is not a real event but an original copy of a locally 1026 * modified event. A copy is made when an event changes from non-dirty to dirty and the 1027 * event is on a calendar with {@link Calendars#CAN_PARTIALLY_UPDATE} set to 1. This copy 1028 * does not get expanded in the instances table and is only visible in queries made by a 1029 * sync adapter. The copy gets removed when the event is changed back to non-dirty by a 1030 * sync adapter. 1031 * <P>Type: INTEGER (boolean)</P> 1032 */ 1033 public static final String LAST_SYNCED = "lastSynced"; 1034 1035 /** 1036 * The time the event starts in UTC millis since epoch. Column name. 1037 * <P>Type: INTEGER (long; millis since epoch)</P> 1038 */ 1039 public static final String DTSTART = "dtstart"; 1040 1041 /** 1042 * The time the event ends in UTC millis since epoch. Column name. 1043 * <P>Type: INTEGER (long; millis since epoch)</P> 1044 */ 1045 public static final String DTEND = "dtend"; 1046 1047 /** 1048 * The duration of the event in RFC2445 format. Column name. 1049 * <P>Type: TEXT (duration in RFC2445 format)</P> 1050 */ 1051 public static final String DURATION = "duration"; 1052 1053 /** 1054 * The timezone for the event. Column name. 1055 * <P>Type: TEXT</P> 1056 */ 1057 public static final String EVENT_TIMEZONE = "eventTimezone"; 1058 1059 /** 1060 * The timezone for the end time of the event. Column name. 1061 * <P>Type: TEXT</P> 1062 */ 1063 public static final String EVENT_END_TIMEZONE = "eventEndTimezone"; 1064 1065 /** 1066 * Is the event all day (time zone independent). Column name. 1067 * <P>Type: INTEGER (boolean)</P> 1068 */ 1069 public static final String ALL_DAY = "allDay"; 1070 1071 /** 1072 * Defines how the event shows up for others when the calendar is 1073 * shared. Column name. 1074 * <P>Type: INTEGER (One of {@link #ACCESS_DEFAULT}, ...)</P> 1075 */ 1076 public static final String ACCESS_LEVEL = "accessLevel"; 1077 1078 /** 1079 * Default access is controlled by the server and will be treated as 1080 * public on the device. 1081 */ 1082 public static final int ACCESS_DEFAULT = 0; 1083 /** 1084 * Confidential is not used by the app. 1085 */ 1086 public static final int ACCESS_CONFIDENTIAL = 1; 1087 /** 1088 * Private shares the event as a free/busy slot with no details. 1089 */ 1090 public static final int ACCESS_PRIVATE = 2; 1091 /** 1092 * Public makes the contents visible to anyone with access to the 1093 * calendar. 1094 */ 1095 public static final int ACCESS_PUBLIC = 3; 1096 1097 /** 1098 * If this event counts as busy time or is still free time that can be 1099 * scheduled over. Column name. 1100 * <P> 1101 * Type: INTEGER (One of {@link #AVAILABILITY_BUSY}, 1102 * {@link #AVAILABILITY_FREE}, {@link #AVAILABILITY_TENTATIVE}) 1103 * </P> 1104 */ 1105 public static final String AVAILABILITY = "availability"; 1106 1107 /** 1108 * Indicates that this event takes up time and will conflict with other 1109 * events. 1110 */ 1111 public static final int AVAILABILITY_BUSY = 0; 1112 /** 1113 * Indicates that this event is free time and will not conflict with 1114 * other events. 1115 */ 1116 public static final int AVAILABILITY_FREE = 1; 1117 /** 1118 * Indicates that the owner's availability may change, but should be 1119 * considered busy time that will conflict. 1120 */ 1121 public static final int AVAILABILITY_TENTATIVE = 2; 1122 1123 /** 1124 * Whether the event has an alarm or not. Column name. 1125 * <P>Type: INTEGER (boolean)</P> 1126 */ 1127 public static final String HAS_ALARM = "hasAlarm"; 1128 1129 /** 1130 * Whether the event has extended properties or not. Column name. 1131 * <P>Type: INTEGER (boolean)</P> 1132 */ 1133 public static final String HAS_EXTENDED_PROPERTIES = "hasExtendedProperties"; 1134 1135 /** 1136 * The recurrence rule for the event. Column name. 1137 * <P>Type: TEXT</P> 1138 */ 1139 public static final String RRULE = "rrule"; 1140 1141 /** 1142 * The recurrence dates for the event. Column name. 1143 * <P>Type: TEXT</P> 1144 */ 1145 public static final String RDATE = "rdate"; 1146 1147 /** 1148 * The recurrence exception rule for the event. Column name. 1149 * <P>Type: TEXT</P> 1150 */ 1151 public static final String EXRULE = "exrule"; 1152 1153 /** 1154 * The recurrence exception dates for the event. Column name. 1155 * <P>Type: TEXT</P> 1156 */ 1157 public static final String EXDATE = "exdate"; 1158 1159 /** 1160 * The {@link Events#_ID} of the original recurring event for which this 1161 * event is an exception. Column name. 1162 * <P>Type: TEXT</P> 1163 */ 1164 public static final String ORIGINAL_ID = "original_id"; 1165 1166 /** 1167 * The _sync_id of the original recurring event for which this event is 1168 * an exception. The provider should keep the original_id in sync when 1169 * this is updated. Column name. 1170 * <P>Type: TEXT</P> 1171 */ 1172 public static final String ORIGINAL_SYNC_ID = "original_sync_id"; 1173 1174 /** 1175 * The original instance time of the recurring event for which this 1176 * event is an exception. Column name. 1177 * <P>Type: INTEGER (long; millis since epoch)</P> 1178 */ 1179 public static final String ORIGINAL_INSTANCE_TIME = "originalInstanceTime"; 1180 1181 /** 1182 * The allDay status (true or false) of the original recurring event 1183 * for which this event is an exception. Column name. 1184 * <P>Type: INTEGER (boolean)</P> 1185 */ 1186 public static final String ORIGINAL_ALL_DAY = "originalAllDay"; 1187 1188 /** 1189 * The last date this event repeats on, or NULL if it never ends. Column 1190 * name. 1191 * <P>Type: INTEGER (long; millis since epoch)</P> 1192 */ 1193 public static final String LAST_DATE = "lastDate"; 1194 1195 /** 1196 * Whether the event has attendee information. True if the event 1197 * has full attendee data, false if the event has information about 1198 * self only. Column name. 1199 * <P>Type: INTEGER (boolean)</P> 1200 */ 1201 public static final String HAS_ATTENDEE_DATA = "hasAttendeeData"; 1202 1203 /** 1204 * Whether guests can modify the event. Column name. 1205 * <P>Type: INTEGER (boolean)</P> 1206 */ 1207 public static final String GUESTS_CAN_MODIFY = "guestsCanModify"; 1208 1209 /** 1210 * Whether guests can invite other guests. Column name. 1211 * <P>Type: INTEGER (boolean)</P> 1212 */ 1213 public static final String GUESTS_CAN_INVITE_OTHERS = "guestsCanInviteOthers"; 1214 1215 /** 1216 * Whether guests can see the list of attendees. Column name. 1217 * <P>Type: INTEGER (boolean)</P> 1218 */ 1219 public static final String GUESTS_CAN_SEE_GUESTS = "guestsCanSeeGuests"; 1220 1221 /** 1222 * Email of the organizer (owner) of the event. Column name. 1223 * <P>Type: STRING</P> 1224 */ 1225 public static final String ORGANIZER = "organizer"; 1226 1227 /** 1228 * Are we the organizer of this event. If this column is not explicitly set, the provider 1229 * will return 1 if {@link #ORGANIZER} is equal to {@link Calendars#OWNER_ACCOUNT}. 1230 * Column name. 1231 * <P>Type: STRING</P> 1232 */ 1233 public static final String IS_ORGANIZER = "isOrganizer"; 1234 1235 /** 1236 * Whether the user can invite others to the event. The 1237 * GUESTS_CAN_INVITE_OTHERS is a setting that applies to an arbitrary 1238 * guest, while CAN_INVITE_OTHERS indicates if the user can invite 1239 * others (either through GUESTS_CAN_INVITE_OTHERS or because the user 1240 * has modify access to the event). Column name. 1241 * <P>Type: INTEGER (boolean, readonly)</P> 1242 */ 1243 public static final String CAN_INVITE_OTHERS = "canInviteOthers"; 1244 1245 /** 1246 * The package name of the custom app that can provide a richer 1247 * experience for the event. See the ACTION TYPE 1248 * {@link CalendarContract#ACTION_HANDLE_CUSTOM_EVENT} for details. 1249 * Column name. 1250 * <P> Type: TEXT </P> 1251 */ 1252 public static final String CUSTOM_APP_PACKAGE = "customAppPackage"; 1253 1254 /** 1255 * The URI used by the custom app for the event. Column name. 1256 * <P>Type: TEXT</P> 1257 */ 1258 public static final String CUSTOM_APP_URI = "customAppUri"; 1259 1260 /** 1261 * The UID for events added from the RFC 2445 iCalendar format. 1262 * Column name. 1263 * <P>Type: TEXT</P> 1264 */ 1265 public static final String UID_2445 = "uid2445"; 1266 } 1267 1268 /** 1269 * Class that represents an Event Entity. There is one entry per event. 1270 * Recurring events show up as a single entry. This is a helper class to 1271 * make batch operations easier. A {@link ContentResolver} or 1272 * {@link ContentProviderClient} is required as the helper does additional 1273 * queries to add reminders and attendees to each entry. 1274 */ 1275 public static final class EventsEntity implements BaseColumns, SyncColumns, EventsColumns { 1276 /** 1277 * The content:// style URL for this table 1278 */ 1279 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + 1280 "/event_entities"); 1281 1282 /** 1283 * This utility class cannot be instantiated 1284 */ 1285 private EventsEntity() {} 1286 1287 /** 1288 * Creates a new iterator for events 1289 * 1290 * @param cursor An event query 1291 * @param resolver For performing additional queries 1292 * @return an EntityIterator containing one entity per event in the 1293 * cursor 1294 */ 1295 public static EntityIterator newEntityIterator(Cursor cursor, ContentResolver resolver) { 1296 return new EntityIteratorImpl(cursor, resolver); 1297 } 1298 1299 /** 1300 * Creates a new iterator for events 1301 * 1302 * @param cursor An event query 1303 * @param provider For performing additional queries 1304 * @return an EntityIterator containing one entity per event in the 1305 * cursor 1306 */ 1307 public static EntityIterator newEntityIterator(Cursor cursor, 1308 ContentProviderClient provider) { 1309 return new EntityIteratorImpl(cursor, provider); 1310 } 1311 1312 private static class EntityIteratorImpl extends CursorEntityIterator { 1313 private final ContentResolver mResolver; 1314 private final ContentProviderClient mProvider; 1315 1316 private static final String[] REMINDERS_PROJECTION = new String[] { 1317 Reminders.MINUTES, 1318 Reminders.METHOD, 1319 }; 1320 private static final int COLUMN_MINUTES = 0; 1321 private static final int COLUMN_METHOD = 1; 1322 1323 private static final String[] ATTENDEES_PROJECTION = new String[] { 1324 Attendees.ATTENDEE_NAME, 1325 Attendees.ATTENDEE_EMAIL, 1326 Attendees.ATTENDEE_RELATIONSHIP, 1327 Attendees.ATTENDEE_TYPE, 1328 Attendees.ATTENDEE_STATUS, 1329 Attendees.ATTENDEE_IDENTITY, 1330 Attendees.ATTENDEE_ID_NAMESPACE 1331 }; 1332 private static final int COLUMN_ATTENDEE_NAME = 0; 1333 private static final int COLUMN_ATTENDEE_EMAIL = 1; 1334 private static final int COLUMN_ATTENDEE_RELATIONSHIP = 2; 1335 private static final int COLUMN_ATTENDEE_TYPE = 3; 1336 private static final int COLUMN_ATTENDEE_STATUS = 4; 1337 private static final int COLUMN_ATTENDEE_IDENTITY = 5; 1338 private static final int COLUMN_ATTENDEE_ID_NAMESPACE = 6; 1339 1340 private static final String[] EXTENDED_PROJECTION = new String[] { 1341 ExtendedProperties._ID, 1342 ExtendedProperties.NAME, 1343 ExtendedProperties.VALUE 1344 }; 1345 private static final int COLUMN_ID = 0; 1346 private static final int COLUMN_NAME = 1; 1347 private static final int COLUMN_VALUE = 2; 1348 1349 private static final String WHERE_EVENT_ID = "event_id=?"; 1350 1351 public EntityIteratorImpl(Cursor cursor, ContentResolver resolver) { 1352 super(cursor); 1353 mResolver = resolver; 1354 mProvider = null; 1355 } 1356 1357 public EntityIteratorImpl(Cursor cursor, ContentProviderClient provider) { 1358 super(cursor); 1359 mResolver = null; 1360 mProvider = provider; 1361 } 1362 1363 @Override 1364 public Entity getEntityAndIncrementCursor(Cursor cursor) throws RemoteException { 1365 // we expect the cursor is already at the row we need to read from 1366 final long eventId = cursor.getLong(cursor.getColumnIndexOrThrow(Events._ID)); 1367 ContentValues cv = new ContentValues(); 1368 cv.put(Events._ID, eventId); 1369 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, CALENDAR_ID); 1370 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, TITLE); 1371 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, DESCRIPTION); 1372 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_LOCATION); 1373 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, STATUS); 1374 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, SELF_ATTENDEE_STATUS); 1375 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DTSTART); 1376 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DTEND); 1377 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, DURATION); 1378 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_TIMEZONE); 1379 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EVENT_END_TIMEZONE); 1380 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ALL_DAY); 1381 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, ACCESS_LEVEL); 1382 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, AVAILABILITY); 1383 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, EVENT_COLOR); 1384 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, EVENT_COLOR_KEY); 1385 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, HAS_ALARM); 1386 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, 1387 HAS_EXTENDED_PROPERTIES); 1388 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, RRULE); 1389 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, RDATE); 1390 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EXRULE); 1391 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, EXDATE); 1392 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORIGINAL_SYNC_ID); 1393 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORIGINAL_ID); 1394 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, 1395 ORIGINAL_INSTANCE_TIME); 1396 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, ORIGINAL_ALL_DAY); 1397 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, LAST_DATE); 1398 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, HAS_ATTENDEE_DATA); 1399 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, 1400 GUESTS_CAN_INVITE_OTHERS); 1401 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, GUESTS_CAN_MODIFY); 1402 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, GUESTS_CAN_SEE_GUESTS); 1403 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CUSTOM_APP_PACKAGE); 1404 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CUSTOM_APP_URI); 1405 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, UID_2445); 1406 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, ORGANIZER); 1407 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, IS_ORGANIZER); 1408 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, _SYNC_ID); 1409 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, DIRTY); 1410 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, MUTATORS); 1411 DatabaseUtils.cursorLongToContentValuesIfPresent(cursor, cv, LAST_SYNCED); 1412 DatabaseUtils.cursorIntToContentValuesIfPresent(cursor, cv, DELETED); 1413 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA1); 1414 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA2); 1415 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA3); 1416 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA4); 1417 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA5); 1418 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA6); 1419 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA7); 1420 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA8); 1421 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA9); 1422 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, SYNC_DATA10); 1423 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC1); 1424 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC2); 1425 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC3); 1426 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC4); 1427 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC5); 1428 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC6); 1429 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC7); 1430 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC8); 1431 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC9); 1432 DatabaseUtils.cursorStringToContentValuesIfPresent(cursor, cv, CAL_SYNC10); 1433 1434 Entity entity = new Entity(cv); 1435 Cursor subCursor; 1436 if (mResolver != null) { 1437 subCursor = mResolver.query(Reminders.CONTENT_URI, REMINDERS_PROJECTION, 1438 WHERE_EVENT_ID, 1439 new String[] { Long.toString(eventId) } /* selectionArgs */, 1440 null /* sortOrder */); 1441 } else { 1442 subCursor = mProvider.query(Reminders.CONTENT_URI, REMINDERS_PROJECTION, 1443 WHERE_EVENT_ID, 1444 new String[] { Long.toString(eventId) } /* selectionArgs */, 1445 null /* sortOrder */); 1446 } 1447 try { 1448 while (subCursor.moveToNext()) { 1449 ContentValues reminderValues = new ContentValues(); 1450 reminderValues.put(Reminders.MINUTES, subCursor.getInt(COLUMN_MINUTES)); 1451 reminderValues.put(Reminders.METHOD, subCursor.getInt(COLUMN_METHOD)); 1452 entity.addSubValue(Reminders.CONTENT_URI, reminderValues); 1453 } 1454 } finally { 1455 subCursor.close(); 1456 } 1457 1458 if (mResolver != null) { 1459 subCursor = mResolver.query(Attendees.CONTENT_URI, ATTENDEES_PROJECTION, 1460 WHERE_EVENT_ID, 1461 new String[] { Long.toString(eventId) } /* selectionArgs */, 1462 null /* sortOrder */); 1463 } else { 1464 subCursor = mProvider.query(Attendees.CONTENT_URI, ATTENDEES_PROJECTION, 1465 WHERE_EVENT_ID, 1466 new String[] { Long.toString(eventId) } /* selectionArgs */, 1467 null /* sortOrder */); 1468 } 1469 try { 1470 while (subCursor.moveToNext()) { 1471 ContentValues attendeeValues = new ContentValues(); 1472 attendeeValues.put(Attendees.ATTENDEE_NAME, 1473 subCursor.getString(COLUMN_ATTENDEE_NAME)); 1474 attendeeValues.put(Attendees.ATTENDEE_EMAIL, 1475 subCursor.getString(COLUMN_ATTENDEE_EMAIL)); 1476 attendeeValues.put(Attendees.ATTENDEE_RELATIONSHIP, 1477 subCursor.getInt(COLUMN_ATTENDEE_RELATIONSHIP)); 1478 attendeeValues.put(Attendees.ATTENDEE_TYPE, 1479 subCursor.getInt(COLUMN_ATTENDEE_TYPE)); 1480 attendeeValues.put(Attendees.ATTENDEE_STATUS, 1481 subCursor.getInt(COLUMN_ATTENDEE_STATUS)); 1482 attendeeValues.put(Attendees.ATTENDEE_IDENTITY, 1483 subCursor.getString(COLUMN_ATTENDEE_IDENTITY)); 1484 attendeeValues.put(Attendees.ATTENDEE_ID_NAMESPACE, 1485 subCursor.getString(COLUMN_ATTENDEE_ID_NAMESPACE)); 1486 entity.addSubValue(Attendees.CONTENT_URI, attendeeValues); 1487 } 1488 } finally { 1489 subCursor.close(); 1490 } 1491 1492 if (mResolver != null) { 1493 subCursor = mResolver.query(ExtendedProperties.CONTENT_URI, EXTENDED_PROJECTION, 1494 WHERE_EVENT_ID, 1495 new String[] { Long.toString(eventId) } /* selectionArgs */, 1496 null /* sortOrder */); 1497 } else { 1498 subCursor = mProvider.query(ExtendedProperties.CONTENT_URI, EXTENDED_PROJECTION, 1499 WHERE_EVENT_ID, 1500 new String[] { Long.toString(eventId) } /* selectionArgs */, 1501 null /* sortOrder */); 1502 } 1503 try { 1504 while (subCursor.moveToNext()) { 1505 ContentValues extendedValues = new ContentValues(); 1506 extendedValues.put(ExtendedProperties._ID, 1507 subCursor.getString(COLUMN_ID)); 1508 extendedValues.put(ExtendedProperties.NAME, 1509 subCursor.getString(COLUMN_NAME)); 1510 extendedValues.put(ExtendedProperties.VALUE, 1511 subCursor.getString(COLUMN_VALUE)); 1512 entity.addSubValue(ExtendedProperties.CONTENT_URI, extendedValues); 1513 } 1514 } finally { 1515 subCursor.close(); 1516 } 1517 1518 cursor.moveToNext(); 1519 return entity; 1520 } 1521 } 1522 } 1523 1524 /** 1525 * Constants and helpers for the Events table, which contains details for 1526 * individual events. <h3>Operations</h3> All operations can be done either 1527 * as an app or as a sync adapter. To perform an operation as a sync adapter 1528 * {@link #CALLER_IS_SYNCADAPTER} should be set to true and 1529 * {@link #ACCOUNT_NAME} and {@link #ACCOUNT_TYPE} must be set in the Uri 1530 * parameters. See 1531 * {@link Uri.Builder#appendQueryParameter(java.lang.String, java.lang.String)} 1532 * for details on adding parameters. Sync adapters have write access to more 1533 * columns but are restricted to a single account at a time. 1534 * <dl> 1535 * <dt><b>Insert</b></dt> 1536 * <dd>When inserting a new event the following fields must be included: 1537 * <ul> 1538 * <li>dtstart</li> 1539 * <li>dtend if the event is non-recurring</li> 1540 * <li>duration if the event is recurring</li> 1541 * <li>rrule or rdate if the event is recurring</li> 1542 * <li>eventTimezone</li> 1543 * <li>a calendar_id</li> 1544 * </ul> 1545 * There are also further requirements when inserting or updating an event. 1546 * See the section on Writing to Events.</dd> 1547 * <dt><b>Update</b></dt> 1548 * <dd>To perform an update of an Event the {@link Events#_ID} of the event 1549 * should be provided either as an appended id to the Uri ( 1550 * {@link ContentUris#withAppendedId}) or as the first selection item--the 1551 * selection should start with "_id=?" and the first selectionArg should be 1552 * the _id of the event. Updates may also be done using a selection and no 1553 * id. Updating an event must respect the same rules as inserting and is 1554 * further restricted in the fields that can be written. See the section on 1555 * Writing to Events.</dd> 1556 * <dt><b>Delete</b></dt> 1557 * <dd>Events can be deleted either by the {@link Events#_ID} as an appended 1558 * id on the Uri or using any standard selection. If an appended id is used 1559 * a selection is not allowed. There are two versions of delete: as an app 1560 * and as a sync adapter. An app delete will set the deleted column on an 1561 * event and remove all instances of that event. A sync adapter delete will 1562 * remove the event from the database and all associated data.</dd> 1563 * <dt><b>Query</b></dt> 1564 * <dd>Querying the Events table will get you all information about a set of 1565 * events except their reminders, attendees, and extended properties. There 1566 * will be one row returned for each event that matches the query selection, 1567 * or at most a single row if the {@link Events#_ID} is appended to the Uri. 1568 * Recurring events will only return a single row regardless of the number 1569 * of times that event repeats.</dd> 1570 * </dl> 1571 * <h3>Writing to Events</h3> There are further restrictions on all Updates 1572 * and Inserts in the Events table: 1573 * <ul> 1574 * <li>If allDay is set to 1 eventTimezone must be {@link Time#TIMEZONE_UTC} 1575 * and the time must correspond to a midnight boundary.</li> 1576 * <li>Exceptions are not allowed to recur. If rrule or rdate is not empty, 1577 * original_id and original_sync_id must be empty.</li> 1578 * <li>In general a calendar_id should not be modified after insertion. This 1579 * is not explicitly forbidden but many sync adapters will not behave in an 1580 * expected way if the calendar_id is modified.</li> 1581 * </ul> 1582 * The following Events columns are writable by both an app and a sync 1583 * adapter. 1584 * <ul> 1585 * <li>{@link #CALENDAR_ID}</li> 1586 * <li>{@link #ORGANIZER}</li> 1587 * <li>{@link #TITLE}</li> 1588 * <li>{@link #EVENT_LOCATION}</li> 1589 * <li>{@link #DESCRIPTION}</li> 1590 * <li>{@link #EVENT_COLOR}</li> 1591 * <li>{@link #DTSTART}</li> 1592 * <li>{@link #DTEND}</li> 1593 * <li>{@link #EVENT_TIMEZONE}</li> 1594 * <li>{@link #EVENT_END_TIMEZONE}</li> 1595 * <li>{@link #DURATION}</li> 1596 * <li>{@link #ALL_DAY}</li> 1597 * <li>{@link #RRULE}</li> 1598 * <li>{@link #RDATE}</li> 1599 * <li>{@link #EXRULE}</li> 1600 * <li>{@link #EXDATE}</li> 1601 * <li>{@link #ORIGINAL_ID}</li> 1602 * <li>{@link #ORIGINAL_SYNC_ID}</li> 1603 * <li>{@link #ORIGINAL_INSTANCE_TIME}</li> 1604 * <li>{@link #ORIGINAL_ALL_DAY}</li> 1605 * <li>{@link #ACCESS_LEVEL}</li> 1606 * <li>{@link #AVAILABILITY}</li> 1607 * <li>{@link #GUESTS_CAN_MODIFY}</li> 1608 * <li>{@link #GUESTS_CAN_INVITE_OTHERS}</li> 1609 * <li>{@link #GUESTS_CAN_SEE_GUESTS}</li> 1610 * <li>{@link #CUSTOM_APP_PACKAGE}</li> 1611 * <li>{@link #CUSTOM_APP_URI}</li> 1612 * <li>{@link #UID_2445}</li> 1613 * </ul> 1614 * The following Events columns are writable only by a sync adapter 1615 * <ul> 1616 * <li>{@link #DIRTY}</li> 1617 * <li>{@link #MUTATORS}</li> 1618 * <li>{@link #_SYNC_ID}</li> 1619 * <li>{@link #SYNC_DATA1}</li> 1620 * <li>{@link #SYNC_DATA2}</li> 1621 * <li>{@link #SYNC_DATA3}</li> 1622 * <li>{@link #SYNC_DATA4}</li> 1623 * <li>{@link #SYNC_DATA5}</li> 1624 * <li>{@link #SYNC_DATA6}</li> 1625 * <li>{@link #SYNC_DATA7}</li> 1626 * <li>{@link #SYNC_DATA8}</li> 1627 * <li>{@link #SYNC_DATA9}</li> 1628 * <li>{@link #SYNC_DATA10}</li> 1629 * </ul> 1630 * The remaining columns are either updated by the provider only or are 1631 * views into other tables and cannot be changed through the Events table. 1632 */ 1633 public static final class Events implements BaseColumns, SyncColumns, EventsColumns, 1634 CalendarColumns { 1635 1636 /** 1637 * The content:// style URL for interacting with events. Appending an 1638 * event id using {@link ContentUris#withAppendedId(Uri, long)} will 1639 * specify a single event. 1640 */ 1641 @SuppressWarnings("hiding") 1642 public static final Uri CONTENT_URI = 1643 Uri.parse("content://" + AUTHORITY + "/events"); 1644 1645 /** 1646 * The content:// style URI for recurring event exceptions. Insertions require an 1647 * appended event ID. Deletion of exceptions requires both the original event ID and 1648 * the exception event ID (see {@link Uri.Builder#appendPath}). 1649 */ 1650 public static final Uri CONTENT_EXCEPTION_URI = 1651 Uri.parse("content://" + AUTHORITY + "/exception"); 1652 1653 /** 1654 * This utility class cannot be instantiated 1655 */ 1656 private Events() {} 1657 1658 /** 1659 * The default sort order for this table 1660 */ 1661 private static final String DEFAULT_SORT_ORDER = ""; 1662 1663 /** 1664 * These are columns that should only ever be updated by the provider, 1665 * either because they are views mapped to another table or because they 1666 * are used for provider only functionality. TODO move to provider 1667 * 1668 * @hide 1669 */ 1670 public static String[] PROVIDER_WRITABLE_COLUMNS = new String[] { 1671 ACCOUNT_NAME, 1672 ACCOUNT_TYPE, 1673 CAL_SYNC1, 1674 CAL_SYNC2, 1675 CAL_SYNC3, 1676 CAL_SYNC4, 1677 CAL_SYNC5, 1678 CAL_SYNC6, 1679 CAL_SYNC7, 1680 CAL_SYNC8, 1681 CAL_SYNC9, 1682 CAL_SYNC10, 1683 ALLOWED_REMINDERS, 1684 ALLOWED_ATTENDEE_TYPES, 1685 ALLOWED_AVAILABILITY, 1686 CALENDAR_ACCESS_LEVEL, 1687 CALENDAR_COLOR, 1688 CALENDAR_TIME_ZONE, 1689 CAN_MODIFY_TIME_ZONE, 1690 CAN_ORGANIZER_RESPOND, 1691 CALENDAR_DISPLAY_NAME, 1692 CAN_PARTIALLY_UPDATE, 1693 SYNC_EVENTS, 1694 VISIBLE, 1695 }; 1696 1697 /** 1698 * These fields are only writable by a sync adapter. To modify them the 1699 * caller must include CALLER_IS_SYNCADAPTER, _SYNC_ACCOUNT, and 1700 * _SYNC_ACCOUNT_TYPE in the query parameters. TODO move to provider. 1701 * 1702 * @hide 1703 */ 1704 public static final String[] SYNC_WRITABLE_COLUMNS = new String[] { 1705 _SYNC_ID, 1706 DIRTY, 1707 MUTATORS, 1708 SYNC_DATA1, 1709 SYNC_DATA2, 1710 SYNC_DATA3, 1711 SYNC_DATA4, 1712 SYNC_DATA5, 1713 SYNC_DATA6, 1714 SYNC_DATA7, 1715 SYNC_DATA8, 1716 SYNC_DATA9, 1717 SYNC_DATA10, 1718 }; 1719 } 1720 1721 /** 1722 * Fields and helpers for interacting with Instances. An instance is a 1723 * single occurrence of an event including time zone specific start and end 1724 * days and minutes. The instances table is not writable and only provides a 1725 * way to query event occurrences. 1726 */ 1727 public static final class Instances implements BaseColumns, EventsColumns, CalendarColumns { 1728 1729 private static final String WHERE_CALENDARS_SELECTED = Calendars.VISIBLE + "=?"; 1730 private static final String[] WHERE_CALENDARS_ARGS = { 1731 "1" 1732 }; 1733 1734 /** 1735 * This utility class cannot be instantiated 1736 */ 1737 private Instances() {} 1738 1739 /** 1740 * Performs a query to return all visible instances in the given range. 1741 * This is a blocking function and should not be done on the UI thread. 1742 * This will cause an expansion of recurring events to fill this time 1743 * range if they are not already expanded and will slow down for larger 1744 * time ranges with many recurring events. 1745 * 1746 * @param cr The ContentResolver to use for the query 1747 * @param projection The columns to return 1748 * @param begin The start of the time range to query in UTC millis since 1749 * epoch 1750 * @param end The end of the time range to query in UTC millis since 1751 * epoch 1752 * @return A Cursor containing all instances in the given range 1753 */ 1754 public static final Cursor query(ContentResolver cr, String[] projection, 1755 long begin, long end) { 1756 Uri.Builder builder = CONTENT_URI.buildUpon(); 1757 ContentUris.appendId(builder, begin); 1758 ContentUris.appendId(builder, end); 1759 return cr.query(builder.build(), projection, WHERE_CALENDARS_SELECTED, 1760 WHERE_CALENDARS_ARGS, DEFAULT_SORT_ORDER); 1761 } 1762 1763 /** 1764 * Performs a query to return all visible instances in the given range 1765 * that match the given query. This is a blocking function and should 1766 * not be done on the UI thread. This will cause an expansion of 1767 * recurring events to fill this time range if they are not already 1768 * expanded and will slow down for larger time ranges with many 1769 * recurring events. 1770 * 1771 * @param cr The ContentResolver to use for the query 1772 * @param projection The columns to return 1773 * @param begin The start of the time range to query in UTC millis since 1774 * epoch 1775 * @param end The end of the time range to query in UTC millis since 1776 * epoch 1777 * @param searchQuery A string of space separated search terms. Segments 1778 * enclosed by double quotes will be treated as a single 1779 * term. 1780 * @return A Cursor of instances matching the search terms in the given 1781 * time range 1782 */ 1783 public static final Cursor query(ContentResolver cr, String[] projection, 1784 long begin, long end, String searchQuery) { 1785 Uri.Builder builder = CONTENT_SEARCH_URI.buildUpon(); 1786 ContentUris.appendId(builder, begin); 1787 ContentUris.appendId(builder, end); 1788 builder = builder.appendPath(searchQuery); 1789 return cr.query(builder.build(), projection, WHERE_CALENDARS_SELECTED, 1790 WHERE_CALENDARS_ARGS, DEFAULT_SORT_ORDER); 1791 } 1792 1793 /** 1794 * The content:// style URL for querying an instance range. The begin 1795 * and end of the range to query should be added as path segments if 1796 * this is used directly. 1797 */ 1798 @SuppressWarnings("hiding") 1799 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + 1800 "/instances/when"); 1801 /** 1802 * The content:// style URL for querying an instance range by Julian 1803 * Day. The start and end day should be added as path segments if this 1804 * is used directly. 1805 */ 1806 public static final Uri CONTENT_BY_DAY_URI = 1807 Uri.parse("content://" + AUTHORITY + "/instances/whenbyday"); 1808 /** 1809 * The content:// style URL for querying an instance range with a search 1810 * term. The begin, end, and search string should be appended as path 1811 * segments if this is used directly. 1812 */ 1813 public static final Uri CONTENT_SEARCH_URI = Uri.parse("content://" + AUTHORITY + 1814 "/instances/search"); 1815 /** 1816 * The content:// style URL for querying an instance range with a search 1817 * term. The start day, end day, and search string should be appended as 1818 * path segments if this is used directly. 1819 */ 1820 public static final Uri CONTENT_SEARCH_BY_DAY_URI = 1821 Uri.parse("content://" + AUTHORITY + "/instances/searchbyday"); 1822 1823 /** 1824 * The default sort order for this table. 1825 */ 1826 private static final String DEFAULT_SORT_ORDER = "begin ASC"; 1827 1828 /** 1829 * The beginning time of the instance, in UTC milliseconds. Column name. 1830 * <P>Type: INTEGER (long; millis since epoch)</P> 1831 */ 1832 public static final String BEGIN = "begin"; 1833 1834 /** 1835 * The ending time of the instance, in UTC milliseconds. Column name. 1836 * <P>Type: INTEGER (long; millis since epoch)</P> 1837 */ 1838 public static final String END = "end"; 1839 1840 /** 1841 * The _id of the event for this instance. Column name. 1842 * <P>Type: INTEGER (long, foreign key to the Events table)</P> 1843 */ 1844 public static final String EVENT_ID = "event_id"; 1845 1846 /** 1847 * The Julian start day of the instance, relative to the local time 1848 * zone. Column name. 1849 * <P>Type: INTEGER (int)</P> 1850 */ 1851 public static final String START_DAY = "startDay"; 1852 1853 /** 1854 * The Julian end day of the instance, relative to the local time 1855 * zone. Column name. 1856 * <P>Type: INTEGER (int)</P> 1857 */ 1858 public static final String END_DAY = "endDay"; 1859 1860 /** 1861 * The start minute of the instance measured from midnight in the 1862 * local time zone. Column name. 1863 * <P>Type: INTEGER (int)</P> 1864 */ 1865 public static final String START_MINUTE = "startMinute"; 1866 1867 /** 1868 * The end minute of the instance measured from midnight in the 1869 * local time zone. Column name. 1870 * <P>Type: INTEGER (int)</P> 1871 */ 1872 public static final String END_MINUTE = "endMinute"; 1873 } 1874 1875 protected interface CalendarCacheColumns { 1876 /** 1877 * The key for the setting. Keys are defined in {@link CalendarCache}. 1878 */ 1879 public static final String KEY = "key"; 1880 1881 /** 1882 * The value of the given setting. 1883 */ 1884 public static final String VALUE = "value"; 1885 } 1886 1887 /** 1888 * CalendarCache stores some settings for calendar including the current 1889 * time zone for the instances. These settings are stored using a key/value 1890 * scheme. A {@link #KEY} must be specified when updating these values. 1891 */ 1892 public static final class CalendarCache implements CalendarCacheColumns { 1893 /** 1894 * The URI to use for retrieving the properties from the Calendar db. 1895 */ 1896 public static final Uri URI = 1897 Uri.parse("content://" + AUTHORITY + "/properties"); 1898 1899 /** 1900 * This utility class cannot be instantiated 1901 */ 1902 private CalendarCache() {} 1903 1904 /** 1905 * They key for updating the use of auto/home time zones in Calendar. 1906 * Valid values are {@link #TIMEZONE_TYPE_AUTO} or 1907 * {@link #TIMEZONE_TYPE_HOME}. 1908 */ 1909 public static final String KEY_TIMEZONE_TYPE = "timezoneType"; 1910 1911 /** 1912 * The key for updating the time zone used by the provider when it 1913 * generates the instances table. This should only be written if the 1914 * type is set to {@link #TIMEZONE_TYPE_HOME}. A valid time zone id 1915 * should be written to this field. 1916 */ 1917 public static final String KEY_TIMEZONE_INSTANCES = "timezoneInstances"; 1918 1919 /** 1920 * The key for reading the last time zone set by the user. This should 1921 * only be read by apps and it will be automatically updated whenever 1922 * {@link #KEY_TIMEZONE_INSTANCES} is updated with 1923 * {@link #TIMEZONE_TYPE_HOME} set. 1924 */ 1925 public static final String KEY_TIMEZONE_INSTANCES_PREVIOUS = "timezoneInstancesPrevious"; 1926 1927 /** 1928 * The value to write to {@link #KEY_TIMEZONE_TYPE} if the provider 1929 * should stay in sync with the device's time zone. 1930 */ 1931 public static final String TIMEZONE_TYPE_AUTO = "auto"; 1932 1933 /** 1934 * The value to write to {@link #KEY_TIMEZONE_TYPE} if the provider 1935 * should use a fixed time zone set by the user. 1936 */ 1937 public static final String TIMEZONE_TYPE_HOME = "home"; 1938 } 1939 1940 /** 1941 * A few Calendar globals are needed in the CalendarProvider for expanding 1942 * the Instances table and these are all stored in the first (and only) row 1943 * of the CalendarMetaData table. 1944 * 1945 * @hide 1946 */ 1947 protected interface CalendarMetaDataColumns { 1948 /** 1949 * The local timezone that was used for precomputing the fields 1950 * in the Instances table. 1951 */ 1952 public static final String LOCAL_TIMEZONE = "localTimezone"; 1953 1954 /** 1955 * The minimum time used in expanding the Instances table, 1956 * in UTC milliseconds. 1957 * <P>Type: INTEGER</P> 1958 */ 1959 public static final String MIN_INSTANCE = "minInstance"; 1960 1961 /** 1962 * The maximum time used in expanding the Instances table, 1963 * in UTC milliseconds. 1964 * <P>Type: INTEGER</P> 1965 */ 1966 public static final String MAX_INSTANCE = "maxInstance"; 1967 1968 /** 1969 * The minimum Julian day in the EventDays table. 1970 * <P>Type: INTEGER</P> 1971 */ 1972 public static final String MIN_EVENTDAYS = "minEventDays"; 1973 1974 /** 1975 * The maximum Julian day in the EventDays table. 1976 * <P>Type: INTEGER</P> 1977 */ 1978 public static final String MAX_EVENTDAYS = "maxEventDays"; 1979 } 1980 1981 /** 1982 * @hide 1983 */ 1984 public static final class CalendarMetaData implements CalendarMetaDataColumns, BaseColumns { 1985 1986 /** 1987 * This utility class cannot be instantiated 1988 */ 1989 private CalendarMetaData() {} 1990 } 1991 1992 protected interface EventDaysColumns { 1993 /** 1994 * The Julian starting day number. Column name. 1995 * <P>Type: INTEGER (int)</P> 1996 */ 1997 public static final String STARTDAY = "startDay"; 1998 /** 1999 * The Julian ending day number. Column name. 2000 * <P>Type: INTEGER (int)</P> 2001 */ 2002 public static final String ENDDAY = "endDay"; 2003 2004 } 2005 2006 /** 2007 * Fields and helpers for querying for a list of days that contain events. 2008 */ 2009 public static final class EventDays implements EventDaysColumns { 2010 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY 2011 + "/instances/groupbyday"); 2012 private static final String SELECTION = "selected=1"; 2013 2014 /** 2015 * This utility class cannot be instantiated 2016 */ 2017 private EventDays() {} 2018 2019 /** 2020 * Retrieves the days with events for the Julian days starting at 2021 * "startDay" for "numDays". It returns a cursor containing startday and 2022 * endday representing the max range of days for all events beginning on 2023 * each startday.This is a blocking function and should not be done on 2024 * the UI thread. 2025 * 2026 * @param cr the ContentResolver 2027 * @param startDay the first Julian day in the range 2028 * @param numDays the number of days to load (must be at least 1) 2029 * @param projection the columns to return in the cursor 2030 * @return a database cursor containing a list of start and end days for 2031 * events 2032 */ 2033 public static final Cursor query(ContentResolver cr, int startDay, int numDays, 2034 String[] projection) { 2035 if (numDays < 1) { 2036 return null; 2037 } 2038 int endDay = startDay + numDays - 1; 2039 Uri.Builder builder = CONTENT_URI.buildUpon(); 2040 ContentUris.appendId(builder, startDay); 2041 ContentUris.appendId(builder, endDay); 2042 return cr.query(builder.build(), projection, SELECTION, 2043 null /* selection args */, STARTDAY); 2044 } 2045 } 2046 2047 protected interface RemindersColumns { 2048 /** 2049 * The event the reminder belongs to. Column name. 2050 * <P>Type: INTEGER (foreign key to the Events table)</P> 2051 */ 2052 public static final String EVENT_ID = "event_id"; 2053 2054 /** 2055 * The minutes prior to the event that the alarm should ring. -1 2056 * specifies that we should use the default value for the system. 2057 * Column name. 2058 * <P>Type: INTEGER</P> 2059 */ 2060 public static final String MINUTES = "minutes"; 2061 2062 /** 2063 * Passing this as a minutes value will use the default reminder 2064 * minutes. 2065 */ 2066 public static final int MINUTES_DEFAULT = -1; 2067 2068 /** 2069 * The alarm method, as set on the server. {@link #METHOD_DEFAULT}, 2070 * {@link #METHOD_ALERT}, {@link #METHOD_EMAIL}, {@link #METHOD_SMS} and 2071 * {@link #METHOD_ALARM} are possible values; the device will only 2072 * process {@link #METHOD_DEFAULT} and {@link #METHOD_ALERT} reminders 2073 * (the other types are simply stored so we can send the same reminder 2074 * info back to the server when we make changes). 2075 */ 2076 public static final String METHOD = "method"; 2077 2078 public static final int METHOD_DEFAULT = 0; 2079 public static final int METHOD_ALERT = 1; 2080 public static final int METHOD_EMAIL = 2; 2081 public static final int METHOD_SMS = 3; 2082 public static final int METHOD_ALARM = 4; 2083 } 2084 2085 /** 2086 * Fields and helpers for accessing reminders for an event. Each row of this 2087 * table represents a single reminder for an event. Calling 2088 * {@link #query(ContentResolver, long, String[])} will return a list of reminders for 2089 * the event with the given eventId. Both apps and sync adapters may write 2090 * to this table. There are three writable fields and all of them must be 2091 * included when inserting a new reminder. They are: 2092 * <ul> 2093 * <li>{@link #EVENT_ID}</li> 2094 * <li>{@link #MINUTES}</li> 2095 * <li>{@link #METHOD}</li> 2096 * </ul> 2097 */ 2098 public static final class Reminders implements BaseColumns, RemindersColumns, EventsColumns { 2099 private static final String REMINDERS_WHERE = CalendarContract.Reminders.EVENT_ID + "=?"; 2100 @SuppressWarnings("hiding") 2101 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/reminders"); 2102 2103 /** 2104 * This utility class cannot be instantiated 2105 */ 2106 private Reminders() {} 2107 2108 /** 2109 * Queries all reminders associated with the given event. This is a 2110 * blocking call and should not be done on the UI thread. 2111 * 2112 * @param cr The content resolver to use for the query 2113 * @param eventId The id of the event to retrieve reminders for 2114 * @param projection the columns to return in the cursor 2115 * @return A Cursor containing all reminders for the event 2116 */ 2117 public static final Cursor query(ContentResolver cr, long eventId, String[] projection) { 2118 String[] remArgs = {Long.toString(eventId)}; 2119 return cr.query(CONTENT_URI, projection, REMINDERS_WHERE, remArgs /*selection args*/, 2120 null /* sort order */); 2121 } 2122 } 2123 2124 protected interface CalendarAlertsColumns { 2125 /** 2126 * The event that the alert belongs to. Column name. 2127 * <P>Type: INTEGER (foreign key to the Events table)</P> 2128 */ 2129 public static final String EVENT_ID = "event_id"; 2130 2131 /** 2132 * The start time of the event, in UTC. Column name. 2133 * <P>Type: INTEGER (long; millis since epoch)</P> 2134 */ 2135 public static final String BEGIN = "begin"; 2136 2137 /** 2138 * The end time of the event, in UTC. Column name. 2139 * <P>Type: INTEGER (long; millis since epoch)</P> 2140 */ 2141 public static final String END = "end"; 2142 2143 /** 2144 * The alarm time of the event, in UTC. Column name. 2145 * <P>Type: INTEGER (long; millis since epoch)</P> 2146 */ 2147 public static final String ALARM_TIME = "alarmTime"; 2148 2149 /** 2150 * The creation time of this database entry, in UTC. 2151 * Useful for debugging missed reminders. Column name. 2152 * <P>Type: INTEGER (long; millis since epoch)</P> 2153 */ 2154 public static final String CREATION_TIME = "creationTime"; 2155 2156 /** 2157 * The time that the alarm broadcast was received by the Calendar app, 2158 * in UTC. Useful for debugging missed reminders. Column name. 2159 * <P>Type: INTEGER (long; millis since epoch)</P> 2160 */ 2161 public static final String RECEIVED_TIME = "receivedTime"; 2162 2163 /** 2164 * The time that the notification was created by the Calendar app, 2165 * in UTC. Useful for debugging missed reminders. Column name. 2166 * <P>Type: INTEGER (long; millis since epoch)</P> 2167 */ 2168 public static final String NOTIFY_TIME = "notifyTime"; 2169 2170 /** 2171 * The state of this alert. It starts out as {@link #STATE_SCHEDULED}, then 2172 * when the alarm goes off, it changes to {@link #STATE_FIRED}, and then when 2173 * the user dismisses the alarm it changes to {@link #STATE_DISMISSED}. Column 2174 * name. 2175 * <P>Type: INTEGER</P> 2176 */ 2177 public static final String STATE = "state"; 2178 2179 /** 2180 * An alert begins in this state when it is first created. 2181 */ 2182 public static final int STATE_SCHEDULED = 0; 2183 /** 2184 * After a notification for an alert has been created it should be 2185 * updated to fired. 2186 */ 2187 public static final int STATE_FIRED = 1; 2188 /** 2189 * Once the user has dismissed the notification the alert's state should 2190 * be set to dismissed so it is not fired again. 2191 */ 2192 public static final int STATE_DISMISSED = 2; 2193 2194 /** 2195 * The number of minutes that this alarm precedes the start time. Column 2196 * name. 2197 * <P>Type: INTEGER</P> 2198 */ 2199 public static final String MINUTES = "minutes"; 2200 2201 /** 2202 * The default sort order for this alerts queries 2203 */ 2204 public static final String DEFAULT_SORT_ORDER = "begin ASC,title ASC"; 2205 } 2206 2207 /** 2208 * Fields and helpers for accessing calendar alerts information. These 2209 * fields are for tracking which alerts have been fired. Scheduled alarms 2210 * will generate an intent using {@link #ACTION_EVENT_REMINDER}. Apps that 2211 * receive this action may update the {@link #STATE} for the reminder when 2212 * they have finished handling it. Apps that have their notifications 2213 * disabled should not modify the table to ensure that they do not conflict 2214 * with another app that is generating a notification. In general, apps 2215 * should not need to write to this table directly except to update the 2216 * state of a reminder. 2217 */ 2218 public static final class CalendarAlerts implements BaseColumns, 2219 CalendarAlertsColumns, EventsColumns, CalendarColumns { 2220 2221 /** 2222 * @hide 2223 */ 2224 public static final String TABLE_NAME = "CalendarAlerts"; 2225 /** 2226 * The Uri for querying calendar alert information 2227 */ 2228 @SuppressWarnings("hiding") 2229 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + 2230 "/calendar_alerts"); 2231 2232 /** 2233 * This utility class cannot be instantiated 2234 */ 2235 private CalendarAlerts() {} 2236 2237 private static final String WHERE_ALARM_EXISTS = EVENT_ID + "=?" 2238 + " AND " + BEGIN + "=?" 2239 + " AND " + ALARM_TIME + "=?"; 2240 2241 private static final String WHERE_FINDNEXTALARMTIME = ALARM_TIME + ">=?"; 2242 private static final String SORT_ORDER_ALARMTIME_ASC = ALARM_TIME + " ASC"; 2243 2244 private static final String WHERE_RESCHEDULE_MISSED_ALARMS = STATE + "=" + STATE_SCHEDULED 2245 + " AND " + ALARM_TIME + "<?" 2246 + " AND " + ALARM_TIME + ">?" 2247 + " AND " + END + ">=?"; 2248 2249 /** 2250 * This URI is for grouping the query results by event_id and begin 2251 * time. This will return one result per instance of an event. So 2252 * events with multiple alarms will appear just once, but multiple 2253 * instances of a repeating event will show up multiple times. 2254 */ 2255 public static final Uri CONTENT_URI_BY_INSTANCE = 2256 Uri.parse("content://" + AUTHORITY + "/calendar_alerts/by_instance"); 2257 2258 private static final boolean DEBUG = false; 2259 2260 /** 2261 * Helper for inserting an alarm time associated with an event TODO move 2262 * to Provider 2263 * 2264 * @hide 2265 */ 2266 public static final Uri insert(ContentResolver cr, long eventId, 2267 long begin, long end, long alarmTime, int minutes) { 2268 ContentValues values = new ContentValues(); 2269 values.put(CalendarAlerts.EVENT_ID, eventId); 2270 values.put(CalendarAlerts.BEGIN, begin); 2271 values.put(CalendarAlerts.END, end); 2272 values.put(CalendarAlerts.ALARM_TIME, alarmTime); 2273 long currentTime = System.currentTimeMillis(); 2274 values.put(CalendarAlerts.CREATION_TIME, currentTime); 2275 values.put(CalendarAlerts.RECEIVED_TIME, 0); 2276 values.put(CalendarAlerts.NOTIFY_TIME, 0); 2277 values.put(CalendarAlerts.STATE, STATE_SCHEDULED); 2278 values.put(CalendarAlerts.MINUTES, minutes); 2279 return cr.insert(CONTENT_URI, values); 2280 } 2281 2282 /** 2283 * Finds the next alarm after (or equal to) the given time and returns 2284 * the time of that alarm or -1 if no such alarm exists. This is a 2285 * blocking call and should not be done on the UI thread. TODO move to 2286 * provider 2287 * 2288 * @param cr the ContentResolver 2289 * @param millis the time in UTC milliseconds 2290 * @return the next alarm time greater than or equal to "millis", or -1 2291 * if no such alarm exists. 2292 * @hide 2293 */ 2294 public static final long findNextAlarmTime(ContentResolver cr, long millis) { 2295 String selection = ALARM_TIME + ">=" + millis; 2296 // TODO: construct an explicit SQL query so that we can add 2297 // "LIMIT 1" to the end and get just one result. 2298 String[] projection = new String[] { ALARM_TIME }; 2299 Cursor cursor = cr.query(CONTENT_URI, projection, WHERE_FINDNEXTALARMTIME, 2300 (new String[] { 2301 Long.toString(millis) 2302 }), SORT_ORDER_ALARMTIME_ASC); 2303 long alarmTime = -1; 2304 try { 2305 if (cursor != null && cursor.moveToFirst()) { 2306 alarmTime = cursor.getLong(0); 2307 } 2308 } finally { 2309 if (cursor != null) { 2310 cursor.close(); 2311 } 2312 } 2313 return alarmTime; 2314 } 2315 2316 /** 2317 * Searches the CalendarAlerts table for alarms that should have fired 2318 * but have not and then reschedules them. This method can be called at 2319 * boot time to restore alarms that may have been lost due to a phone 2320 * reboot. TODO move to provider 2321 * 2322 * @param cr the ContentResolver 2323 * @param context the Context 2324 * @param manager the AlarmManager 2325 * @hide 2326 */ 2327 public static final void rescheduleMissedAlarms(ContentResolver cr, 2328 Context context, AlarmManager manager) { 2329 // Get all the alerts that have been scheduled but have not fired 2330 // and should have fired by now and are not too old. 2331 long now = System.currentTimeMillis(); 2332 long ancient = now - DateUtils.DAY_IN_MILLIS; 2333 String[] projection = new String[] { 2334 ALARM_TIME, 2335 }; 2336 2337 // TODO: construct an explicit SQL query so that we can add 2338 // "GROUPBY" instead of doing a sort and de-dup 2339 Cursor cursor = cr.query(CalendarAlerts.CONTENT_URI, projection, 2340 WHERE_RESCHEDULE_MISSED_ALARMS, (new String[] { 2341 Long.toString(now), Long.toString(ancient), Long.toString(now) 2342 }), SORT_ORDER_ALARMTIME_ASC); 2343 if (cursor == null) { 2344 return; 2345 } 2346 2347 if (DEBUG) { 2348 Log.d(TAG, "missed alarms found: " + cursor.getCount()); 2349 } 2350 2351 try { 2352 long alarmTime = -1; 2353 2354 while (cursor.moveToNext()) { 2355 long newAlarmTime = cursor.getLong(0); 2356 if (alarmTime != newAlarmTime) { 2357 if (DEBUG) { 2358 Log.w(TAG, "rescheduling missed alarm. alarmTime: " + newAlarmTime); 2359 } 2360 scheduleAlarm(context, manager, newAlarmTime); 2361 alarmTime = newAlarmTime; 2362 } 2363 } 2364 } finally { 2365 cursor.close(); 2366 } 2367 } 2368 2369 /** 2370 * Schedules an alarm intent with the system AlarmManager that will 2371 * notify listeners when a reminder should be fired. The provider will 2372 * keep scheduled reminders up to date but apps may use this to 2373 * implement snooze functionality without modifying the reminders table. 2374 * Scheduled alarms will generate an intent using 2375 * {@link #ACTION_EVENT_REMINDER}. TODO Move to provider 2376 * 2377 * @param context A context for referencing system resources 2378 * @param manager The AlarmManager to use or null 2379 * @param alarmTime The time to fire the intent in UTC millis since 2380 * epoch 2381 * @hide 2382 */ 2383 public static void scheduleAlarm(Context context, AlarmManager manager, long alarmTime) { 2384 if (DEBUG) { 2385 Time time = new Time(); 2386 time.set(alarmTime); 2387 String schedTime = time.format(" %a, %b %d, %Y %I:%M%P"); 2388 Log.d(TAG, "Schedule alarm at " + alarmTime + " " + schedTime); 2389 } 2390 2391 if (manager == null) { 2392 manager = (AlarmManager) context.getSystemService(Context.ALARM_SERVICE); 2393 } 2394 2395 Intent intent = new Intent(ACTION_EVENT_REMINDER); 2396 intent.setData(ContentUris.withAppendedId(CalendarContract.CONTENT_URI, alarmTime)); 2397 intent.putExtra(ALARM_TIME, alarmTime); 2398 PendingIntent pi = PendingIntent.getBroadcast(context, 0, intent, 0); 2399 manager.set(AlarmManager.RTC_WAKEUP, alarmTime, pi); 2400 } 2401 2402 /** 2403 * Searches for an entry in the CalendarAlerts table that matches the 2404 * given event id, begin time and alarm time. If one is found then this 2405 * alarm already exists and this method returns true. TODO Move to 2406 * provider 2407 * 2408 * @param cr the ContentResolver 2409 * @param eventId the event id to match 2410 * @param begin the start time of the event in UTC millis 2411 * @param alarmTime the alarm time of the event in UTC millis 2412 * @return true if there is already an alarm for the given event with 2413 * the same start time and alarm time. 2414 * @hide 2415 */ 2416 public static final boolean alarmExists(ContentResolver cr, long eventId, 2417 long begin, long alarmTime) { 2418 // TODO: construct an explicit SQL query so that we can add 2419 // "LIMIT 1" to the end and get just one result. 2420 String[] projection = new String[] { ALARM_TIME }; 2421 Cursor cursor = cr.query(CONTENT_URI, projection, WHERE_ALARM_EXISTS, 2422 (new String[] { 2423 Long.toString(eventId), Long.toString(begin), Long.toString(alarmTime) 2424 }), null); 2425 boolean found = false; 2426 try { 2427 if (cursor != null && cursor.getCount() > 0) { 2428 found = true; 2429 } 2430 } finally { 2431 if (cursor != null) { 2432 cursor.close(); 2433 } 2434 } 2435 return found; 2436 } 2437 } 2438 2439 protected interface ColorsColumns extends SyncStateContract.Columns { 2440 2441 /** 2442 * The type of color, which describes how it should be used. Valid types 2443 * are {@link #TYPE_CALENDAR} and {@link #TYPE_EVENT}. Column name. 2444 * <P> 2445 * Type: INTEGER (NOT NULL) 2446 * </P> 2447 */ 2448 public static final String COLOR_TYPE = "color_type"; 2449 2450 /** 2451 * This indicateds a color that can be used for calendars. 2452 */ 2453 public static final int TYPE_CALENDAR = 0; 2454 /** 2455 * This indicates a color that can be used for events. 2456 */ 2457 public static final int TYPE_EVENT = 1; 2458 2459 /** 2460 * The key used to reference this color. This can be any non-empty 2461 * string, but must be unique for a given {@link #ACCOUNT_TYPE} and 2462 * {@link #ACCOUNT_NAME}. Column name. 2463 * <P> 2464 * Type: TEXT 2465 * </P> 2466 */ 2467 public static final String COLOR_KEY = "color_index"; 2468 2469 /** 2470 * The color as an 8-bit ARGB integer value. Colors should specify alpha 2471 * as fully opaque (eg 0xFF993322) as the alpha may be ignored or 2472 * modified for display. It is reccomended that colors be usable with 2473 * light (near white) text. Apps should not depend on that assumption, 2474 * however. Column name. 2475 * <P> 2476 * Type: INTEGER (NOT NULL) 2477 * </P> 2478 */ 2479 public static final String COLOR = "color"; 2480 2481 } 2482 2483 /** 2484 * Fields for accessing colors available for a given account. Colors are 2485 * referenced by {@link #COLOR_KEY} which must be unique for a given 2486 * account name/type. These values can only be updated by the sync 2487 * adapter. Only {@link #COLOR} may be updated after the initial insert. In 2488 * addition, a row can only be deleted once all references to that color 2489 * have been removed from the {@link Calendars} or {@link Events} tables. 2490 */ 2491 public static final class Colors implements ColorsColumns { 2492 /** 2493 * @hide 2494 */ 2495 public static final String TABLE_NAME = "Colors"; 2496 /** 2497 * The Uri for querying color information 2498 */ 2499 @SuppressWarnings("hiding") 2500 public static final Uri CONTENT_URI = Uri.parse("content://" + AUTHORITY + "/colors"); 2501 2502 /** 2503 * This utility class cannot be instantiated 2504 */ 2505 private Colors() { 2506 } 2507 } 2508 2509 protected interface ExtendedPropertiesColumns { 2510 /** 2511 * The event the extended property belongs to. Column name. 2512 * <P>Type: INTEGER (foreign key to the Events table)</P> 2513 */ 2514 public static final String EVENT_ID = "event_id"; 2515 2516 /** 2517 * The name of the extended property. This is a uri of the form 2518 * {scheme}#{local-name} convention. Column name. 2519 * <P>Type: TEXT</P> 2520 */ 2521 public static final String NAME = "name"; 2522 2523 /** 2524 * The value of the extended property. Column name. 2525 * <P>Type: TEXT</P> 2526 */ 2527 public static final String VALUE = "value"; 2528 } 2529 2530 /** 2531 * Fields for accessing the Extended Properties. This is a generic set of 2532 * name/value pairs for use by sync adapters to add extra 2533 * information to events. There are three writable columns and all three 2534 * must be present when inserting a new value. They are: 2535 * <ul> 2536 * <li>{@link #EVENT_ID}</li> 2537 * <li>{@link #NAME}</li> 2538 * <li>{@link #VALUE}</li> 2539 * </ul> 2540 */ 2541 public static final class ExtendedProperties implements BaseColumns, 2542 ExtendedPropertiesColumns, EventsColumns { 2543 public static final Uri CONTENT_URI = 2544 Uri.parse("content://" + AUTHORITY + "/extendedproperties"); 2545 2546 /** 2547 * This utility class cannot be instantiated 2548 */ 2549 private ExtendedProperties() {} 2550 2551 // TODO: fill out this class when we actually start utilizing extendedproperties 2552 // in the calendar application. 2553 } 2554 2555 /** 2556 * A table provided for sync adapters to use for storing private sync state data. 2557 * 2558 * @see SyncStateContract 2559 */ 2560 public static final class SyncState implements SyncStateContract.Columns { 2561 /** 2562 * This utility class cannot be instantiated 2563 */ 2564 private SyncState() {} 2565 2566 private static final String CONTENT_DIRECTORY = 2567 SyncStateContract.Constants.CONTENT_DIRECTORY; 2568 2569 /** 2570 * The content:// style URI for this table 2571 */ 2572 public static final Uri CONTENT_URI = 2573 Uri.withAppendedPath(CalendarContract.CONTENT_URI, CONTENT_DIRECTORY); 2574 } 2575 2576 /** 2577 * Columns from the EventsRawTimes table 2578 * 2579 * @hide 2580 */ 2581 protected interface EventsRawTimesColumns { 2582 /** 2583 * The corresponding event id. Column name. 2584 * <P>Type: INTEGER (long)</P> 2585 */ 2586 public static final String EVENT_ID = "event_id"; 2587 2588 /** 2589 * The RFC2445 compliant time the event starts. Column name. 2590 * <P>Type: TEXT</P> 2591 */ 2592 public static final String DTSTART_2445 = "dtstart2445"; 2593 2594 /** 2595 * The RFC2445 compliant time the event ends. Column name. 2596 * <P>Type: TEXT</P> 2597 */ 2598 public static final String DTEND_2445 = "dtend2445"; 2599 2600 /** 2601 * The RFC2445 compliant original instance time of the recurring event 2602 * for which this event is an exception. Column name. 2603 * <P>Type: TEXT</P> 2604 */ 2605 public static final String ORIGINAL_INSTANCE_TIME_2445 = "originalInstanceTime2445"; 2606 2607 /** 2608 * The RFC2445 compliant last date this event repeats on, or NULL if it 2609 * never ends. Column name. 2610 * <P>Type: TEXT</P> 2611 */ 2612 public static final String LAST_DATE_2445 = "lastDate2445"; 2613 } 2614 2615 /** 2616 * @hide 2617 */ 2618 public static final class EventsRawTimes implements BaseColumns, EventsRawTimesColumns { 2619 2620 /** 2621 * This utility class cannot be instantiated 2622 */ 2623 private EventsRawTimes() {} 2624 } 2625} 2626