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