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