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