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
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
|
[
{
"namespace": "extension",
"unprivileged": true,
"types": [
{
"id": "MessageSender",
"type": "object",
"description": "An object containing information about the script context that sent a message or request.",
"properties": {
"tab": {"$ref": "Tab", "optional": true, "description":"This property will <b>only</b> be present when the connection was opened from a tab or content script."},
"id": {"type": "string", "description": "The extension ID of the extension that opened the connection."}
}
},
{
"id": "Event",
"type": "object",
"description": "An object which allows the addition and removal of listeners for a Chrome event.",
"properties": {
"addListener": {"type": "function"},
"removeListener": {"type": "function"},
"hasListener": {"type": "function"},
"hasListeners": {"type": "function"}
},
"additionalProperties": { "type": "any"}
},
{
"id": "Port",
"type": "object",
"description": "An object which allows two way communication with other pages.",
"properties": {
"name": {"type": "string"},
"onDisconnect": { "$ref": "Event" },
"onMessage": { "$ref": "Event" },
"postMessage": {"type": "function"},
"sender": {
"$ref": "MessageSender",
"optional": true,
"description": "This property will <b>only</b> be present on ports passed to onConnect/onConnectExternal listeners."
}
},
"additionalProperties": { "type": "any"}
}
],
"properties": {
"lastError": {
"type": "object",
"optional": true,
"unprivileged": true,
"description": "Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var>undefined</var>.",
"properties": {
"message": { "type": "string", "description": "Description of the error that has taken place." }
}
},
"inIncognitoContext": {
"type": "boolean",
"optional": true,
"unprivileged": true,
"description": "True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior."
}
},
"functions": [
{
"name": "connect",
"type": "function",
"unprivileged": true,
"description": "Attempts to connect to other listeners within the extension (such as the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via <a href='tabs.html#method-connect'><code>chrome.tabs.connect()</code></a>.",
"parameters": [
{"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."},
{
"type": "object",
"name": "connectInfo",
"properties": {
"name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for extension processes that are listening for the connection event." }
},
"optional": true
}
],
"returns": {
"$ref": "Port",
"description": "Port through which messages can be sent and received with the extension. The port's <a href='extension.html#type-Port'>onDisconnect</a> event is fired if extension does not exist. "
}
},
{
"name": "sendRequest",
"type": "function",
"unprivileged": true,
"description": "Sends a single request to other listeners within the extension. Similar to chrome.extension.connect, but only sends a single request with an optional response. The <a href='extension.html#event-onRequest'>chrome.extension.onRequest</a> event is fired in each page of the extension.",
"parameters": [
{"type": "string", "name": "extensionId", "optional": true, "description": "The extension ID of the extension you want to connect to. If omitted, default is your own extension."},
{ "type": "any", "name": "request" },
{
"type": "function",
"name": "responseCallback",
"optional": true,
"parameters": [
{
"name": "response",
"type": "any",
"description": "The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and <a href='extension.html#property-lastError'>chrome.extension.lastError</a> will be set to the error message."
}
]
}
]
},
{
"name": "getURL",
"type": "function",
"unprivileged": true,
"description": "Converts a relative path within an extension install directory to a fully-qualified URL.",
"parameters": [
{
"type": "string",
"name": "path",
"description": "A path to a resource within an extension expressed relative to its install directory."
}
],
"returns": {
"type": "string",
"description": "The fully-qualified URL to the resource."
}
},
{
"name": "getViews",
"type": "function",
"description": "Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.",
"parameters": [
{
"type": "object",
"name": "fetchProperties",
"optional": true,
"properties": {
"type": {
"type": "string",
"enum": ["tab", "infobar", "notification", "popup"],
"optional": true,
"description": "The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'popup'."
},
"windowId": {
"type": "integer",
"optional": true,
"description": "The window to restrict the search to. If omitted, returns all views."
}
}
}
],
"returns": {
"type": "array",
"description": "Array of global objects",
"items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } }
}
},
{
"name": "getBackgroundPage",
"type": "function",
"description": "Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.",
"parameters": [],
"returns": {
"type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" }
}
},
{
"name": "getToolstrips",
"nodoc": true,
"type": "function",
"description": "Deprecated. Please use getViews({type: 'TOOLSTRIP'}). Returns an array of the JavaScript 'window' objects for each of the toolstrip views running inside the current extension. If windowId is specified, returns only the 'window' objects of toolstrips attached to the specified window.",
"parameters": [
{"type": "integer", "name": "windowId", "optional": true}
],
"returns": {
"type": "array",
"description": "Array of global window objects",
"items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } }
}
},
{
"name": "getExtensionTabs",
"nodoc": true,
"type": "function",
"description": "Deprecated. Please use getViews({type: 'TAB'}). Returns an array of the JavaScript 'window' objects for each of the tabs running inside the current extension. If windowId is specified, returns only the 'window' objects of tabs attached to the specified window.",
"parameters": [
{"type": "integer", "name": "windowId", "optional": true}
],
"returns": {
"type": "array",
"description": "Array of global window objects",
"items": { "type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" } }
}
},
{
"name": "isAllowedIncognitoAccess",
"type": "function",
"description": "Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.",
"min_version": "12.0.706.0",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "isAllowedAccess",
"type": "boolean",
"description": "True if the extension has access to Incognito mode, false otherwise."
}
]
}
]
},
{
"name": "isAllowedFileSchemeAccess",
"type": "function",
"description": "Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.",
"min_version": "12.0.706.0",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "isAllowedAccess",
"type": "boolean",
"description": "True if the extension can access the 'file://' scheme, false otherwise."
}
]
}
]
},
{
"name": "setUpdateUrlData",
"type": "function",
"description": "Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the Chrome Extension Gallery.",
"parameters": [
{"type": "string", "name": "data", "maxLength": 1024}
]
}
],
"events": [
{
"name": "onConnect",
"type": "function",
"unprivileged": true,
"description": "Fired when a connection is made from either an extension process or a content script.",
"parameters": [
{"$ref": "Port", "name": "port"}
]
},
{
"name": "onConnectExternal",
"type": "function",
"description": "Fired when a connection is made from another extension.",
"parameters": [
{"$ref": "Port", "name": "port"}
]
},
{
"name": "onRequest",
"type": "function",
"unprivileged": true,
"description": "Fired when a request is sent from either an extension process or a content script.",
"parameters": [
{"name": "request", "type": "any", "description": "The request sent by the calling script."},
{"name": "sender", "$ref": "MessageSender" },
{"name": "sendResponse", "type": "function", "description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response." }
]
},
{
"name": "onRequestExternal",
"type": "function",
"description": "Fired when a request is sent from another extension.",
"parameters": [
{"name": "request", "type": "any", "description": "The request sent by the calling script."},
{"name": "sender", "$ref": "MessageSender" },
{"name": "sendResponse", "type": "function", "description": "Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response." }
]
}
]
},
{
"namespace": "experimental.accessibility",
"nodoc": true,
"types": [
{
"id": "AccessibilityObject",
"type": "object",
"description": "Parent class for accessibility information about an object.",
"properties": {
"type": {
"type": "string",
"description": "The type of this object, which determines the contents of 'details'.",
"enum": ["button", "checkbox", "combobox", "link", "menu", "menuitem", "radiobutton", "tab", "textbox", "window"]
},
"name": {
"type": "string",
"description": "The localized name of the object, like OK or Password. Do not rely on an exact string match because the text will be in the user's language and may change in the future."
},
"details": {
"description": "Other details like the state, depending on the type of object.",
"optional": true,
"choices": [
{ "$ref": "CheckboxDetails" },
{ "$ref": "ComboBoxDetails" },
{ "$ref": "MenuDetails" },
{ "$ref": "MenuItemDetails" },
{ "$ref": "RadioButtonDetails" },
{ "$ref": "TabDetails" },
{ "$ref": "TextBoxDetails" }
]
}
}
},
{
"id": "CheckboxDetails",
"type": "object",
"description": "Information about the state of a checkbox.",
"properties": {
"isChecked": {"type": "boolean", "description": "True if this checkbox is checked."}
}
},
{
"id": "ComboBoxDetails",
"type": "object",
"description": "Information about the state of a combo box.",
"properties": {
"value": {"type": "string", "description": "The value of the combo box."},
"itemCount": {"type": "integer", "description": "The number of items in the combo box's list."},
"itemIndex": {"type": "integer", "description": "The 0-based index of the current value, or -1 if the user entered a value not from the list."}
}
},
{
"id": "ListBoxDetails",
"type": "object",
"description": "Information about the state of a list box.",
"properties": {
"value": {"type": "string", "description": "The value of the list box."},
"itemCount": {"type": "integer", "description": "The number of items in the list."},
"itemIndex": {"type": "integer", "description": "The 0-based index of the selected value, or -1 if no items are selected."}
}
},
{
"id": "MenuDetails",
"type": "object",
"description": "Information about the state of a drop-down menu.",
"properties": {
}
},
{
"id": "MenuItemDetails",
"type": "object",
"description": "Information about a menu item.",
"properties": {
"hasSubmenu": {"type": "boolean", "description": "True if this item opens a submenu."},
"itemCount": {"type": "integer", "description": "The number of items in the menu."},
"itemIndex": {"type": "integer", "description": "The 0-based index of this menu item."}
}
},
{
"id": "RadioButtonDetails",
"type": "object",
"description": "Information about the state of a radio button.",
"properties": {
"isChecked": {"type": "boolean", "description": "True if this radio button is checked."},
"itemCount": {"type": "integer", "description": "The number of radio buttons in this group."},
"itemIndex": {"type": "integer", "description": "The 0-based index of this radio button in this group."}
}
},
{
"id": "TabDetails",
"type": "object",
"description": "Additional accessibility information about a tab.",
"properties": {
"itemCount": {"type": "integer", "description": "The number of tabs in this group."},
"itemIndex": {"type": "integer", "description": "The 0-based index of this tab in this group."}
}
},
{
"id": "TextBoxDetails",
"type": "object",
"description": "Information about the state of a text box.",
"properties": {
"value": {"type": "string", "description": "The value of the text box - the entered text."},
"isPassword": {"type": "boolean", "description": "True if this control contains password text whose contents should be obscured."},
"selectionStart": {"type": "integer", "description": "The index of the character where the selection starts, if this control contains editable text."},
"selectionEnd": {"type": "integer", "description": "The index of the character where the selection ends, if this control contains editable text."}
}
}
],
"functions": [
{
"name": "setAccessibilityEnabled",
"type": "function",
"description": "Enable or disable the accessibility extension api. This must be set to true before event listeners or getFocusedControl will work.",
"parameters": [
{
"type": "boolean",
"name": "enabled",
"description": "True if accessibility support should be enabled."
}
]
},
{
"name": "getFocusedControl",
"type": "function",
"description": "Get information about the currently focused control.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "control",
"description": "Details of the currently focused control, or null if nothing is focused.",
"choices": [
{ "$ref": "AccessibilityObject" },
{ "type": "null" }
]
}
]
}
]
}
],
"events": [
{
"name": "onWindowOpened",
"type": "function",
"description": "Fired when a window is opened.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "window",
"description": "Information about the window that was opened."
}
]
},
{
"name": "onWindowClosed",
"type": "function",
"description": "Fired when a window is closed.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "window",
"description": "Information about the window that was closed."
}
]
},
{
"name": "onControlFocused",
"type": "function",
"description": "Fired when a control is focused.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "control",
"description": "Details of the control that was focused."
}
]
},
{
"name": "onControlAction",
"type": "function",
"description": "Fired when a control's action is taken, like pressing a button or toggling a checkbox.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "control",
"description": "Details of the control whose action was taken."
}
]
},
{
"name": "onTextChanged",
"type": "function",
"description": "Fired when text changes in an editable text control.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "control",
"description": "Details of the control where the text changed."
}
]
},
{
"name": "onMenuOpened",
"type": "function",
"description": "Fired when a menu is opened.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "menu",
"description": "Information about the menu that was opened."
}
]
},
{
"name": "onMenuClosed",
"type": "function",
"description": "Fired when a menu is closed.",
"parameters": [
{
"$ref": "AccessibilityObject",
"name": "menu",
"description": "Information about the menu that was closed."
}
]
}
]
},
{
"namespace": "experimental.tts",
"functions": [
{
"name": "speak",
"type": "function",
"description": "Speak text using a text-to-speech engine.",
"parameters": [
{
"type": "string",
"name": "utterance",
"description": "The text to speak. May include SSML markup."
},
{
"type": "object",
"name": "options",
"optional": true,
"description": "The speech options.",
"properties": {
"enqueue": {
"type": "boolean",
"optional": true,
"description": "If true, enqueues this utterance if TTS is already in progress. If false (the default), interrupts any current speech and flushes the speech queue before speaking this new utterance."
},
"voiceName": {
"type": "string",
"optional": true,
"description": "The name of the voice to use for synthesis. If empty, uses any available voice."
},
"locale": {
"type": "string",
"optional": true,
"description": "The language and optional region code that specify the language and dialect to be used for synthesis, in the form <language>-<region>. Examples: 'en', 'en-US', 'en-GB', 'zh-CN', etc."
},
"gender": {
"type": "string",
"optional": true,
"description": "Gender of voice for synthesized speech.",
"enum": ["male", "female"]
},
"rate": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking speed between 0 and 1 inclusive, with 0 being slowest and 1 being fastest, with a default of 0.5."
},
"pitch": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking pitch between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 0.5."
},
"volume": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest, with a default of 1.0."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when speaking is finished.",
"parameters": []
}
]
},
{
"name": "stop",
"type": "function",
"description": "Stop any current speech.",
"parameters": []
},
{
"name": "isSpeaking",
"type": "function",
"description": "Check if the engine is currently speaking.",
"parameters": [
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "speaking",
"type": "boolean",
"description": "True if speaking, false otherwise."
}
]
}
]
},
{
"name": "speakCompleted",
"nodoc": true,
"type": "function",
"description": "A callback passed to the onSpeak event.",
"parameters": [
{
"type": "integer",
"name": "requestId"
},
{
"type": "string",
"optional": "true",
"name": "errorMessage"
}
]
}
],
"events": [
{
"name": "onSpeak",
"type": "function",
"description": "Called when the user makes a call to tts.speak and the options matches one of the tts_voices from this extension's manifest.",
"parameters": [
{
"type": "string",
"name": "utterance",
"description": "The text to speak. This may include SSML, so if your engine does not support SSML, you should strip out all XML markup and synthesize only the underlying text content."
},
{
"type": "object",
"name": "options",
"description": "The speak options.",
"properties": {
"voiceName": {
"type": "string",
"optional": true,
"description": "The name of the voice to use for synthesis."
},
"locale": {
"type": "string",
"optional": true,
"description": "The language and region code that specify the language and dialect to be used for synthesis, in the form <language>-<region>, e.g. en-US, en-GB, fr-CA, zh-CN, etc."
},
"gender": {
"type": "string",
"optional": true,
"description": "Gender of voice for synthesized speech.",
"enum": ["male", "female"]
},
"rate": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking speed between 0 and 1 inclusive, with 0 being slowest and 1 being fastest."
},
"pitch": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking pitch between 0 and 1 inclusive, with 0 being lowest and 1 being highest."
},
"volume": {
"type": "number",
"optional": true,
"minimum": 0,
"maximum": 1,
"description": "Speaking volume between 0 and 1 inclusive, with 0 being lowest and 1 being highest."
}
}
},
{
"type": "function",
"name": "callback",
"description": "You must call this function when speaking is finished.",
"parameters": [
{
"type": "string",
"name": "error",
"optional": true,
"description": "Error message, which will be returned to the caller in chrome.extension.lastError."
}
]
}
]
},
{
"name": "onStop",
"type": "function",
"description": "Fired when a call is made to tts.stop and this extension may be in the middle of speaking. If an extension receives a call to onStop and speech is already stopped, it should do nothing (not raise an error)."
}
]
},
{
"namespace": "windows",
"types": [
{
"id": "Window",
"type": "object",
"properties": {
"id": {"type": "integer", "minimum": 0, "description": "The ID of the window. Window IDs are unique within a browser session."},
"focused": {"type": "boolean", "description": "Whether the window is currently the focused window."},
"top": {"type": "integer", "description": "The offset of the window from the top edge of the screen in pixels."},
"left": {"type": "integer", "description": "The offset of the window from the left edge of the screen in pixels."},
"width": {"type": "integer", "description": "The width of the window in pixels."},
"height": {"type": "integer", "description": "The height of the window in pixels."},
"tabs": {"type": "array", "items": { "$ref": "Tab" }, "optional": true, "description": "Array of $ref:Tab objects representing the current tabs in the window."},
"incognito": {"type": "boolean", "description": "Whether the window is incognito."},
"type": {
"type": "string",
"description": "The type of browser window this is. The 'panel' type requires the 'experimental' permission.",
"enum": ["normal", "popup", "panel", "app"]
}
}
}
],
"properties": {
"WINDOW_ID_NONE": {
"type": "integer",
"value": "-1",
"description": "The windowId value that represents the absence of a chrome browser window."
}
},
"functions": [
{
"name": "get",
"type": "function",
"description": "Gets details about a window.",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
}
]
}
]
},
{
"name": "getCurrent",
"type": "function",
"description": "Gets the <a href='#current-window'>current window</a>.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
}
]
}
]
},
{
"name": "getLastFocused",
"type": "function",
"description": "Gets the window that was most recently focused — typically the window 'on top'.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window"
}
]
}
]
},
{
"name": "getAll",
"type": "function",
"description": "Gets all windows.",
"parameters": [
{
"type": "object",
"name": "getInfo",
"optional": true,
"description": "",
"properties": {
"populate": {"type": "boolean", "optional": true, "description": "If true, each window object will have a <var>tabs</var> property that contains a list of the $ref:Tab objects for that window." }
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "windows", "type": "array", "items": { "$ref": "Window" }
}
]
}
]
},
{
"name": "create",
"type": "function",
"description": "Creates (opens) a new browser with any optional sizing, position or default URL provided.",
"parameters": [
{
"type": "object",
"name": "createData",
"properties": {
"url": {
"type": "string",
"description": "A URL or list of URLs to open as tabs in the window. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page.",
"optional": true,
"choices": [
{"type": "string"},
{"type": "array", "items": {"type": "string"}}
]
},
"tabId": {"type": "integer", "minimum": 0, "optional": true, "description": "The id of the tab for which you want to adopt to the new window."},
"left": {"type": "integer", "optional": true, "description": "The number of pixels to position the new window from the left edge of the screen. If not specified, the new window is offset naturally from the last focusd window."},
"top": {"type": "integer", "optional": true, "description": "The number of pixels to position the new window from the top edge of the screen. If not specified, the new window is offset naturally from the last focusd window."},
"width": {"type": "integer", "minimum": 0, "optional": true, "description": "The width in pixels of the new window. If not specified defaults to a natural width."},
"height": {"type": "integer", "minimum": 0, "optional": true, "description": "The height in pixels of the new window. If not specified defaults to a natural height."},
"focused": {"type": "boolean", "optional": true, "description": "If true, opens an active window. If false, opens an inactive window."},
"incognito": {"type": "boolean", "optional": true, "description": "Whether the new window should be an incognito window."},
"type": {
"type": "string",
"optional": true,
"description": "Specifies what type of browser window to create. The 'panel' type requires the 'experimental' permission.",
"enum": ["normal", "popup", "panel"]
}
},
"optional": true
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "window", "$ref": "Window", "description": "Contains details about the created window.",
"optional": true
}
]
}
]
},
{
"name": "update",
"type": "function",
"description": "Updates the properties of a window. Specify only the properties that you want to change; unspecified properties will be left unchanged.",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0},
{
"type": "object",
"name": "updateInfo",
"properties": {
"left": {"type": "integer", "optional": true, "description": "The offset from the left edge of the screen to move the window to in pixels."},
"top": {"type": "integer", "optional": true, "description": "The offset from the top edge of the screen to move the window to in pixels."},
"width": {"type": "integer", "minimum": 0, "optional": true, "description": "The width to resize the window to in pixels."},
"height": {"type": "integer", "minimum": 0, "optional": true, "description": "The height to resize the window to in pixels."},
"focused": {"type": "boolean", "optional": true, "description": "If true, brings the window to the front. If false, brings the next window in the z-order to the front."}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "window", "$ref": "Window"
}
]
}
]
},
{
"name": "remove",
"type": "function",
"description": "Removes (closes) a window, and all the tabs inside it.",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
}
],
"events": [
{
"name": "onCreated",
"type": "function",
"description": "Fired when a window is created.",
"parameters": [
{
"$ref": "Window",
"name": "window",
"description": "Details of the window that was created."
}
]
},
{
"name": "onRemoved",
"type": "function",
"description": "Fired when a window is removed (closed).",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0, "description": "ID of the removed window."}
]
},
{
"name": "onFocusChanged",
"type": "function",
"description": "Fired when the currently focused window changes. Will be chrome.windows.WINDOW_ID_NONE if all chrome windows have lost focus. Note: On some Linux window managers, WINDOW_ID_NONE will always be sent immediately preceding a switch from one chrome window to another.",
"parameters": [
{"type": "integer", "name": "windowId", "minimum": 0, "description": "ID of the newly focused window."}
]
}
]
},
{
"namespace": "tabs",
"types": [
{
"id": "Tab",
"type": "object",
"properties": {
"id": {"type": "integer", "minimum": 0, "description": "The ID of the tab. Tab IDs are unique within a browser session."},
"index": {"type": "integer", "minimum": 0, "description": "The zero-based index of the tab within its window."},
"windowId": {"type": "integer", "minimum": 0, "description": "The ID of the window the tab is contained within."},
"selected": {"type": "boolean", "description": "Whether the tab is selected."},
"pinned": {"type": "boolean", "description": "Whether the tab is pinned."},
"url": {"type": "string", "description": "The URL the tab is displaying."},
"title": {"type": "string", "optional": true, "description": "The title of the tab. This may not be available if the tab is loading."},
"favIconUrl": {"type": "string", "optional": true, "description": "The URL of the tab's favicon. This may not be available if the tab is loading."},
"status": {"type": "string", "optional": true, "description": "Either <em>loading</em> or <em>complete</em>."},
"incognito": {"type": "boolean", "description": "Whether the tab is in an incognito window."}
}
}
],
"functions": [
{
"name": "get",
"type": "function",
"description": "Retrieves details about the specified tab.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "tab", "$ref": "Tab"}
]
}
]
},
{
"name": "getCurrent",
"type": "function",
"description": "Gets the tab that this script call is being made from. May be undefined if called from a non-tab context (for example: a background page or popup view).",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"optional": true
}
]
}
]
},
{
"name": "connect",
"type": "function",
"description": "Connects to the content script(s) in the specified tab. The <a href='extension.html#event-onConnect'>chrome.extension.onConnect</a> event is fired in each content script running in the specified tab for the current extension. For more details, see <a href='content_scripts.html#messaging'>Content Script Messaging</a>.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "object",
"name": "connectInfo",
"properties": {
"name": { "type": "string", "optional": true, "description": "Will be passed into onConnect for content scripts that are listening for the connection event." }
},
"optional": true
}
],
"returns": {
"$ref": "Port",
"description": "A port that can be used to communicate with the content scripts running in the specified tab. The port's <a href='extension.html#type-Port'>onDisconnect</a> event is fired if the tab closes or does not exist. "
}
},
{
"name": "sendRequest",
"type": "function",
"description": "Sends a single request to the content script(s) in the specified tab, with an optional callback to run when a response is sent back. The <a href='extension.html#event-onRequest'>chrome.extension.onRequest</a> event is fired in each content script running in the specified tab for the current extension.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0
},
{
"type": "any",
"name": "request"
},
{
"type": "function",
"name": "responseCallback",
"optional": true,
"parameters": [
{
"name": "response",
"type": "any",
"description": "The JSON response object sent by the handler of the request. If an error occurs while connecting to the specified tab, the callback will be called with no arguments and <a href='extension.html#property-lastError'>chrome.extension.lastError</a> will be set to the error message."
}
]
}
]
},
{
"name": "getSelected",
"type": "function",
"description": "Gets the tab that is selected in the specified window.",
"parameters": [
{
"type": "integer",
"name": "windowId",
"minimum": 0,
"optional": true,
"description": "Defaults to the <a href='windows.html#current-window'>current window</a>."
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "tab", "$ref": "Tab"}
]
}
]
},
{
"name": "getAllInWindow",
"type": "function",
"description": "Gets details about all tabs in the specified window.",
"parameters": [
{
"type": "integer",
"name": "windowId",
"minimum": 0,
"optional": true,
"description": "Defaults to the <a href='windows.html#current-window'>current window</a>."
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "tabs", "type": "array", "items": { "$ref": "Tab" } }
]
}
]
},
{
"name": "create",
"type": "function",
"description": "Creates a new tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.",
"parameters": [
{
"type": "object",
"name": "createProperties",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The window to create the new tab in. Defaults to the <a href='windows.html#current-window'>current window</a>."
},
"index": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "The position the tab should take in the window. The provided value will be clamped to between zero and the number of tabs in the window."
},
"url": {
"type": "string",
"optional": true,
"description": "The URL to navigate the tab to initially. Fully-qualified URLs must include a scheme (i.e. 'http://www.google.com', not 'www.google.com'). Relative URLs will be relative to the current page within the extension. Defaults to the New Tab Page."
},
"selected": {
"type": "boolean",
"optional": true,
"description": "Whether the tab should become the selected tab in the window. Defaults to <var>true</var>"
},
"pinned": {
"type": "boolean",
"optional": true,
"description": "Whether the tab should be pinned. Defaults to <var>false</var>"
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"description": "Details about the created tab. Will contain the ID of the new tab."
}
]
}
]
},
{
"name": "update",
"type": "function",
"description": "Modifies the properties of a tab. Properties that are not specified in <var>updateProperties</var> are not modified. Note: This function can be used without requesting the 'tabs' permission in the manifest.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "updateProperties",
"properties": {
"url": {
"optional": true,
"description": "A URL to navigate the tab to."
},
"selected": {
"type": "boolean",
"optional": true,
"description": "Whether the tab should be selected."
},
"pinned": {
"type": "boolean",
"optional": true,
"description": "Whether the tab should be pinned."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"description": "Details about the updated tab."
}
]
}
]
},
{
"name": "move",
"type": "function",
"description": "Moves a tab to a new position within its window, or to a new window. Note that tabs can only be moved to and from normal (window.type === \"normal\") windows.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "moveProperties",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the window the tab is currently in."
},
"index": {
"type": "integer",
"minimum": 0,
"description": "The position to move the window to. The provided value will be clamped to between zero and the number of tabs in the window."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "tab",
"$ref": "Tab",
"description": "Details about the moved tab."
}
]
}
]
},
{
"name": "remove",
"type": "function",
"description": "Closes a tab. Note: This function can be used without requesting the 'tabs' permission in the manifest.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "detectLanguage",
"type": "function",
"description": "Detects the primary language of the content in a tab.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "string",
"name": "language",
"description": "An ISO language code such as <code>en</code> or <code>fr</code>. For a complete list of languages supported by this method, see <a href='http://src.chromium.org/viewvc/chrome/trunk/src/third_party/cld/languages/internal/languages.cc'>kLanguageInfoTable</a>. The 2nd to 4th columns will be checked and the first non-NULL value will be returned except for Simplified Chinese for which zh-CN will be returned. For an unknown language, <code>und</code> will be returned."
}
]
}
]
},
{
"name": "captureVisibleTab",
"type": "function",
"description": "Captures the visible area of the currently selected tab in the specified window. You must have <a href='manifest.html#permissions'>host permission</a> for the URL displayed by the tab.",
"parameters": [
{
"type": "integer",
"name": "windowId",
"minimum": 0,
"optional": true,
"description": "The target window. Defaults to the <a href='windows.html#current-window'>current window</a>."
},
{
"type": "object",
"name": "options",
"optional": true,
"description": "Set parameters of image capture, such as the format of the resulting image.",
"properties": {
"format": {
"type": "string",
"optional": true,
"enum": ["jpeg", "png"],
"description": "The format of the resulting image. Default is jpeg."
},
"quality": {
"type": "integer",
"name": "quality",
"optional": true,
"minimum": 0,
"maximum": 100,
"description": "When format is 'jpeg', controls the quality of the resulting image. This value is ignored for PNG images. As quality is decreased, the resulting image will have more visual artifacts, and the number of bytes needed to store it will decrease."
}
}
},
{
"type": "function", "name": "callback", "parameters": [
{"type": "string", "name": "dataUrl", "description": "A data URL which encodes an image of the visible area of the captured tab. May be assigned to the 'src' property of an HTML Image element for display."}
]
}
]
},
{
"name": "executeScript",
"type": "function",
"description": "Injects JavaScript code into a page. For details, see the <a href='content_scripts.html#pi'>programmatic injection</a> section of the content scripts doc.",
"parameters": [
{"type": "integer", "name": "tabId", "optional": true, "description": "The ID of the tab in which to run the script; defaults to the selected tab of the current window."},
{
"type": "object",
"name": "details",
"description": "Details of the script to run. Either the code or the file property must be set, but both may not be set at the same time.",
"properties": {
"code": {"type": "string", "optional": true, "description": "JavaScript code to execute."},
"file": {"type": "string", "optional": true, "description": "JavaScript file to execute."},
"allFrames": {"type": "boolean", "optional": true, "description": "If allFrames is true, this function injects script into all frames of current page. By default, it's false and script is injected only into the top main frame."}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called after all the JavaScript has been executed.",
"parameters": []
}
]
},
{
"name": "insertCSS",
"type": "function",
"description": "Injects CSS into a page. For details, see the <a href='content_scripts.html#pi'>programmatic injection</a> section of the content scripts doc.",
"parameters": [
{"type": "integer", "name": "tabId", "optional": true, "description": "The ID of the tab in which to insert the CSS; defaults to the selected tab of the current window."},
{
"type": "object",
"name": "details",
"description": "Details of the CSS text to insert. Either the code or the file property must be set, but both may not be set at the same time.",
"properties": {
"code": {"type": "string", "optional": true, "description": "CSS code to be injected."},
"file": {"type": "string", "optional": true, "description": "CSS file to be injected."},
"allFrames": {"type": "boolean", "optional": true, "description": "If allFrames is true, this function injects CSS text into all frames of current page. By default, it's false and CSS is injected only into the top main frame."}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called when all the CSS has been inserted.",
"parameters": []
}
]
}
],
"events": [
{
"name": "onCreated",
"type": "function",
"description": "Fires when a tab is created. Note that the tab's URL may not be set at the time this event fires, but you can listen to onUpdated events to be notified when a URL is set.",
"parameters": [
{
"$ref": "Tab",
"name": "tab",
"description": "Details of the tab that was created."
}
]
},
{
"name": "onUpdated",
"type": "function",
"description": "Fires when a tab is updated.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "changeInfo",
"description": "Lists the changes to the state of the tab that was updated.",
"properties": {
"status": {
"type": "string",
"optional": true,
"description": "The status of the tab. Can be either <em>loading</em> or <em>complete</em>."
},
"url": {
"type": "string",
"optional": true,
"description": "The tab's URL if it has changed."
},
"pinned": {
"type": "boolean",
"optional": true,
"description": "The tab's new pinned state."
}
}
},
{
"$ref": "Tab",
"name": "tab",
"description": "Gives the state of the tab that was updated."
}
]
},
{
"name": "onMoved",
"type": "function",
"description": "Fires when a tab is moved within a window. Only one move event is fired, representing the tab the user directly moved. Move events are not fired for the other tabs that must move in response. This event is not fired when a tab is moved between windows. For that, see <a href='#event-onDetached'>onDetached</a>.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "moveInfo",
"properties": {
"windowId": {"type": "integer", "minimum": 0},
"fromIndex": {"type": "integer", "minimum": 0},
"toIndex": {"type": "integer", "minimum": 0}
}
}
]
},
{
"name": "onSelectionChanged",
"type": "function",
"description": "Fires when the selected tab in a window changes.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"minimum": 0,
"description": "The ID of the tab that has become selected."
},
{
"type": "object",
"name": "selectInfo",
"properties": {
"windowId": {
"type": "integer",
"minimum": 0,
"description": "The ID of the window the selected tab changed inside of."
}
}
}
]
},
{
"name": "onDetached",
"type": "function",
"description": "Fired when a tab is detached from a window, for example because it is being moved between windows.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "detachInfo",
"properties": {
"oldWindowId": {"type": "integer", "minimum": 0},
"oldPosition": {"type": "integer", "minimum": 0}
}
}
]
},
{
"name": "onAttached",
"type": "function",
"description": "Fired when a tab is attached to a window, for example because it was moved between windows.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "attachInfo",
"properties": {
"newWindowId": {"type": "integer", "minimum": 0},
"newPosition": {"type": "integer", "minimum": 0}
}
}
]
},
{
"name": "onRemoved",
"type": "function",
"description": "Fires when a tab is closed. Note: A listener can be registered for this event without requesting the 'tabs' permission in the manifest.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "removeInfo",
"properties": {
"isWindowClosing": {"type": "boolean", "description": "True when the tab is being closed because its window is being closed." }
}
}
]
}
]
},
{
"namespace": "pageActions",
"nodoc": true,
"types": [],
"functions": [
{
"name": "enableForTab",
"type": "function",
"description": "Enables a page action for a particular tab+URL combination (makes its icon visible in the OmniBox when a certain URL is active in a given tab). The page action will automatically be disabled (its icon hidden) if the user navigates to a new URL or closes the tab. The action will also automatically be enabled/disabled as the user switches tabs.",
"parameters": [
{"type": "string", "name": "pageActionId", "description": "An extension can have multiple page actions specified in the manifest, each with a unique identifier. This string identifies which page action you want to enable (and must match a page action id declared in the manifest)."},
{
"type": "object",
"name": "action",
"description": "An object specifing what action should be applied to the page action. Contains the following properties:",
"properties": {
"tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to enable the page action."},
"url": {"type": "string", "description": "The URL of the page you want the page action to apply to. If the URL specified does not match the currently navigated URL (user has navigated to another page) then no action is taken."},
"title": {"type": "string", "optional": true, "description": "Specifying <b>title</b> allows you to change the tooltip that appears when you hover over the page action icon in the OmniBox. This parameter is optional and if omitted then the page action <b>name</b> property declared in the manifest is used."},
"iconId": {"type": "integer", "minimum": 0, "optional": true, "description": "A zero-based index into the <b>icons</b> vector specified in the manifest. This parameter is optional and if omitted then the first icon in the <b>icons</b> vector of the page action is used. This id is useful to represent different page action states. Example: An RSS feed icon could have a 'subscribe now' icon and an 'already subscribed' icon."}
},
"optional": false
}
]
},
{
"name": "disableForTab",
"type": "function",
"description": "Disables a page action for a particular tab+URL combination (makes its OmniBox page action icon hidden when a certain URL is active in a given tab). This can be useful to disable a page action before the user navigates away from a page containing an enabled page action.",
"parameters": [
{"type": "string", "name": "pageActionId", "description": "An extension can have multiple page actions specified in the manifest, each with a unique identifier. This string identifies which page action you want to disable (and must match a page action id declared in the manifest)."},
{
"type": "object",
"name": "action",
"description": "An object specifying what action should be applied to the page action. Contains the following properties:",
"properties": {
"tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to disable the page action."},
"url": {"type": "string", "description": "The URL of the page you want the page action to not apply to. If the URL specified does not match the currently navigated URL (user has navigated to another page) then no action is taken."}
},
"optional": false
}
]
}
],
"events": []
},
{
"namespace": "pageAction",
"types": [],
"functions": [
{
"name": "show",
"type": "function",
"description": "Shows the page action. The page action is shown whenever the tab is selected.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."}
]
},
{
"name": "hide",
"type": "function",
"description": "Hides the page action.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."}
]
},
{
"name": "setTitle",
"type": "function",
"description": "Sets the title of the page action. This is displayed in a tooltip over the page action.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."},
"title": {"type": "string", "description": "The tooltip string."}
}
}
]
},
{
"name": "setIcon",
"type": "function",
"description": "Sets the icon for the page action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."},
"imageData": {
"type": "object",
"isInstanceOf": "ImageData",
"properties": {},
"additionalProperties": { "type": "any" },
"description": "Pixel data for an image. Must be an ImageData object (for example, from a canvas element).",
"optional": true
},
"path": {
"type": "string",
"description": "Relative path to an image in the extension to show in the browser action.",
"optional": true
},
"iconIndex": {
"type": "integer",
"minimum": 0,
"description": "<b>Deprecated.</b> The zero-based index into the <b>icons</b> vector specified in the manifest.",
"optional": true
}
}
}
]
},
{
"name": "setPopup",
"type": "function",
"description": "Sets the html document to be opened as a popup when the user clicks on the page action's icon.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"tabId": {"type": "integer", "minimum": 0, "description": "The id of the tab for which you want to modify the page action."},
"popup": {
"type": "string",
"description": "The html file to show in a popup. If set to the empty string (''), no popup is shown."
}
}
}
]
}
],
"events": [
{
"name": "onClicked",
"type": "function",
"description": "Fired when a page action icon is clicked. This event will not fire if the page action has a popup.",
"parameters": [
{
"name": "tab",
"$ref": "Tab"
}
]
}
]
},
{
"namespace": "browserAction",
"types": [],
"functions": [
{
"name": "setTitle",
"type": "function",
"description": "Sets the title of the browser action. This shows up in the tooltip.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"title": {
"type": "string",
"description": "The string the browser action should display when moused over."
},
"tabId": {
"type": "integer",
"optional": true,
"description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
}
}
}
]
},
{
"name": "setIcon",
"type": "function",
"description": "Sets the icon for the browser action. The icon can be specified either as the path to an image file or as the pixel data from a canvas element. Either the <b>path</b> or the <b>imageData</b> property must be specified.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"imageData": {
"type": "object",
"isInstanceOf": "ImageData",
"properties": {},
"additionalProperties": { "type": "any" },
"description": "Pixel data for an image. Must be an ImageData object (for example, from a <code>canvas</code> element).",
"optional": true
},
"path": {
"type": "string",
"description": "Relative path to an image in the extension to show in the browser action.",
"optional": true
},
"tabId": {
"type": "integer",
"optional": true,
"description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
}
}
}
]
},
{
"name": "setPopup",
"type": "function",
"description": "Sets the html document to be opened as a popup when the user clicks on the browser action's icon.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"tabId": {
"type": "integer",
"optional": true,
"minimum": 0,
"description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
},
"popup": {
"type": "string",
"description": "The html file to show in a popup. If set to the empty string (''), no popup is shown."
}
}
}
]
},
{
"name": "setBadgeText",
"type": "function",
"description": "Sets the badge text for the browser action. The badge is displayed on top of the icon.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"text": {
"type": "string",
"description": "Any number of characters can be passed, but only about four can fit in the space."
},
"tabId": {
"type": "integer",
"optional": true,
"description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
}
}
}
]
},
{
"name": "setBadgeBackgroundColor",
"type": "function",
"description": "Sets the background color for the badge.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"color": {
"type": "array",
"description": "An array of four integers in the range [0,255] that make up the RGBA color of the badge. For example, opaque red is <code>[255, 0, 0, 255]</code>.",
"items": {
"type": "integer",
"minimum": 0,
"maximum": 255
},
"minItems": 4,
"maxItems": 4
},
"tabId": {
"type": "integer",
"optional": true,
"description": "Limits the change to when a particular tab is selected. Automatically resets when the tab is closed."
}
}
}
]
}
],
"events": [
{
"name": "onClicked",
"type": "function",
"description": "Fired when a browser action icon is clicked. This event will not fire if the browser action has a popup.",
"parameters": [
{
"name": "tab",
"$ref": "Tab"
}
]
}
]
},
{
"namespace": "experimental.infobars",
"types": [],
"functions": [
{
"name": "show",
"type": "function",
"description": "Shows an infobar in the specified tab. The infobar will be closed automatically when the tab navigates. Use window.close() to close the infobar before then.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"tabId": {
"type": "integer",
"description": "The tab id for the tab to display the infobar in."
},
"path": {
"type": "string",
"description": "The html file that contains the infobar."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "window", "$ref": "Window", "description": "Contains details about the window in which the infobar was created."
}
]
}
]
}
]
},
{
"namespace": "bookmarks",
"types": [
{
"id": "BookmarkTreeNode",
"type": "object",
"description": "A node (either a bookmark or a folder) in the bookmark tree. Child nodes are ordered within their parent folder.",
"properties": {
"id": {"type": "string", "minimum": 0, "description": "The unique identifier for the node. IDs are unique within the current profile, and they remain valid even after the browser is restarted."},
"parentId": {"type": "string", "minimum": 0, "optional": true, "description": "The <code>id</code> of the parent folder. Omitted for the root node."},
"index": {"type": "integer", "optional": true, "description": "The 0-based position of this node within its parent folder."},
"url": {"type": "string", "optional": true, "description": "The URL navigated to when a user clicks the bookmark. Omitted for folders."},
"title": {"type": "string", "description": "The text displayed for the node."},
"dateAdded": {"type": "number", "optional": true, "description": "When this node was created, in milliseconds since the epoch (<code>new Date(dateAdded)</code>)."},
"dateGroupModified": {"type": "number", "optional": true, "description": "When the contents of this folder last changed, in milliseconds since the epoch."},
"children": {"type": "array", "optional": true, "items": {"$ref": "BookmarkTreeNode"}, "description": "An ordered list of children of this node."}
}
}
],
"functions": [
{
"name": "get",
"type": "function",
"description": "Retrieves the specified BookmarkTreeNode(s).",
"parameters": [
{
"name": "idOrIdList",
"description": "A single string-valued id, or an array of string-valued ids",
"choices": [
{"type": "string"},
{"type": "array", "items": {"type": "string"}, "minItems": 1}
]
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "getChildren",
"type": "function",
"description": "Retrieves the children of the specified BookmarkTreeNode id.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "getRecent",
"type": "function",
"description": "Retrieves the recently added bookmarks.",
"parameters": [
{
"type": "integer",
"minimum": 1,
"name": "numberOfItems",
"description": "The maximum number of items to return."
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "getTree",
"type": "function",
"description": "Retrieves the entire Bookmarks hierarchy.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "getSubTree",
"type": "function",
"description": "Retrieves part of the Bookmarks hierarchy, starting at the specified node.",
"parameters": [
{
"type": "string",
"name": "id",
"description": "The ID of the root of the subtree to retrieve."
},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "search",
"type": "function",
"description": "Searches for BookmarkTreeNodes matching the given query.",
"parameters": [
{"type": "string", "name": "query"},
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
},
{
"name": "create",
"type": "function",
"description": "Creates a bookmark or folder under the specified parentId. If url is NULL or missing, it will be a folder.",
"parameters": [
{
"type": "object",
"name": "bookmark",
"properties": {
"parentId": {"type": "string"},
"index": {"type": "integer", "minimum": 0, "optional": true},
"title": {"type": "string", "optional": true},
"url": {"type": "string", "optional": true}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{"name": "result", "$ref": "BookmarkTreeNode" }
]
}
]
},
{
"name": "move",
"type": "function",
"description": "Moves the specified BookmarkTreeNode to the provided location.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "destination",
"properties": {
"parentId": {"type": "string"},
"index": {"type": "integer", "minimum": 0, "optional": true}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{"name": "result", "$ref": "BookmarkTreeNode" }
]
}
]
},
{
"name": "update",
"type": "function",
"description": "Updates the properties of a bookmark or folder. Specify only the properties that you want to change; unspecified properties will be left unchanged. <b>Note:</b> Currently, only 'title' and 'url' are supported.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "changes",
"properties": {
"title": {"type": "string", "optional": true},
"url": {"type": "string", "optional": true}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{"name": "result", "$ref": "BookmarkTreeNode" }
]
}
]
},
{
"name": "remove",
"type": "function",
"description": "Removes a bookmark or an empty bookmark folder.",
"parameters": [
{"type": "string", "name": "id"},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "removeTree",
"type": "function",
"description": "Recursively removes a bookmark folder.",
"parameters": [
{"type": "string", "name": "id"},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "import",
"type": "function",
"description": "Imports bookmarks from a chrome html bookmark file",
"nodoc": "true",
"parameters": [
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "export",
"type": "function",
"description": "Exports bookmarks to a chrome html bookmark file",
"nodoc": "true",
"parameters": [
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
}
],
"events": [
{
"name": "onCreated",
"type": "function",
"description": "Fired when a bookmark or folder is created.",
"parameters": [
{"type": "string", "name": "id"},
{
"$ref": "BookmarkTreeNode",
"name": "bookmark"
}
]
},
{
"name": "onRemoved",
"type": "function",
"description": "Fired when a bookmark or folder is removed. When a folder is removed recursively, a single notification is fired for the folder, and none for its contents.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "removeInfo",
"properties": {
"parentId": { "type": "string" },
"index": { "type": "integer" }
}
}
]
},
{
"name": "onChanged",
"type": "function",
"description": "Fired when a bookmark or folder changes. <b>Note:</b> Currently, only title and url changes trigger this.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "changeInfo",
"properties": {
"title": {"type": "string"},
"url": {"type": "string", "optional": true}
}
}
]
},
{
"name": "onMoved",
"type": "function",
"description": "Fired when a bookmark or folder is moved to a different parent folder.",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "moveInfo",
"properties": {
"parentId": { "type": "string" },
"index": { "type": "integer" },
"oldParentId": { "type": "string" },
"oldIndex": { "type": "integer" }
}
}
]
},
{
"name": "onChildrenReordered",
"type": "function",
"description": "Fired when the children of a folder have changed their order due to the order being sorted in the UI. This is not called as a result of a move().",
"parameters": [
{"type": "string", "name": "id"},
{
"type": "object",
"name": "reorderInfo",
"properties": {
"childIds": { "type": "array", "items": { "type": "string" } }
}
}
]
},
{
"name": "onImportBegan",
"type": "function",
"description": "Fired when a bookmark import session is begun. Expensive observers should ignore handleCreated updates until onImportEnded is fired. Observers should still handle other notifications immediately.",
"parameters": []
},
{
"name": "onImportEnded",
"type": "function",
"description": "Fired when a bookmark import session is ended.",
"parameters": []
}
]
},
{
"namespace": "history",
"types": [
{
"id": "HistoryItem",
"type": "object",
"description": "An object encapsulating one result of a history query.",
"properties": {
"id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."},
"url": {"type": "string", "optional": true, "description": "The URL navigated to by a user."},
"title": {"type": "string", "optional": true, "description": "The title of the page when it was last loaded."},
"lastVisitTime": {"type": "number", "optional": true, "description": "When this page was last loaded, represented in milliseconds since the epoch."},
"visitCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page."},
"typedCount": {"type": "integer", "optional": true, "description": "The number of times the user has navigated to this page by typing in the address."}
}
},
{
"id": "VisitItem",
"type": "object",
"description": "An object encapsulating one visit to a URL.",
"properties": {
"id": {"type": "string", "minimum": 0, "description": "The unique identifier for the item."},
"visitId": {"type": "string", "description": "The unique identifier for this visit."},
"visitTime": {"type": "number", "optional": true, "description": "When this visit occurred, represented in milliseconds since the epoch."},
"referringVisitId": {"type": "string", "description": "The visit_id of the referrer."},
"transition": {
"type": "string",
"enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"],
"description": "The <a href='#transition_types'>transition type</a> for this visit from its referrer."
}
}
}
],
"functions": [
{
"name": "search",
"type": "function",
"description": "Search the history for the last visit time of each page matching the query.",
"parameters": [
{
"name": "query",
"type": "object",
"properties": {
"text": {"type": "string", "description": "A free-text query to the history service. Leave empty to retrieve all pages."},
"startTime": {"type": "number", "optional": true, "description": "Limit results to those visited after this date, represented in milliseconds since the epoch."},
"endTime": {"type": "number", "optional": true, "description": "Limit results to those visited before this date, represented in milliseconds since the epoch."},
"maxResults": {"type": "integer", "optional": true, "minimum": 0, "description": "The maximum number of results to retrieve. Defaults to 100."}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{ "name": "results", "type": "array", "items": { "$ref": "HistoryItem"} }
]
}
]
},
{
"name": "getVisits",
"type": "function",
"description": "Retrieve information about visits to a URL.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {"type": "string", "description": "The URL for which to retrieve visit information. It must be in the format as returned from a call to history.search."}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{ "name": "results", "type": "array", "items": { "$ref": "VisitItem"} }
]
}
]
},
{
"name": "addUrl",
"type": "function",
"description": "Adds a URL to the history at the current time with a <a href='#transition_types'>transition type</a> of \"link\".",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {"type": "string", "description": "The URL to add."}
}
}
]
},
{
"name": "deleteUrl",
"type": "function",
"description": "Removes all occurrences of the given URL from the history.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"url": {"type": "string", "description": "The URL to remove."}
}
}
]
},
{
"name": "deleteRange",
"type": "function",
"description": "Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.",
"parameters": [
{
"name": "range",
"type": "object",
"properties": {
"startTime": { "type": "number", "description": "Items added to history after this date, represented in milliseconds since the epoch." },
"endTime": { "type": "number", "description": "Items added to history before this date, represented in milliseconds since the epoch." }
}
},
{
"name": "callback", "type": "function", "parameters": []
}
]
},
{
"name": "deleteAll",
"type": "function",
"description": "Deletes all items from the history.",
"parameters": [
{
"name": "callback", "type": "function", "parameters": []
}
]
}
],
"events": [
{
"name": "onVisited",
"type": "function",
"description": "Fired when a URL is visited, providing the HistoryItem data for that URL. This event fires before the page has loaded.",
"parameters": [
{ "name": "result", "$ref": "HistoryItem"}
]
},
{
"name": "onVisitRemoved",
"type": "function",
"description": "Fired when one or more URLs are removed from the history service. When all visits have been removed the URL is purged from history.",
"parameters": [
{
"name": "removed",
"type": "object",
"properties": {
"allHistory": { "type": "boolean", "description": "True if all history was removed. If true, then urls will be empty." },
"urls": { "type": "array", "items": { "type": "string" }, "optional": true}
}
}
]
}
]
},
{
"namespace": "idle",
"types": [],
"functions": [
{
"name": "queryState",
"type": "function",
"description": "Returns the current state of the browser.",
"parameters": [
{
"name": "thresholdSeconds",
"type": "integer",
"minimum": 15,
"description": "Threshold, in seconds, used to determine when a machine is in the idle state."
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "newState",
"type": "string",
"enum": ["active", "idle", "locked"]
}
]
}
]
}
],
"events": [
{
"name": "onStateChanged",
"type": "function",
"description": "Fired when the browser changes to an active state. Currently only reports the transition from idle to active.",
"parameters": [
{
"name": "newState",
"type": "string",
"enum": ["active"]
}
]
}
]
},
{
"namespace": "i18n",
"unprivileged": true,
"types": [],
"functions": [
{
"name": "getAcceptLanguages",
"type": "function",
"description": "Gets the accept-languages of the browser. This is different from the locale used by the browser; to get the locale, use <code>window.navigator.language</code>.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "languages", "type": "array", "items": {"type": "string"}, "description": "Array of the accept languages of the browser, such as en-US,en,zh-CN"}
]
}
]
},
{
"name": "getMessage",
"type": "function",
"unprivileged": true,
"description": "Gets the localized string for the specified message. If the message is missing, this method returns an empty string (''). If the format of the <code>getMessage()</code> call is wrong — for example, <em>messageName</em> is not a string or the <em>substitutions</em> array is empty or has more than 9 elements — this method returns <code>undefined</code>.",
"parameters": [
{ "type": "string",
"name": "messageName",
"description": "The name of the message, as specified in the <a href='i18n-messages.html'><code>messages.json</code></a> file."
},
{
"choices": [
{ "type": "string" },
{
"type": "array",
"items": { "type": "string" },
"minItems": 1,
"maxItems": 9
}
],
"name": "substitutions",
"optional": true,
"description": "1 - 9 substitution strings, if the message requires any."
}
],
"returns": {
"type": "string",
"description": "Message localized for current locale."
}
}
],
"events": []
},
{
"namespace": "experimental.input",
"nodoc": true,
"types": [],
"functions": [
{
"name": "sendKeyboardEvent",
"type": "function",
"description": "Send a keyboard event to Chrome.",
"parameters": [
{ "type": "object",
"name": "event",
"properties": {
"type": {
"type": "string",
"description": "One of 'keyup' or 'keydown'."
},
"keyIdentifier": {
"type": "string",
"description": "See http://www.w3.org/TR/2003/NOTE-DOM-Level-3-Events-20031107/keyset.html#KeySet-Set"
},
"altKey": {
"type": "boolean",
"optional": true,
"description": "Whether or not the ALT key is pressed."
},
"ctrlKey": {
"type": "boolean",
"optional": true,
"description": "Whether or not the CTRL key is pressed."
},
"metaKey": {
"type": "boolean",
"optional": true,
"description": "Whether or not the META key is pressed."
},
"shiftKey": {
"type": "boolean",
"optional": true,
"description": "Whether or not the SHIFT key is pressed."
}
},
"description": "The keyboard event to be sent."
},
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "hideKeyboard",
"type": "function",
"description": "Hide the keyboard UI.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "setKeyboardHeight",
"type": "function",
"description": "Set the height of the keyboard UI.",
"parameters": [
{ "type": "integer",
"name": "height",
"minimum": 0,
"optional": false,
"description": "The height of the keyboard UI."
},
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed but the resizeing may be not finished.",
"parameters": []
}
]
},
{
"name": "sendHandwritingStroke",
"type": "function",
"description": "Send a handwriting event to Chrome.",
"parameters": [
{
"name": "stroke",
"type": "array",
"items": {
"type": "object",
"properties": {
"x": {"type": "number", "minimum": 0, "maximum": 1},
"y": {"type": "number", "minimum": 0, "maximum": 1}
}
}
}
]
},
{
"name": "cancelHandwritingStrokes",
"type": "function",
"description": "Clear last N handwriting strokes.",
"parameters": [
{
"name": "strokeCount",
"optional": true,
"description": "The number of strokes to be removed. Pass 0 to remove all strokes. If omitted, removes all.",
"type": "integer",
"minimum": 0
}
]
}
],
"events": []
},
{
"namespace": "experimental.inputUI",
"nodoc": true,
"platforms": ["chromeos touch"],
"types": [],
"functions": [
{
"name": "register",
"type": "function",
"description": "Register the extension, so the extension can receive input method related events.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "candidateClicked",
"type": "function",
"description": "Notify input method engine that a candidate was clicked.",
"parameters": [
{ "type": "integer",
"name": "index"
},
{ "type": "integer",
"name": "button"
},
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "cursorUp",
"type": "function",
"description": "Notify input method engine cursor up button was clicked.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "cursorDown",
"type": "function",
"description": "Notify input method engine cursor down button was clicked.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "pageUp",
"type": "function",
"description": "Notify input method engine page up button was clicked.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
},
{
"name": "pageDown",
"type": "function",
"description": "Notify input method engine page down button was clicked.",
"parameters": [
{ "type": "function",
"name": "callback",
"optional": true,
"description": "This function is called when the event processing is completed.",
"parameters": []
}
]
}
],
"events": [
{
"name": "onSetCursorLocation",
"type": "function",
"description": "Fired when input cursor location is changed.",
"parameters": [
{ "type": "integer",
"name": "x"
},
{ "type": "integer",
"name": "y"
},
{ "type": "integer",
"name": "width"
},
{ "type": "integer",
"name": "height"
}
]
},
{
"name": "onUpdateAuxiliaryText",
"type": "function",
"description": "Fired when auxiliary text is changed.",
"parameters": [
{ "type": "string",
"name": "text",
"description": "Auxiliary text."
}
]
},
{
"name": "onUpdateLookupTable",
"type": "function",
"description": "Fired when lookup table is updated.",
"parameters": [
{ "type": "object",
"properties": {
"visible": { "type": "boolean" },
"candidates": { "type": "array", "items": { "type": "string" } }
},
"description": "Lookup table"
}
]
}
]
},
{
"namespace": "experimental.bookmarkManager",
"nodoc": true,
"types": [
{
"id": "BookmarkNodeDataElement",
"nodoc": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"optional": true,
"description": "The ID of the bookmark. This is only provided if the data is from the same profile."
},
"parentId": {
"type": "string",
"optional": true,
"description": "The ID of the parent of the bookmark. This is only provided if the data is from the same profile."
},
"title": {"type": "string"},
"url": {
"type": "string",
"optional": true
},
"children": {
"type": "array",
"items": {"$ref": "BookmarkNodeDataElement"}
}
}
},
{
"id": "BookmarkNodeData",
"nodoc": true,
"type": "object",
"description": "Information about the drag and drop data for use with drag and drop events.",
"properties": {
"sameProfile": {"type": "boolean"},
"elements": {
"type": "array",
"items": {"$ref": "BookmarkNodeDataElement"}
}
}
}
],
"functions": [
{
"name": "copy",
"type": "function",
"description": "Copies the given bookmarks into the clipboard",
"nodoc": "true",
"parameters": [
{
"name": "idList",
"description": "An array of string-valued ids",
"type": "array",
"items": {"type": "string"},
"minItems": 1
},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "cut",
"type": "function",
"description": "Cuts the given bookmarks into the clipboard",
"nodoc": "true",
"parameters": [
{
"name": "idList",
"description": "An array of string-valued ids",
"type": "array",
"items": {"type": "string"},
"minItems": 1
},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "paste",
"type": "function",
"description": "Pastes bookmarks from the clipboard into the parent folder after the last selected node",
"nodoc": "true",
"parameters": [
{"type": "string", "name": "parentId"},
{
"name": "selectedIdList",
"description": "An array of string-valued ids for selected bookmarks",
"optional": true,
"type": "array",
"items": {"type": "string"},
"minItems": 0
},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "canPaste",
"type": "function",
"description": "Whether there are any bookmarks that can be pasted",
"nodoc": "true",
"parameters": [
{"type": "string", "name": "parentId", "description": "The ID of the folder to paste into"},
{"type": "function", "name": "callback", "parameters": [
{"type": "boolean"}
]}
]
},
{
"name": "sortChildren",
"type": "function",
"description": "Sorts the children of a given folder",
"nodoc": "true",
"parameters": [
{"type": "string", "name": "parentId", "description": "The ID of the folder to sort the children of"}
]
},
{
"name": "getStrings",
"type": "function",
"description": "Gets the i18n strings for the bookmark manager",
"nodoc": "true",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "object",
"properties": {},
"additionalProperties": {"type": "string"}
}
]
}
]
},
{
"name": "startDrag",
"type": "function",
"description": "Begins dragging a set of bookmarks",
"nodoc": "true",
"parameters": [
{
"name": "idList",
"description": "An array of string-valued ids",
"type": "array",
"items": {"type": "string"},
"minItems": 1
}
]
},
{
"name": "drop",
"type": "function",
"description": "Performs the drop action of the drag and drop session",
"nodoc": "true",
"parameters": [
{
"name": "parentId",
"description": "The ID of the folder that the drop was made",
"type": "string"
},
{
"name": "index",
"description": "The index of the position to drop at. If left out the dropped items will be placed at the end of the existing children",
"type": "integer",
"minimum": 0,
"optional": true
}
]
},
{
"name": "getSubtree",
"type": "function",
"description": "Retrieves a bookmark hierarchy from the given node. If the node id is empty, it is the full tree. If foldersOnly is true, it will only return folders, not actual bookmarks.",
"nodoc": "true",
"parameters": [
{
"name": "id",
"type": "string",
"description": "ID of the root of the tree to pull. If empty, the entire tree will be returned."
},
{
"name": "foldersOnly",
"type": "boolean",
"description": "Pass true to only return folders."
},
{
"name": "callback",
"type": "function",
"parameters": [
{"name": "results", "type": "array", "items": { "$ref": "BookmarkTreeNode"} }
]
}
]
}
],
"events": [
{
"name": "onDragEnter",
"type": "function",
"description": "Fired when dragging bookmarks over the document",
"parameters": [
{"$ref": "BookmarkNodeData"}
]
},
{
"name": "onDragLeave",
"type": "function",
"description": "Fired when the drag and drop leaves the document",
"parameters": [
{"$ref": "BookmarkNodeData"}
]
},
{
"name": "onDrop",
"type": "function",
"description": "Fired when the user drops bookmarks on the document",
"parameters": [
{"$ref": "BookmarkNodeData"}
]
}
]
},
{
"namespace": "devtools",
"nodoc": "true",
"types": [],
"functions": [
{
"name": "getTabEvents",
"type": "function",
"description": "Experimental support for timeline API",
"nodoc": "true",
"parameters": [
{
"name": "tab_id",
"type": "integer"
}
],
"returns": {
"type": "object",
"properties": {},
"additionalProperties": { "type": "any" },
"description": "DevTools tab events object"
}
}
]
},
{
"namespace": "experimental.processes",
"types": [
{
"id": "Process",
"type": "object",
"description": "An object containing information about one of the browser's processes.",
"properties": {
"id": {
"type": "integer",
"description": "The ID of the process, as provided by the OS."
},
"type": {
"type": "string",
"enum": ["browser", "renderer", "extension", "notification", "plugin", "worker", "nacl", "utility", "gpu", "other"],
"description": "The type of process."
},
"cpu": {
"type": "number",
"description": "The most recent measurement of the process's CPU usage, between 0 and 100%."
},
"network": {
"type": "number",
"description": "The most recent measurement of the process's network usage, in bytes per second."
},
"privateMemory": {
"type": "number",
"description": "The most recent measurement of the process's private memory usage, in bytes."
},
"sharedMemory": {
"type": "number",
"description": "The most recent measurement of the process's shared memory usage, in bytes."
}
}
}
],
"functions": [
{
"name": "getProcessIdForTab",
"type": "function",
"description": "Returns the ID of the renderer process for the specified tab.",
"parameters": [
{
"name": "tabId",
"type": "integer",
"minimum": 0
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "processId",
"type": "integer",
"description": "Process ID of the tab's renderer process."
}
]
}
]
}
],
"events": [
{
"name": "onUpdated",
"type": "function",
"description": "Fires each time the Task Manager updates its process statistics, providing the dictionary of updated Process objects, indexed by process ID.",
"parameters": [
{
"name": "processes",
"type": "object",
"properties": {},
"additionalProperties": { "$ref": "Process" }
}
]
}
]
},
{
"namespace": "contextMenus",
"types": [
{
"id": "OnClickData",
"type": "object",
"description": "Information sent when a context menu item is clicked.",
"properties": {
"menuItemId": {
"type": "integer",
"description": "The ID of the menu item that was clicked."
},
"parentMenuItemId": {
"type": "integer",
"optional": true,
"description": "The parent ID, if any, for the item clicked."
},
"mediaType": {
"type": "string",
"optional": true,
"description": "One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements."
},
"linkUrl": {
"type": "string",
"optional": true,
"description": "If the element is a link, the URL it points to."
},
"srcUrl": {
"type": "string",
"optional": true,
"description": "Will be present for elements with a 'src' URL."
},
"pageUrl": {
"type": "string",
"description": "The URL of the page where the menu item was clicked."
},
"frameUrl": {
"type": "string",
"optional": true,
"description": " The URL of the frame of the element where the context menu was clicked, if it was in a frame."
},
"selectionText": {
"type": "string",
"optional": true,
"description": "The text for the context selection, if any."
},
"editable": {
"type": "string",
"description": "A flag indicating whether the element is editable (text input, textarea, etc.)."
}
}
}
],
"functions": [
{
"name": "create",
"type": "function",
"description": "Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.extension.lastError).",
"returns": {
"type": "integer",
"description": "The ID of the newly created item."
},
"parameters": [
{
"type": "object",
"name": "createProperties",
"properties": {
"type": {
"type": "string",
"enum": ["normal", "checkbox", "radio", "separator"],
"optional": true,
"description": "The type of menu item. Defaults to 'normal' if not specified."
},
"title": {
"type": "string",
"optional": true,
"description": "The text to be displayed in the item; this is <em>required</em> unless <em>type</em> is 'separator'. When the context is 'selection', you can use <code>%s</code> within the string to show the selected text. For example, if this parameter's value is \"Translate '%s' to Pig Latin\" and the user selects the word \"cool\", the context menu item for the selection is \"Translate 'cool' to Pig Latin\"."
},
"checked": {
"type": "boolean",
"optional": true,
"description": "The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items."
},
"contexts": {
"type": "array",
"items": {
"type": "string",
"enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]
},
"minItems": 1,
"optional": true,
"description": "List of contexts this menu item will appear in. Defaults to ['page'] if not specified."
},
"onclick": {
"type": "function",
"optional": true,
"description": "A function that will be called back when the menu item is clicked.",
"parameters": [
{
"name": "info",
"$ref": "OnClickData",
"description": "Information about the item clicked and the context where the click happened."
},
{
"name": "tab",
"$ref": "Tab",
"description": "The details of the tab where the click took place."
}
]
},
"parentId": {
"type": "integer",
"optional": true,
"description": "The ID of a parent menu item; this makes the item a child of a previously added item."
},
"documentUrlPatterns": {
"type": "array",
"items": {"type": "string"},
"optional": true,
"description": "Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see <a href='match_patterns.html'>Match Patterns</a>."
},
"targetUrlPatterns": {
"type": "array",
"items": {"type": "string"},
"optional": true,
"description": "Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"description": "Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.extension.lastError.",
"parameters": []
}
]
},
{
"name": "update",
"type": "function",
"description": "Update a previously created context menu item.",
"parameters": [
{
"type": "integer",
"name": "id",
"description": "The ID of the item to update."
},
{
"type": "object",
"name": "updateProperties",
"description": "The properties to update. Accepts the same values as the create function.",
"properties": {
"type": {
"type": "string",
"enum": ["normal", "checkbox", "radio", "separator"],
"optional": true
},
"title": {
"type": "string",
"optional": true
},
"checked": {
"type": "boolean",
"optional": true
},
"contexts": {
"type": "array",
"items": {
"type": "string",
"enum": ["all", "page", "frame", "selection", "link", "editable", "image", "video", "audio"]
},
"minItems": 1,
"optional": true
},
"onclick": {
"type": "function",
"optional": true
},
"parentId": {
"type": "integer",
"optional": true,
"description": "Note: You cannot change an item to be a child of one of its own descendants."
},
"documentUrlPatterns": {
"type": "array",
"items": {"type": "string"},
"optional": true
},
"targetUrlPatterns": {
"type": "array",
"items": {"type": "string"},
"optional": true
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [],
"description": "Called when the context menu has been updated."
}
]
},
{
"name": "remove",
"type": "function",
"description": "Remove a context menu item.",
"parameters": [
{
"type": "integer",
"name": "menuItemId",
"description": "The ID of the context menu item to remove."
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [],
"description": "Called when the context menu has been removed."
}
]
},
{
"name": "removeAll",
"type": "function",
"description": "Remove all context menu items added by this extension.",
"parameters": [
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [],
"description": "Called when removal is complete."
}
]
}
]
},
{
"namespace": "experimental.metrics",
"nodoc": true,
"types": [
{
"id": "MetricType",
"type": "object",
"description": "Describes the type of metric that is to be collected.",
"properties": {
"metricName": {"type": "string", "description": "A unique name within the extension for the metric."},
"type": {
"type": "string",
"enum": ["histogram-log", "histogram-linear"],
"description": "The type of metric, such as 'histogram-log' or 'histogram-linear'."
},
"min": {"type": "integer", "description": "The minimum sample value to be recoded. Must be greater than zero."},
"max": {"type": "integer", "description": "The maximum sample value to be recoded."},
"buckets": {"type": "integer", "description": "The number of buckets to use when separating the recorded values."}
}
}
],
"functions": [
{
"name": "getEnabled",
"type": "function",
"description": "Get the user preference to send UMA and crash reports to Google.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{"name": "enabled", "type": "boolean"}
]
}
]
},
{
"name": "setEnabled",
"type": "function",
"description": "Set the user preference to send UMA and crash reports to Google.",
"parameters": [
{"name": "enabled", "type": "boolean", "description": "True for setting Chrome to actively send UMA and crash reports, false for disabling this."},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "enabled",
"type": "boolean",
"description": "The actual value set. If it is not the one passed in parameter, the value couldn't be changed (e.g. because of security)."
}
]
}
]
},
{
"name": "recordUserAction",
"type": "function",
"description": "Records an action performed by the user.",
"parameters": [
{"name": "name", "type": "string"}
]
},
{
"name": "recordPercentage",
"type": "function",
"description": "Record a percentage value from 1 to 100.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordCount",
"type": "function",
"description": "Record a value than can range from 1 to 1,000,000.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordSmallCount",
"type": "function",
"description": "Record a value than can range from 1 to 100.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordMediumCount",
"type": "function",
"description": "Record a value than can range from 1 to 10,000.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordTime",
"type": "function",
"description": "Record an elapsed time of no more than 10 seconds. The sample value is specified in milliseconds.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordMediumTime",
"type": "function",
"description": "Record an elapsed time of no more than 3 minutes. The sample value is specified in milliseconds.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordLongTime",
"type": "function",
"description": "Record an elapsed time of no more than 1 hour. The sample value is specified in milliseconds.",
"parameters": [
{"name": "metricName", "type": "string"},
{"name": "value", "type": "integer"}
]
},
{
"name": "recordValue",
"type": "function",
"unprivileged": true,
"description": "Adds a value to the given metric.",
"parameters": [
{"name": "metric", "$ref": "MetricType"},
{"name": "value", "type": "integer"}
]
}
],
"events": []
},
{
"namespace": "chromePrivate",
"nodoc": "true",
"functions": [
{
"name": "decodeJPEG",
"description": "Decodes JPEG image array to raw bitmap array",
"parameters": [
{
"name": "jpeg_image",
"type": "array",
"optional": false,
"description": "The JPEG image bytes array",
"items": {"type": "number"}
}
],
"returns": {
"type": "array",
"description": "Decoded bitmap RGB array formatted as (B | G << 8 | R << 16)",
"items": {"type": "number"}
}
}
]
},
{
"namespace": "chromeosInfoPrivate",
"nodoc": "true",
"functions": [
{
"name": "get",
"description": "Fetches customization values for the given property names. See property names in the declaration of the returned dictionary.",
"type": "function",
"parameters": [
{
"name": "propertyNames",
"type": "array",
"item": {"type": "string", "description": "Chrome OS Property name"}
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "propertiesDictionary",
"type": "object",
"description": "Dictionary which contains all requested properties",
"properties": {
"hwid": {"type": "string", "optional": "true", "description": "Hardware ID"},
"homeProvider" : {"type": "string", "optional": "true", "description": "Home provider which is used by the cellular device"},
"initialLocale" : {"type": "string", "optional": "true", "description": "Initial locale for the device"}
}
}
]
}
]
}
]
},
{
"namespace": "cookies",
"types": [
{
"id": "Cookie",
"type": "object",
"description": "Represents information about an HTTP cookie.",
"properties": {
"name": {"type": "string", "description": "The name of the cookie."},
"value": {"type": "string", "description": "The value of the cookie."},
"domain": {"type": "string", "description": "The domain of the cookie (e.g. \"www.google.com\", \"example.com\")."},
"hostOnly": {"type": "boolean", "description": "True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie)."},
"path": {"type": "string", "description": "The path of the cookie."},
"secure": {"type": "boolean", "description": "True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS)."},
"httpOnly": {"type": "boolean", "description": "True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts)."},
"session": {"type": "boolean", "description": "True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date."},
"expirationDate": {"type": "number", "optional": true, "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies."},
"storeId": {"type": "string", "description": "The ID of the cookie store containing this cookie, as provided in getAllCookieStores()."}
}
},
{
"id": "CookieStore",
"type": "object",
"description": "Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window.",
"properties": {
"id": {"type": "string", "description": "The unique identifier for the cookie store."},
"tabIds": {"type": "array", "items": {"type": "integer"}, "description": "Identifiers of all the browser tabs that share this cookie store."}
}
}
],
"functions": [
{
"name": "get",
"type": "function",
"description": "Retrieves information about a single cookie. If more than one cookie of the same name exists for the given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned.",
"parameters": [
{
"type": "object",
"name": "details",
"description": "Details to identify the cookie being retrieved.",
"properties": {
"url": {"type": "string", "description": "The URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the manifest file, the API call will fail."},
"name": {"type": "string", "description": "The name of the cookie to retrieve."},
"storeId": {"type": "string", "optional": true, "description": "The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used."}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "cookie", "$ref": "Cookie", "optional": true, "description": "Contains details about the cookie. This parameter is null if no such cookie was found."
}
]
}
]
},
{
"name": "getAll",
"type": "function",
"description": "Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first.",
"parameters": [
{
"type": "object",
"name": "details",
"description": "Information to filter the cookies being retrieved.",
"properties": {
"url": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those that would match the given URL."},
"name": {"type": "string", "optional": true, "description": "Filters the cookies by name."},
"domain": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those whose domains match or are subdomains of this one."},
"path": {"type": "string", "optional": true, "description": "Restricts the retrieved cookies to those whose path exactly matches this string."},
"secure": {"type": "boolean", "optional": true, "description": "Filters the cookies by their Secure property."},
"session": {"type": "boolean", "optional": true, "description": "Filters out session vs. persistent cookies."},
"storeId": {"type": "string", "optional": true, "description": "The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used."}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "cookies", "type": "array", "items": {"$ref": "Cookie"}, "description": "All the existing, unexpired cookies that match the given cookie info."
}
]
}
]
},
{
"name": "set",
"type": "function",
"description": "Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist.",
"parameters": [
{
"type": "object",
"name": "details",
"description": "Details about the cookie being set.",
"properties": {
"url": {"type": "string", "description": "The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail."},
"name": {"type": "string", "optional": true, "description": "The name of the cookie. Empty by default if omitted."},
"value": {"type": "string", "optional": true, "description": "The value of the cookie. Empty by default if omitted."},
"domain": {"type": "string", "optional": true, "description": "The domain of the cookie. If omitted, the cookie becomes a host-only cookie."},
"path": {"type": "string", "optional": true, "description": "The path of the cookie. Defaults to the path portion of the url parameter."},
"secure": {"type": "boolean", "optional": true, "description": "Whether the cookie should be marked as Secure. Defaults to false."},
"httpOnly": {"type": "boolean", "optional": true, "description": "Whether the cookie should be marked as HttpOnly. Defaults to false."},
"expirationDate": {"type": "number", "optional": true, "description": "The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie."},
"storeId": {"type": "string", "optional": true, "description": "The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store."}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"min_version": "11.0.674.0",
"parameters": [
{
"name": "cookie", "$ref": "Cookie", "optional": true, "description": "Contains details about the cookie that's been set. If setting failed for any reason, this will be \"null\", and \"chrome.extension.lastError\" will be set."
}
]
}
]
},
{
"name": "remove",
"type": "function",
"description": "Deletes a cookie by name.",
"parameters": [
{
"type": "object",
"name": "details",
"description": "Information to identify the cookie to remove.",
"properties": {
"url": {"type": "string", "description": "The URL associated with the cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail."},
"name": {"type": "string", "description": "The name of the cookie to remove."},
"storeId": {"type": "string", "optional": true, "description": "The ID of the cookie store to look in for the cookie. If unspecified, the cookie is looked for by default in the current execution context's cookie store."}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"min_version": "11.0.674.0",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Contains details about the cookie that's been removed. If removal failed for any reason, this will be \"null\", and \"chrome.extension.lastError\" will be set.",
"optional": true,
"properties": {
"url": {"type": "string", "description": "The URL associated with the cookie that's been removed."},
"name": {"type": "string", "description": "The name of the cookie that's been removed."},
"storeId": {"type": "string", "description": "The ID of the cookie store from which the cookie was removed."}
}
}
]
}
]
},
{
"name": "getAllCookieStores",
"type": "function",
"description": "Lists all existing cookie stores.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "cookieStores", "type": "array", "items": {"$ref": "CookieStore"}, "description": "All the existing cookie stores."
}
]
}
]
}
],
"events": [
{
"name": "onChanged",
"type": "function",
"description": "Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with \"cause\" of \"overwrite\" . Afterwards, a new cookie is written with the updated values, generating a second notification with \"cause\" \"explicit\".",
"parameters": [
{
"type": "object",
"name": "changeInfo",
"properties": {
"removed": {"type": "boolean", "description": "True if a cookie was removed."},
"cookie": {"$ref": "Cookie", "description": "Information about the cookie that was set or removed."},
"cause": {"min_version": "12.0.707.0", "type": "string", "enum": ["evicted", "expired", "explicit", "expired_overwrite", "overwrite"], "description": "The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to \"chrome.cookies.remove\", \"cause\" will be \"explicit\". If a cookie was automatically removed due to expiry, \"cause\" will be \"expired\". If a cookie was removed due to being overwritten with an already-expired expiration date, \"cause\" will be set to \"expired_overwrite\". If a cookie was automatically removed due to garbage collection, \"cause\" will be \"evicted\". If a cookie was automatically removed due to a \"set\" call that overwrote it, \"cause\" will be \"overwrite\". Plan your response accordingly."}
}
}
]
}
]
},
{
"namespace": "experimental.rlz",
"nodoc": true,
"types": [],
"functions": [
{
"name": "recordProductEvent",
"type": "function",
"description": "Records an RLZ event for a given product's access point.",
"parameters": [
{"name": "product", "type": "string", "minLength": 1, "maxLength": 1},
{"name": "accessPoint", "type": "string", "minLength": 1, "maxLength": 2},
{"name": "event", "type": "string", "enum": ["install", "set-to-google", "first-search", "activate"]}
]
},
{
"name": "getAccessPointRlz",
"type": "function",
"description": "Gets the RLZ string to be used when accessing a Google property through the given access point.",
"parameters": [
{"name": "accessPoint", "type": "string", "minLength": 1, "maxLength": 2},
{"name": "callback", "type": "function", "parameters": [{"name": "rlz", "type": "string"}]}
]
},
{
"name": "sendFinancialPing",
"type": "function",
"description": "Sends Google promotional information about this extension.",
"parameters": [
{"name": "product", "type": "string", "minLength": 1, "maxLength": 1},
{"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1},
{"name": "signature", "type": "string"},
{"name": "brand", "type": "string"},
{"name": "id", "type": "string"},
{"name": "lang", "type": "string"},
{"name": "exclude_machine_id", "type": "boolean"},
{"name": "callback", "type": "function", "optional": true, "parameters": [{"name": "sent", "type": "boolean"}]}
]
},
{
"name": "clearProductState",
"type": "function",
"description": "Clears all product-specific RLZ state from the machine, as well as clearing all events for the specified access points.",
"parameters": [
{"name": "product", "type": "string", "minLength": 1, "maxLength": 1},
{"name": "accessPoints", "type": "array", "items": {"type": "string", "minLength": 1, "maxLength": 2}, "minItems": 1}
]
}
],
"events": []
},
{
"namespace": "experimental.webNavigation",
"types": [],
"functions": [],
"events": [
{
"name": "onBeforeNavigate",
"type": "function",
"description": "Fires when a navigation is about to occur.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {"type": "integer", "description": "The ID of the tab in which the navigation is about to occur."},
"url": {"type": "string"},
"frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe. Frame IDs are unique within a tab."},
"requestId": {"type": "string", "description": "The ID of the request to retrieve the document of this navigation. Note that this event is fired prior to the corresponding chrome.experimental.webRequest.onBeforeRequest."},
"timeStamp": {"type": "number", "description": "The time when the browser was about to start the navigation, in milliseconds since the epoch."}
}
}
]
},
{
"name": "onCommitted",
"type": "function",
"description": "Fires when a navigation is committed. The document (and the resources it refers to, such as images and subframes) might still be downloading, but at least part of the document has been received from the server and the browser has decided to switch to the new document.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
"url": {"type": "string"},
"frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe."},
"transitionType": {"type": "string", "enum": ["link", "typed", "auto_bookmark", "auto_subframe", "manual_subframe", "generated", "start_page", "form_submit", "reload", "keyword", "keyword_generated"], "description": "Cause of the navigation. The same transition types as defined in the history API are used."},
"transitionQualifiers": {"type": "array", "description": "A list of transition qualifiers.", "items:": {"type": "string", "enum": ["client_redirect", "server_redirect", "forward_back"]}},
"timeStamp": {"type": "number", "description": "The time when the navigation was committed, in milliseconds since the epoch."}
}
}
]
},
{
"name": "onDOMContentLoaded",
"type": "function",
"description": "Fires when the page's DOM is fully constructed, but the referenced resources may not finish loading.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
"url": {"type": "string"},
"frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe."},
"timeStamp": {"type": "number", "description": "The time when the page's DOM was fully constructed, in milliseconds since the epoch."}
}
}
]
},
{
"name": "onCompleted",
"type": "function",
"description": "Fires when a document, including the resources it refers to, is completely loaded and initialized.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
"url": {"type": "string"},
"frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe."},
"timeStamp": {"type": "number", "description": "The time when the document finished loading, in milliseconds since the epoch."}
}
}
]
},
{
"name": "onErrorOccurred",
"type": "function",
"description": "Fires when an error occurs.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {"type": "integer", "description": "The ID of the tab in which the navigation occurs."},
"url": {"type": "string"},
"frameId": {"type": "integer", "description": "0 indicates the navigation happens in the tab content window; positive value indicates navigation in a subframe."},
"error": {"type": "string", "description": "The error description."},
"timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."}
}
}
]
},
{
"name": "onBeforeRetarget",
"type": "function",
"description": "Fires when a new window, or a new tab in an existing window, is about to be created to host a navigation.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"sourceTabId": {"type": "integer", "description": "The ID of the tab in which the navigation is triggered."},
"sourceUrl": {"type": "string", "description": "The URL of the document that is opening the new window."},
"url": {"type": "string", "description": "The URL to be opened in the new window."},
"timeStamp": {"type": "number", "description": "The time when the browser was about to create a new view, in milliseconds since the epoch."}
}
}
]
}
]
},
{
"namespace": "experimental.webRequest",
"types": [
{
"id": "RequestFilter",
"type": "object",
"description": "An object describing filters to apply to webRequest events.",
"properties": {
"urls": {
"type": "array",
"optional": true,
"description": "A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.",
"items": { "type": "string" }
},
"types": {
"type": "array",
"optional": true,
"description": "A list of request types. Requests that cannot match any of the types will be filtered out.",
"items": { "type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"] }
},
"tabId": { "type": "integer", "optional": true },
"windowId": { "type": "integer", "optional": true }
}
},
{
"id": "HttpHeaders",
"type": "array",
"description": "An array of HTTP headers, in the form of name/value pairs.",
"items": {
"type": "object",
"properties": {
"name": {"type": "string"},
"value": {"type": "string"}
}
}
},
{
"id": "BlockingResponse",
"type": "object",
"description": "Return value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.",
"properties": {
"cancel": {
"type": "boolean",
"optional": true,
"description": "If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent."
},
"redirectUrl": {
"type": "string",
"optional": true,
"description": "Only used as a response to the onBeforeRequest event. If set, the original request is prevented from being sent and is instead redirected to the given URL."
},
"requestHeaders": {
"$ref": "HttpHeaders",
"optional": true,
"description": "Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead."
}
}
}
],
"functions": [
{
"name": "addEventListener",
"nodoc": true,
"type": "function",
"description": "Used internally to implement the special form of addListener for the webRequest events.",
"parameters": [
{"type": "function", "name": "callback"},
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["requestLine", "requestHeaders", "statusLine", "responseHeaders", "blocking"]
}
},
{"type": "string", "name": "eventName"},
{"type": "string", "name": "subEventName"}
]
},
{
"name": "eventHandled",
"nodoc": true,
"type": "function",
"description": "Used internally to send a response for a blocked event.",
"parameters": [
{"type": "string", "name": "eventName"},
{"type": "string", "name": "subEventName"},
{"type": "string", "name": "requestId"},
{
"$ref": "BlockingResponse",
"optional": true,
"name": "response"
}
]
}
],
"events": [
{
"name": "onBeforeRequest",
"type": "function",
"description": "Fires when a request is about to occur.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
"url": {"type": "string"},
"method": {"type": "string", "description": "Standard HTTP method."},
"tabId": {"type": "integer", "description": "The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab."},
"type": {"type": "string", "enum": ["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"], "description": "How the requested resource will be used."},
"timeStamp": {"type": "number", "description": "The time when the browser was about to make the request, in milliseconds since the epoch."}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["blocking"]
}
}
],
"returns": {
"$ref": "BlockingResponse",
"description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
"optional": true
}
},
{
"name": "onBeforeSendHeaders",
"type": "function",
"description": "Fires before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. ",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request."},
"url": {"type": "string"},
"timeStamp": {"type": "number", "description": "The time when the browser was about to send headers, in milliseconds since the epoch."},
"requestHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP request headers that are going to be sent out with this request."}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["requestLine", "requestHeaders", "blocking"]
}
}
],
"returns": {
"$ref": "BlockingResponse",
"description": "If \"blocking\" is specified in the \"extraInfoSpec\" parameter, the event listener should return an object of this type.",
"optional": true
}
},
{
"name": "onRequestSent",
"type": "function",
"description": "Fires when a request is sent to the server.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request."},
"url": {"type": "string"},
"ip": {"type": "string", "description": "The server IP address that is actually connected to. Note that it may be a literal IPv6 address."},
"timeStamp": {"type": "number", "description": "The time when the browser finished sending the request, in milliseconds since the epoch."},
"requestHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP request headers that have been sent out with this request."}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["requestLine", "requestHeaders"]
}
}
]
},
{
"name": "onResponseStarted",
"type": "function",
"description": "Fires when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request."},
"url": {"type": "string"},
"statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."},
"timeStamp": {"type": "number", "description": "The time when the status line and response headers were received, in milliseconds since the epoch."},
"responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this response."},
"statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["statusLine", "responseHeaders"]
}
}
]
},
{
"name": "onBeforeRedirect",
"type": "function",
"description": "Fires when a server initiated redirect is about to occur.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request."},
"url": {"type": "string", "description": "The URL of the current request."},
"statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."},
"redirectUrl": {"type": "string", "description": "The new URL."},
"timeStamp": {"type": "number", "description": "The time when the browser was about to make the redirect, in milliseconds since the epoch."},
"responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this redirect."},
"statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["statusLine", "responseHeaders"]
}
}
]
},
{
"name": "onCompleted",
"type": "function",
"description": "Fires when a request is completed.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request."},
"url": {"type": "string", "description": "The URL of the current request."},
"statusCode": {"type": "integer", "description": "Standard HTTP status code returned by the server."},
"timeStamp": {"type": "number", "description": "The time when the response was received completely, in milliseconds since the epoch."},
"responseHeaders": {"$ref": "HttpHeaders", "optional": true, "description": "The HTTP response headers that were received along with this response."},
"statusLine": {"type": "string", "optional": true, "description": "HTTP status line of the response"}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
},
{
"type": "array",
"optional": true,
"name": "extraInfoSpec",
"description": "Array of extra information that should be passed to the listener function.",
"items": {
"type": "string",
"enum": ["statusLine", "responseHeaders"]
}
}
]
},
{
"name": "onErrorOccurred",
"type": "function",
"description": "Fires when an error occurs.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"requestId": {"type": "string", "description": "The ID of the request."},
"url": {"type": "string", "description": "The URL of the current request."},
"error": {"type": "string", "description": "The error description. This string is <em>not</em> guaranteed to remain backwards compatible between releases. You must not parse and act based upon its content."},
"timeStamp": {"type": "number", "description": "The time when the error occurred, in milliseconds since the epoch."}
}
}
],
"extraParameters": [
{
"$ref": "RequestFilter",
"optional": true,
"name": "filter",
"description": "A set of filters that restricts the events that will be sent to this listener."
}
]
}
]
},
{
"namespace": "test",
"nodoc": true,
"types": [],
"functions": [
{
"name": "getConfig",
"type": "function",
"description": "Gives configuration options set by the test.",
"parameters": [
{
"type": "function", "name": "callback", "parameters": [
{
"type": "object",
"name": "testConfig",
"properties": {
"testServer": {
"type": "object",
"optional": true,
"description": "Details on the test server used to mock network responses. Will be set only if test calls ExtensionApiTest::StartTestServer().",
"properties": {
"port": {
"type": "integer",
"description": "The port on which the test server is listening.",
"minimum": 1024,
"maximum": 65535
}
}
}
}
}
]
}
]
},
{
"name": "notifyFail",
"type": "function",
"description": "Notify the browser process that test code running in the extension failed. This is only used for internal unit testing.",
"parameters": [
{"type": "string", "name": "message"}
]
},
{
"name": "notifyPass",
"type": "function",
"description": "Notify the browser process that test code running in the extension passed. This is only used for internal unit testing.",
"parameters": [
{"type": "string", "name": "message", "optional": true}
]
},
{
"name": "resetQuota",
"type": "function",
"description": "Reset all accumulated quota state for all extensions. This is only used for internal unit testing.",
"parameters": []
},
{
"name": "log",
"type": "function",
"description": "Logs a message during internal unit testing.",
"parameters": [
{"type": "string", "name": "message"}
]
},
{
"name": "createIncognitoTab",
"type": "function",
"description": "Creates an incognito tab during internal testing. Succeeds even if the extension is not enabled in incognito mode.",
"parameters": [
{"type": "string", "name": "url"}
]
},
{
"name": "sendMessage",
"type": "function",
"description": "Sends a string message to the browser process, generating a Notification that C++ test code can wait for.",
"parameters": [
{"type": "string", "name": "message"},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{"type": "string", "name": "response"}
]
}
]
}
],
"events": [
{
"name": "onMessage",
"type": "function",
"unprivileged": true,
"description": "Used to test sending messages to extensions.",
"parameters": [
{
"type": "object",
"name": "info",
"properties": {
"data": { "type": "string", "description": "Additional information." },
"lastMessage": { "type": "boolean", "description": "True if this was the last message for this test" }
}
}
]
}
]
},
{
"namespace": "proxy",
"types": [
{
"id": "ProxyServer",
"type": "object",
"description": "An object encapsulating a single proxy server's specification.",
"properties": {
"scheme": {"type": "string", "optional": true, "enum": ["http", "https", "socks4", "socks5"], "description": "The scheme (protocol) of the proxy server itself. Defaults to 'http'."},
"host": {"type": "string", "description": "The URI of the proxy server. This must be an ASCII hostname (in Punycode format). IDNA is not supported, yet."},
"port": {"type": "integer", "optional": true, "description": "The port of the proxy server. Defaults to a port that depends on the scheme."}
}
},
{
"id": "ProxyRules",
"type": "object",
"description": "An object encapsulating the set of proxy rules for all protocols. Use either 'singleProxy' or (a subset of) 'proxyForHttp', 'proxyForHttps', 'proxyForFtp' and 'fallbackProxy'.",
"properties": {
"singleProxy": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for all per-URL requests (that is http, https, and ftp)."},
"proxyForHttp": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for HTTP requests."},
"proxyForHttps": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for HTTPS requests."},
"proxyForFtp": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for FTP requests."},
"fallbackProxy": {"$ref": "ProxyServer", "optional": true, "description": "The proxy server to be used for everthing else or if any of the specific proxyFor... is not specified."},
"bypassList": {"type": "array", "items": {"type": "string"}, "optional": true, "description": "List of servers to connect to without a proxy server."}
}
},
{
"id": "PacScript",
"type": "object",
"description": "An object holding proxy auto-config information. Exactly one of the fields should be non-empty.",
"properties": {
"url": {"type": "string", "optional": true, "description": "URL of the PAC file to be used."},
"data": {"type": "string", "optional": true, "description": "A PAC script."},
"mandatory": {"type": "boolean", "optional": true, "description": "If true, an invalid PAC script will prevent the network stack from falling back to direct connections. Defaults to false."}
}
},
{
"id": "ProxyConfig",
"type": "object",
"description": "An object encapsulating a complete proxy configuration.",
"properties": {
"rules": {"$ref": "ProxyRules", "optional": true, "description": "The proxy rules describing this configuration. Use this for 'fixed_servers' mode."},
"pacScript": {"$ref": "PacScript", "optional": true, "description": "The proxy auto-config (PAC) script for this configuration. Use this for 'pac_script' mode."},
"mode": {
"type": "string",
"enum": ["direct", "auto_detect", "pac_script", "fixed_servers", "system"],
"description": "'direct' = Never use a proxy<br>'auto_detect' = Auto detect proxy settings<br>'pac_script' = Use specified PAC script<br>'fixed_servers' = Manually specify proxy servers<br>'system' = Use system proxy settings"
}
}
}
],
"properties": {
"settings": {
"$ref": "ChromeSetting",
"description": "Proxy settings to be used. The value of this setting is a ProxyConfig object.",
"value": [
"proxy",
{"$ref": "ProxyConfig"}
]
}
},
"events": [
{
"name": "onProxyError",
"type": "function",
"description": "Notifies about proxy errors.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"fatal": {
"type": "boolean",
"description": "If true, the error was fatal and the network transaction was aborted. Otherwise, a direct connection is used instead."
},
"error": {
"type": "string",
"description": "The error description."
},
"details": {
"type": "string",
"description": "Additional details about the error such as a JavaScript runtime error."
}
}
}
]
}
]
},
{
"namespace": "experimental.sidebar",
"types": [],
"functions": [
{
"name": "hide",
"type": "function",
"description": "Hides sidebar's mini tab for the specified tab and collapses sidebar if it was in 'active' state (see getState). Has no effect if the sidebar is already hidden.",
"parameters": [
{
"type": "object",
"name": "details",
"optional": true,
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
}
}
}
]
},
{
"name": "show",
"type": "function",
"description": "Shows sidebar mini tab (in 'shown' state) for the specified tab. Has no effect if already expanded, otherwise changes status to 'shown'.",
"parameters": [
{
"type": "object",
"name": "details",
"optional": true,
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
}
}
}
]
},
{
"name": "expand",
"type": "function",
"description": "Expands sidebar and switches to the specified content (if it was displaying another extension's sidebar content) for the specified tab. Extension is allowed to expand sidebar only in response to an explicit user gesture.",
"parameters": [
{
"type": "object",
"name": "details",
"optional": true,
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
}
}
}
]
},
{
"name": "collapse",
"type": "function",
"description": "Collapses sidebar for the specified tab. Has no effect if sidebar is not in its 'active' state (see getState).",
"parameters": [
{
"type": "object",
"name": "details",
"optional": true,
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
}
}
}
]
},
{
"name": "navigate",
"type": "function",
"description": "Loads the the specified html file into the sidebar for the specified tab.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
},
"path": {
"type": "string",
"description": "Relative path to the html file in the extension to show in the sidebar."
}
}
}
]
},
{
"name": "getState",
"type": "function",
"description": "Returns current sidebar state for the specified tab.",
"parameters": [
{
"type": "object",
"name": "details",
"optional": true,
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "state",
"type": "string",
"enum": ["hidden", "shown", "active"],
"description": "'hidden' indicates sidebar is not defined for the specified tab (show was never called or hide() was called). Nothing is displayed for this sidebar.<br>'shown' means sidebar is defined for the specified tab; mini tab is displayed for this sidebar. Sidebar UI is either collapsed or displaying a content of some other extension's sidebar.<br>'active' indicates that sidebar is defined for the specified tab; sidebar UI is expanded and displaying this sidebar's content."
}
]
}
]
},
{
"name": "setBadgeText",
"type": "function",
"description": "Sets sidebar's mini tab badge text for the specified tab.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
},
"text": {
"type": "string",
"description": "The sidebar's badge text. The badge is displayed on top of the sidebar's icon on the mini tab. Any number of characters can be passed, but only about four can fit in the space."
}
}
}
]
},
{
"name": "setIcon",
"type": "function",
"description": "Sets sidebar's mini tab icon for the specified tab.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
},
"imageData": {
"type": "object",
"isInstanceOf": "ImageData",
"properties": {},
"additionalProperties": { "type": "any" },
"description": "Pixel data for an image to show on the sidebar's mini tab. Must be an ImageData object (for example, from a <code>canvas</code> element). Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16.",
"optional": true
},
"path": {
"type": "string",
"optional": true,
"description": "Relative path to an image in the extension to show on the sidebar's mini tab. Only one of the imagePath/imageData parameters all owed. The extension's icon is used by default. The preferred size of the icon is 16x16 pixels, any other size will be scaled to 16x16."
}
}
}
]
},
{
"name": "setTitle",
"type": "function",
"description": "Sets sidebar's mini tab title for the specified tab.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0,
"optional": true,
"description": "Defaults to the selected tab of the <a href='windows.html#current-window'>current window</a>."
},
"title": {
"type": "string",
"description": "The sidebar's title. It is displayed in a tooltip over the sidebar's mini tab."
}
}
}
]
}
],
"events": [
{
"name": "onStateChanged",
"unprivileged": true,
"type": "function",
"description": "Notifies about sidebar state changes.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"tabId": {
"type": "integer",
"minimum": 0
},
"state": {
"type": "string",
"enum": ["hidden", "shown", "active"]
}
}
}
]
}
]
},
{
"namespace": "omnibox",
"types": [
{
"id": "SuggestResult",
"type": "object",
"description": "A suggest result.",
"properties": {
"content": {
"type": "string",
"minLength": 1,
"description": "The text that is put into the URL bar, and that is sent to the extension when the user chooses this entry."
},
"description": {
"type": "string",
"minLength": 1,
"description": "The text that is displayed in the URL dropdown. Can contain XML-style markup for styling. The supported tags are 'url' (for a literal URL), 'match' (for highlighting text that matched what the user's query), and 'dim' (for dim helper text). The styles can be nested, eg. <dim><match>dimmed match</match></dim>."
}
}
}
],
"functions": [
{
"name": "sendSuggestions",
"nodoc": true,
"type": "function",
"description": "A callback passed to the onInputChanged event used for sending suggestions back to the browser.",
"parameters": [
{"type": "integer", "name": "requestId"},
{
"type": "array",
"description": "Array of suggest results",
"items": {
"type": "object",
"additionalProperties": { "type": "any" }
}
}
]
},
{
"name": "setDefaultSuggestion",
"type": "function",
"description": "Sets the description and styling for the default suggestion. The default suggestion is the text that is displayed in the first suggestion row underneath the URL bar.",
"parameters": [
{
"type": "object",
"name": "suggestion",
"description": "A partial SuggestResult object, without the 'content' parameter. See SuggestResult for a description of the parameters.",
"properties": {
"description": {
"type": "string",
"minLength": 1,
"description": "The text to display in the default suggestion. The placeholder string '%s' can be included and will be replaced with the user's input."
}
}
}
]
}
],
"events": [
{
"name": "onInputStarted",
"type": "function",
"description": "User has started a keyword input session by typing the extension's keyword. This is guaranteed to be sent exactly once per input session, and before any onInputChanged events.",
"parameters": []
},
{
"name": "onInputChanged",
"type": "function",
"description": "User has changed what is typed into the omnibox.",
"parameters": [
{
"type": "string",
"name": "text"
},
{
"name": "suggest",
"type": "function",
"description": "A callback passed to the onInputChanged event used for sending suggestions back to the browser.",
"parameters": [
{
"type": "array",
"description": "Array of suggest results",
"items": {
"$ref": "SuggestResult"
}
}
]
}
]
},
{
"name": "onInputEntered",
"type": "function",
"description": "User has accepted what is typed into the omnibox.",
"parameters": [
{
"type": "string",
"name": "text"
}
]
},
{
"name": "onInputCancelled",
"type": "function",
"description": "User has ended the keyword input session without accepting the input.",
"parameters": []
}
]
},
{
"namespace":"management",
"types": [
{
"id": "IconInfo",
"description": "Information about an icon belonging to an extension or app.",
"type": "object",
"properties": {
"size": { "type": "integer", "description": "A number representing the width and height of the icon. Likely values include (but are not limited to) 128, 48, 24, and 16." },
"url": { "type": "string", "description": "The URL for this icon image. To display a grayscale version of the icon (to indicate that an extension is disabled, for example), append <code>?grayscale=true</code> to the URL." }
}
},
{
"id": "ExtensionInfo",
"description": "Information about an installed extension or app.",
"type": "object",
"properties": {
"id": {
"description": "The extension's unique identifier.",
"type": "string"
},
"name": {
"description": "The name of this extension or app.",
"type": "string"
},
"description": {
"description": "The description of this extension or app.",
"type": "string"
},
"version": {
"description": "The <a href='manifest.html#version'>version</a> of this extension or app.",
"type": "string"
},
"mayDisable": {
"description": "Whether this extension can be disabled or uninstalled by the user.",
"type": "boolean"
},
"enabled": {
"description": "Whether it is currently enabled or disabled.",
"type": "boolean"
},
"isApp": {
"description": "True if this is an app.",
"type": "boolean"
},
"appLaunchUrl": {
"description": "The launch url (only present for apps).",
"type": "string",
"optional": true
},
"homepageUrl": {
"description": "The URL of the homepage of this extension or app",
"type": "string",
"optional": true
},
"optionsUrl": {
"description": "The url for the item's options page, if it has one.",
"type": "string"
},
"icons": {
"description": "A list of icon information. Note that this just reflects what was declared in the manifest, and the actual image at that url may be larger or smaller than what was declared, so you might consider using explicit width and height attributes on img tags referencing these images. See the <a href='manifest.html#icons'>manifest documentation on icons</a> for more details.",
"type": "array",
"optional": true,
"items": {
"$ref": "IconInfo"
}
},
"permissions": {
"description": "Returns a list of API based permissions.",
"type": "array",
"items" : {
"type": "string"
}
},
"hostPermissions": {
"description": "Returns a list of host based permissions.",
"type": "array",
"items" : {
"type": "string"
}
}
}
}
],
"functions": [
{
"name": "getAll",
"description": "Returns a list of information about installed extensions and apps.",
"parameters": [
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"type": "array",
"name": "result",
"items": {
"$ref": "ExtensionInfo"
}
}
]
}
]
},
{
"name": "get",
"description": "Return information about the installed extension or app that has the given ID.",
"parameters": [
{
"name": "id",
"type": "string",
"description": "The ID from an item of $ref:ExtensionInfo."
},
{
"type": "function",
"name": "callback",
"optional": "true",
"parameters": [
{
"name": "result",
"$ref": "ExtensionInfo"
}
]
}
]
},
{
"name": "setEnabled",
"description": "Enable or disable an app or extension.",
"parameters": [
{
"name": "id",
"type": "string",
"description": "This should be the id from an item of $ref:ExtensionInfo."
},
{
"name": "enabled",
"type": "boolean",
"description": "Whether this item should be enabled or disabled."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
},
{
"name": "uninstall",
"description": "Uninstall a currently installed app or extension.",
"parameters": [
{
"name": "id",
"type": "string",
"description": "This should be the id from an item of $ref:ExtensionInfo."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
},
{
"name": "launchApp",
"description": "Launches an application.",
"parameters": [
{
"name": "id",
"type": "string",
"description": "The extension id of the application."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
}
],
"events": [
{
"name": "onInstalled",
"description": "Fired when an app or extension has been installed.",
"type": "function",
"parameters": [{"name": "info", "$ref":"ExtensionInfo"}]
},
{
"name": "onUninstalled",
"description": "Fired when an app or extension has been uninstalled.",
"type": "function",
"parameters": [
{
"name": "id",
"type": "string",
"description": "The id of the extension or app that was uninstalled."
}
]
},
{
"name": "onEnabled",
"description": "Fired when an app or extension has been enabled.",
"type": "function",
"parameters": [{"name": "info", "$ref":"ExtensionInfo"}]
},
{
"name": "onDisabled",
"description": "Fired when an app or extension has been disabled",
"type": "function",
"parameters": [{"name": "info", "$ref":"ExtensionInfo"}]
}
]
},
{
"namespace":"fileBrowserHandler",
"types": [
{
"id": "FileHandlerExecuteEventDetails",
"type": "object",
"description": "Event details payload for fileBrowserHandler.onExecute event.",
"properties": {
"entries": {
"type": "any",
"description": "Array of Entry instances representing files that are targets of this action (selected in ChromeOS file browser)."
},
"tab_id" : {
"type": "integer",
"optional": true,
"description": "The ID of the tab that raised this event. Tab IDs are unique within a browser session."
}
}
}
],
"events": [
{
"name": "onExecute",
"type": "function",
"description": "Fired when file system action is executed from ChromeOS file browser.",
"parameters": [
{
"name": "id",
"type": "string",
"description": "File browser action id as specified in the listener component's manifest."
},
{
"name": "details",
"$ref": "FileHandlerExecuteEventDetails",
"description": "File handler execute event details."
}
]
}
]
},
{
"namespace":"fileBrowserPrivate",
"nodoc": "true",
"types": [
{
"id": "FileBrowserTask",
"type": "object",
"description": "Represents information about available browser tasks. A task is an abstraction of an operation that the file browser can perform over a selected file set.",
"properties": {
"taskId": {"type": "string", "description": "The unique identifier of the task."},
"title": {"type": "string", "description": "Task title."},
"iconUrl": {"type": "string", "description": "Task icon url (from chrome://extension-icon/...)"}
}
},
{
"id": "VolumeInfo",
"type": "object",
"description": "Mounted disk volume information.",
"properties": {
"mountPath": {
"type": "string",
"description": "Disk volume mount point path. The value corresponds to its Entry.fullPath in File API."
},
"devicePath": {
"type": "string",
"description": "Disk volume device path."
},
"label": {
"type": "string",
"description": "Volume label."
},
"deviceType": {
"type": "string",
"enum": ["flash", "hdd", "optical", "undefined"],
"description": "Device type."
},
"readOnly": {
"type": "boolean",
"description": "Flag that specifies if volume is mounted in read-only mode."
},
"totalSizeKB": {
"type": "integer",
"description": "Total disk volume size in KBs"
}
}
},
{
"id": "VolumeMetadata",
"type": "object",
"description": "Mounted disk volume metadata.",
"properties": {
"mountPath": {
"type": "string",
"description": "Disk volume mount point path."
},
"devicePath": {
"type": "string",
"description": "Disk volume device path."
},
"systemPath": {
"type": "string",
"description": "Disk volume system path."
},
"filePath": {
"type": "string",
"description": "Disk volume file path."
},
"deviceLabel": {
"type": "string",
"description": "Volume label."
},
"driveLabel": {
"type": "string",
"description": "Volume's disk label."
},
"deviceType": {
"type": "string",
"enum": ["flash", "hdd", "optical", "undefined"],
"description": "Device type."
},
"isParent": {
"type": "boolean",
"description": "Flag that specifies if volume is a parent device."
},
"isReadOnly": {
"type": "boolean",
"description": "Flag that specifies if volume is mounted in read-only mode."
},
"hasMedia": {
"type": "boolean",
"description": "Flag that specifies if volume has any media."
},
"isOnBootDevice": {
"type": "boolean",
"description": "Flag that specifies if volume is on boot device."
},
"totalSize": {
"type": "integer",
"description": "Total disk volume size."
}
}
},
{
"id": "MountEvent",
"type": "object",
"description": "Payload data for disk mount / unmount event.",
"properties": {
"eventType": {
"type": "string",
"enum": ["added", "removed"],
"description": "Event type that tells listeners which disk volume even was raised."
},
"volumeInfo": {
"$ref": "VolumeInfo",
"description":"Volume information that this mount event applies to."
}
}
},
{
"id": "FileWatchEvent",
"type": "object",
"description": "Payload data for disk mount / unmount event.",
"properties": {
"eventType": {
"type": "string",
"enum": ["changed", "error"],
"description": "Specifies type of event that is raised."
},
"fileUrl": {
"type": "string",
"description":"URL of watched file"
}
}
}
],
"functions": [
{
"name": "cancelDialog",
"type": "function",
"description": "Cancel file selection.",
"parameters": []
},
{
"name": "executeTask",
"description": "Executes file browser task over selected files",
"parameters": [
{
"name": "taskId",
"type": "string",
"description": "The unique identifier of task to execute."
},
{
"name": "fileURLs",
"type": "array",
"description": "Array of file URLs",
"items": { "type": "string" }
},
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name": "success",
"type": "boolean",
"optional": "true",
"description": "True of task execution was successfully initiated."
}
]
}
]
},
{
"name": "getFileTasks",
"description": "Gets the of tasks that can be performed over selected files.",
"parameters": [
{
"name": "fileURLs",
"type": "array",
"description": "Array of selected file URLs",
"items": { "type": "string" }
},
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name": "tasks",
"type": "array",
"items": {"$ref": "FileBrowserTask"},
"description": "The list of available tasks that can be performed on all of the passed file paths."
}
]
}
]
},
{
"name": "getStrings",
"type": "function",
"description": "Get Strings.",
"parameters": [
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "object",
"properties": {},
"additionalProperties": {"type": "string"}
}
]
}
]
},
{
"name": "addFileWatch",
"description": "Adds file watch.",
"parameters": [
{
"name": "fileUrl",
"type": "string",
"description": "URL of file to watch"
},
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name" : "success",
"type": "boolean",
"optional": "true",
"description": "True when file watch is successfully added."
}
]
}
]
},
{
"name": "removeFileWatch",
"description": "Removes file watch.",
"parameters": [
{
"name": "fileUrl",
"type": "string",
"description": "URL of watched file to remove"
},
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name" : "success",
"type": "boolean",
"optional": "true",
"description": "True when file watch is successfully removed."
}
]
}
]
},
{
"name": "requestLocalFileSystem",
"description": "Requests access to local file system",
"parameters": [
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name" : "fileSystem",
"type": "object",
"optional": "true",
"description": "A DOMFileSystem instance for local file system access. null if the caller has no appropriate permissions."
}
]
}
]
},
{
"name": "selectFiles",
"type": "function",
"description": "Select multiple files.",
"parameters": [
{
"type": "array",
"description": "Array of selected paths",
"items": {"type": "string"}
}
]
},
{
"name": "selectFile",
"type": "function",
"description": "Select a file.",
"parameters": [
{
"type": "string",
"description": "A selected path"
},
{
"type": "integer",
"description": "Index of Filter"
}
]
},
{
"name": "viewFiles",
"type": "function",
"description": "View multiple files.",
"parameters": [
{
"name": "fileUrls",
"type": "array",
"description": "Array of selected paths",
"items": {"type": "string"}
},
{
"name": "id",
"type": "string",
"description": "File browser handler id as for internal tasks."
}
]
},
{
"name": "getVolumeMetadata",
"description": "Requests volume's metadata",
"parameters": [
{
"name": "devicePath",
"type": "string",
"description": "Device path of the volume."
},
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name" : "volumeMetadata",
"$ref": "VolumeMetadata",
"optional": "true",
"description": "A requested metadata dictionary object. null if there is no volume with selected devicePath"
}
]
}
]
},
{
"name": "unmountVolume",
"description": "Unmounts specified volume",
"parameters": [
{
"name": "devicePath",
"type": "string",
"description": "Device path of the volume."
}
]
}
],
"events": [
{
"name": "onDiskChanged",
"type": "function",
"description": "Fired when disk mount/unmount event is detected.",
"parameters": [
{
"$ref": "MountEvent",
"name": "event",
"description": "Mount event information."
}
]
},
{
"name": "onFileChanged",
"type": "function",
"description": "Fired when watched file change event is detected.",
"parameters": [
{
"$ref": "FileWatchEvent",
"name": "event",
"description": "File watch event information."
}
]
}
]
},
{
"namespace": "mediaPlayerPrivate",
"nodoc": "true",
"types": [
{
"id": "Playlist",
"type": "object",
"description": "Mediaplayer playlist stored in the browser (it extsts even if the mediaplayer is closed).",
"properties": {
"items": {
"name": "items",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": { "type": "string", "description": "URL of mediafile (in 'filesystem:' scheme for local files)." },
"error": { "type": "boolean", "description": "True if the file has failed to play ('playbackError' with its URL called)." }
}
}
},
"position": {
"type": "integer",
"description": "Index of item in the 'items' array to play next."
},
"pendingPlaybackRequest": {
"type": "boolean",
"optional": "true",
"description": "Informs that a request to play current item has been received. This flag is reset automatically."
}
}
}
],
"functions": [
{
"name": "playAt",
"description": "Sets playlist positions and sets flag of pending play request. Then fires the onPlaylistChanged event.",
"parameters": [
{
"name": "position",
"type": "integer",
"description": "New position in the playlist."
}
]
},
{
"name": "setPlaybackError",
"description": "Marks the URL as failed to play one. Mediaplayer will visually marks such an item. Then fires the onPlaylistChanged event.",
"parameters": [
{
"name": "url",
"type": "string",
"description": "URL failed to play."
}
]
},
{
"name": "getPlaylist",
"type": "function",
"description": "Returns current play list, position and flag of penging play request.",
"parameters": [
{
"name": "resetPendingPlaybackRequest",
"type": "boolean",
"description": "If true the result will include pending playback request status and this status will be reset."
},
{
"name": "callback",
"type": "function",
"description": "Callback to retrieve the playlist.",
"parameters": [
{
"name": "playlist",
"$ref": "Playlist",
"description": "Mediaplayer playlist stored in the browser (it extsts even if the mediaplayer is closed)."
}
]
}
]
},
{
"name": "togglePlaylistPanel",
"description": "Shows or hides the playlist panel.",
"parameters": []
},
{
"name": "toggleFullscreen",
"description": "Switches fullscreen mode on/off for the mediaplayer.",
"parameters": []
},
{
"name": "showPlaylistPanel",
"description": "Shows the playlist panel.",
"parameters": []
}
],
"events": [
{
"name": "onPlaylistChanged",
"type": "function",
"descrition": "Notifies that playlist content or state has been changed. Data could be retrieved via 'getPlaylist'.",
"parameters": []
}
]
},
{
"namespace":"webstorePrivate",
"nodoc": "true",
"functions": [
{
"name": "install",
"description": "Installs the extension corresponding to the given id",
"parameters": [
{
"name": "expected_id",
"type": "string",
"description": "The id of the extension to install."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
},
{
"name": "beginInstall",
"description": "Initiates the install process for the given extension id",
"parameters": [
{
"name": "expected_id",
"type": "string",
"description": "The id of the extension to be installled. Must be called during a user gesture."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
},
{
"name": "beginInstallWithManifest2",
"description": "Initiates the install process for the given extension. This must be called during a user gesture.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The id of the extension to be installled.",
"minLength": 32,
"maxLength": 32
},
"manifest": {
"type": "string",
"description": "A string with the contents of the extension's manifest.json file. During the install process, the browser will check that the downloaded extension's manifest matches what was passed in here.",
"minLength": 1
},
"iconData": {
"type": "string",
"optional": true,
"description": "An icon as a base64-encoded image, displayed in a confirmation dialog."
},
"localizedName": {
"type": "string",
"optional": true,
"description": "A string to use instead of the raw value of the 'name' key from manifest.json."
},
"locale": {
"type": "string",
"optional": true,
"description": "The name of the locale used for generating localizedName. This should be the name of one of the directories in the _locales folder of the extension, or the default_locale setting from the manifest."
}
}
},
{
"name": "callback",
"type": "function",
"description": "Called when the user has either accepted/rejected the dialog, or some error occurred (such as invalid manifest or icon image data).",
"optional": "true",
"parameters": [
{
"name": "result",
"type": "string",
"description": "A string result code, which will be empty upon success. The possible values in the case of errors include 'unknown_error', 'user_cancelled', 'manifest_error', 'icon_error', 'invalid_id', 'permission_denied', and 'no_gesture'."
}
]
}
]
},
{
"name": "completeInstall",
"description": "",
"parameters": [
{
"name": "expected_id",
"type": "string",
"description": "The id of the extension to be installled. This should match a previous call to beginInstall."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": []
}
]
},
{
"name": "getBrowserLogin",
"description": "Returns the logged-in sync user login if there is one, or the empty string otherwise.",
"parameters": [
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{
"name": "info",
"type": "object",
"properties": {
"login": { "type": "string" },
"token": { "type": "string", "optional": true }
}
}
]
}
]
},
{
"name": "getStoreLogin",
"description": "Returns the previous value set by setStoreLogin, or the empty string if there is none.",
"parameters": [
{
"name": "callback",
"type": "function",
"optional": "false",
"parameters": [
{ "name": "login", "type": "string" }
]
}
]
},
{
"name": "setStoreLogin",
"description": "Set a preference value with the store login.",
"parameters": [
{ "name": "login", "type": "string" },
{ "name": "callback", "type": "function", "optional": "true" }
]
},
{
"name": "promptBrowserLogin",
"description": "Causes the browser to bring up the browser login UI.",
"parameters": [
{
"name": "preferred_email",
"type": "string",
"description": "The email address to use to pre-populate the login dialog (can be an empty string)."
},
{
"name": "callback",
"type": "function",
"optional": "true",
"parameters": [
{
"name": "info",
"type": "object",
"properties": {
"login": { "type": "string", "optional": true },
"token": { "type": "string", "optional": true }
}
}
]
}
]
}
]
},
{
"namespace": "webSocketProxyPrivate",
"nodoc": true,
"types": [],
"functions": [
{
"name": "getPassportForTCP",
"description": "requests authorization token for websocket to TCP proxy.",
"parameters": [
{
"type": "string",
"name": "hostname",
"minLength": 1,
"description": "hostname to which TCP connection is requested."
},
{
"type": "integer",
"name": "port",
"minimum": 1,
"maximum": 65535,
"description": "TCP port number."
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"type": "string",
"name": "passport",
"description": "Passport for passing to proxy."
}
]
}
]
}
],
"events": []
},
{
"namespace": "types",
"types": [
{
"id": "ChromeSetting",
"type": "object",
"customBindings": "ChromeSetting",
"description": "An interface which allows access to a Chrome browser setting.",
"functions": [
{
"name": "get",
"type": "function",
"description": "Get the value of a setting.",
"parameters": [
{
"name": "details",
"type": "object",
"description": "What setting to consider.",
"properties": {
"incognito": {
"type": "boolean",
"optional": true,
"description": "Whether to return the setting that applies to the incognito session (default false)."
}
}
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"name": "details",
"type": "object",
"description": "Details of the currently effective value.",
"properties": {
"value": {
"description": "The value of the setting.",
"type": "any"
},
"levelOfControl": {
"description": "One of<br><var>not_controllable</var>: cannot be controlled by any extension<br><var>controlled_by_other_extensions</var>: controlled by extensions with higher precedence<br><var>controllable_by_this_extension</var>: can be controlled by this extension<br><var>controlled_by_this_extension</var>: controlled by this extension",
"type": "string",
"enum": ["not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", "controlled_by_this_extension"]
},
"incognitoSpecific": {
"description": "Whether the effective value is specific to the incognito session.<br>This property will <em>only</em> be present if the <var>incognito</var> property in the <var>details</var> parameter of <code>get()</code> was true.",
"type": "boolean",
"optional": true
}
}
}
]
}
]
},
{
"name": "set",
"type": "function",
"description": "Set the value of a setting.",
"parameters": [
{
"name": "details",
"type": "object",
"description": "What setting to change.",
"properties": {
"value": {
"description": "The value of the setting. <br>Note that every setting has a specific value type, which is described together with the setting. An extension should <em>not</em> set a value of a different type.",
"type": "any"
},
"scope": {
"type": "string",
"enum": ["regular", "incognito_persistent", "incognito_session_only"],
"optional": true,
"description": "Where to set the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_persistent</var>: setting for incognito profile that survives browser restarts (overrides regular preferences),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences)."
}
}
},
{
"name": "callback",
"type": "function",
"description": "Called after the setting has been set.",
"optional": true,
"parameters": []
}
]
},
{
"name": "clear",
"type": "function",
"description": "Clears the setting. This way default settings can become effective again.",
"parameters": [
{
"name": "details",
"type": "object",
"description": "What setting to clear.",
"properties": {
"scope": {
"type": "string",
"enum": ["regular", "incognito_persistent", "incognito_session_only"],
"optional": true,
"description": "Where to clear the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_persistent</var>: setting for incognito profile that survives browser restarts (overrides regular preferences),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular and incognito_persistent preferences)."
}
}
},
{
"name": "callback",
"type": "function",
"description": "Called after the setting has been cleared.",
"optional": true,
"parameters": []
}
]
}
],
"events": [
{
"name": "onChange",
"description": "Fired when the value of the setting changes.",
"parameters": [
{
"type": "object",
"name": "details",
"properties": {
"value": {
"description": "The value of the setting.",
"type": "any"
},
"levelOfControl": {
"description": "One of<br><var>not_controllable</var>: cannot be controlled by any extension<br><var>controlled_by_other_extensions</var>: controlled by extensions with higher precedence<br><var>controllable_by_this_extension</var>: can be controlled by this extension<br><var>controlled_by_this_extension</var>: controlled by this extension",
"type": "string",
"enum": ["not_controllable", "controlled_by_other_extensions", "controllable_by_this_extension", "controlled_by_this_extension"]
},
"incognitoSpecific": {
"description": "Whether the value that has changed is specific to the incognito session.<br>This property will <em>only</em> be present if the user has enabled the extension in incognito mode.",
"type": "boolean",
"optional": true
}
}
}
]
}
]
}
]
},
{
"namespace": "experimental.contentSettings",
"types": [
{
"id": "ResourceIdentifier",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The resource identifier for the given content type."
},
"description": {
"type": "string",
"optional": true,
"description": "A human readable description of the resource."
}
},
"description": "Currently, no content types use resource identifiers."
},
{
"id": "Pattern",
"type": "object",
"properties": {
"pattern": {
"type": "string",
"description": "The pattern string. The pattern should never be constructed directly, but should always be derived from an URL using the methods in the <var>contentSettings.patterns</var> module."
}
}
},
{
"id": "ContentSettingRule",
"type": "object",
"properties": {
"topLevelPattern": {
"$ref": "Pattern",
"description": "The pattern for the top-level frame URL."
},
"embeddedPattern": {
"$ref": "Pattern",
"description": "The pattern for the frame or object URL."
},
"resourceIdentifier": {
"$ref": "ResourceIdentifier",
"optional": true,
"description": "The resource identifier for the content type."
},
"setting": {
"type": "any",
"description": "The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values."
}
}
},
{
"id": "ContentSetting",
"type": "object",
"functions": [
{
"name": "clear",
"type": "function",
"description": "Clear all content setting rules set by this extension.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"scope": {
"type": "string",
"enum": ["regular", "incognito_session_only"],
"optional": true,
"description": "Where to set the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings)."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
},
{
"name": "get",
"type": "function",
"description": "Get the current content setting for a given pair of URLs.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"embeddedUrl": {
"type": "string",
"description": "The URL of the frame or object for which the content settings should be retrieved."
},
"topLevelUrl": {
"type": "string",
"description": "The URL of the top-level frame."
},
"resourceIdentifier": {
"$ref": "ResourceIdentifier",
"optional": true,
"description": "A more specific identifier of the type of content for which the settings should be retrieved."
},
"incognito": {
"type": "boolean",
"optional": true,
"description": "Whether to check the content settings for an incognito session. (default false)"
}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"setting": {
"type": "any",
"description": "The content setting. See the description of the individual ContentSetting objects for the possible values."
}
}
}
]
}
]
},
{
"name": "set",
"type": "function",
"description": "Apply a new content setting rule.",
"parameters": [
{
"name": "details",
"type": "object",
"properties": {
"topLevelPattern": {
"$ref": "Pattern",
"description": "The pattern for the top-level frame URL."
},
"embeddedPattern": {
"$ref": "Pattern",
"description": "The pattern for the frame or object URL."
},
"resourceIdentifier": {
"$ref": "ResourceIdentifier",
"optional": true,
"description": "The resource identifier for the content type."
},
"setting": {
"type": "any",
"description": "The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values."
},
"scope": {
"type": "string",
"enum": ["regular", "incognito_session_only"],
"optional": true,
"description": "Where to clear the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings)."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
},
{
"name": "getResourceIdentifiers",
"type": "function",
"description": "",
"parameters": [
{
"name": "callback",
"type": "function",
"parameters": [
{
"type": "array",
"description": "A list of resource identifiers for this content type, or <var>undefined</var> if this content type does not use resource identifiers.",
"optional": true,
"items": {
"$ref": "ResourceIdentifier"
}
}
]
}
]
}
]
}
],
"properties": {
"global": {
"type": "object",
"value": {},
"properties": {
"thirdPartyCookiesAllowed": {
"$ref": "ChromeSetting",
"value": ["thirdPartyCookiesAllowed", {"type": "boolean"}],
"description": "Whether third party cookies should be allowed. The value of this preference is of type boolean, and the default value is true."
},
"referrersEnabled": {
"$ref": "ChromeSetting",
"value": ["referrersEnabled", {"type":"boolean"}],
"description": "Whether referrers should be enabled. The value of this preference is of type boolean, and the default value is true."
},
"hyperlinkAuditingEnabled": {
"$ref": "ChromeSetting",
"value": ["hyperlinkAuditingEnabled", {"type":"boolean"}],
"description": "Whether to enable hyperlink auditing (\"<a ping>\"). The value of this preference is of type boolean, and the default value is true."
}
}
},
"cookies": {
"$ref": "ContentSetting",
"description": "Whether to allow cookies and other local data to be set by websites. One of<br><var>allow</var>: Accept cookies,<br><var>block</var>: Block cookies,<br><var>session_only</var>: Accept cookies only for the current session. Default is <var>allow</var>.",
"value": [
"cookies",
{"type":"string", "enum": ["allow", "block", "session_only"]}
]
},
"images": {
"$ref": "ContentSetting",
"description": "Whether to show images. One of<br><var>allow</var>: Show images,<br><var>block</var>: Don't show images. Default is <var>allow</var>.",
"value": [
"images",
{"type":"string", "enum": ["allow", "block"]}
]
},
"javascript": {
"$ref": "ContentSetting",
"description": "Whether to run Javascript. One of<br><var>allow</var>: Run Javascript,<br><var>block</var>: Don't run Javascript. Default is <var>allow</var>.",
"value": [
"javascript",
{"type":"string", "enum": ["allow", "block"]}
]
},
"plugins": {
"$ref": "ContentSetting",
"description": "Whether to run plug-ins. One of<br><var>allow</var>: Run plug-ins automatically,<br><var>block</var>: Don't run plug-ins automatically. Default is <var>allow</var>.",
"value": [
"plugins",
{"type":"string", "enum": ["allow", "block"]}
]
},
"popups": {
"$ref": "ContentSetting",
"description": "Whether to allow sites to show pop-ups. One of<br><var>allow</var>: Allow sites to show pop-ups,<br><var>block</var>: Don't allow sites to show pop-ups. Default is <var>block</var>.",
"value": [
"popups",
{"type":"string", "enum": ["allow", "block"]}
]
},
"notifications": {
"$ref": "ContentSetting",
"description": "Whether to allow sites to show desktop notifications. One of<br><var>allow</var>: Allow sites to show desktop notifications,<br><var>block</var>: Don't allow sites to show desktop notifications,<br><var>ask</var>: Ask when a site wants to show desktop notifications. Default is <var>ask</var>.",
"value": [
"notifications",
{"type":"string", "enum": ["allow", "block", "ask"]}
]
}
}
},
{
"namespace": "experimental.debugger",
"functions": [
{
"name": "attach",
"type": "function",
"description": "Attaches debugger to the tab with given id.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"description": "The id of the tab to which you want to attach."
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [],
"description": "If an error occurs while attaching to the tab, the callback will be called with no arguments and <a href='extension.html#property-lastError'>chrome.extension.lastError</a> will be set to the error message."
}
]
},
{
"name": "detach",
"type": "function",
"description": "Detaches debugger from a tab with given id.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"description": "The id of the tab from which you want to detach."
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [],
"description": "If an error occurs while detaching from the tab, the callback will be called with no arguments and <a href='extension.html#property-lastError'>chrome.extension.lastError</a> will be set to the error message."
}
]
},
{
"name": "sendRequest",
"type": "function",
"description": "Send given request to the debugger.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"description": "The id of the tab to which you want to send debugging request."
},
{
"type": "string",
"name": "method",
"description": "Method name."
},
{
"type": "object",
"name": "params",
"optional": true,
"properties": {},
"additionalProperties": { "type": "any" },
"description": "JSON object matching Developer Tools / Web Inspector Protocol scheme."
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"type": "object",
"name": "result",
"optional": true,
"properties": {},
"additionalProperties": { "type": "any" },
"description": "JSON object with the request response."
}
],
"description": "Request response body. If an error occurs while posting the message, the callback will be called with no arguments and <a href='extension.html#property-lastError'>chrome.extension.lastError</a> will be set to the error message."
}
]
}
],
"events": [
{
"name": "onEvent",
"type": "function",
"description": "Fired whenever debugger issues instrumentation event.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"description": "The id of the tab that generated debug evet."
},
{
"type": "string",
"name": "method",
"description": "Method name."
},
{
"type": "object",
"name": "params",
"optional": true,
"properties": {},
"additionalProperties": { "type": "any" },
"description": "JSON object matching Developer Tools / Web Inspector Protocol event data scheme."
}
]
},
{
"name": "onDetach",
"type": "function",
"description": "Fired when browser terminates debugging session for the tab.",
"parameters": [
{
"type": "integer",
"name": "tabId",
"description": "The id of the tab that was detached."
}
]
}
]
}
]
|