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
|
[
{
"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,
"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." }
}
},
"inIncognitoTab": {
"type": "object",
"optional": true,
"unprivileged": true,
"description": "True for content scripts running inside incognito tabs. Will be undefined for non-content scripts.",
"properties": {
"message": { "type": "boolean", "description": "True if the script is in an incongito tab." }
}
}
},
"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."
}
},
{
"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.",
"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."
}
]
}
]
},
{
"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 it's 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. This includes background pages and tabs.",
"parameters": [],
"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 backround page.",
"parameters": [],
"returns": {
"type": "object", "isInstanceOf": "DOMWindow", "properties": {}, "additionalProperties": { "type": "any" }
}
},
{
"name": "getToolstrips",
"nodoc": true,
"type": "function",
"description": "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",
"type": "function",
"description": "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" } }
}
}
],
"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", "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": "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": "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."
}
]
}
]
},
{
"namespace": "experimental.extension",
"nodoc": true,
"types": [],
"functions": [
{
"name": "getPopupView",
"type": "function",
"description": "Returns a reference to the JavaScript 'window' object of the popup view. Returns undefined if no popup presently shown.",
"parameters": [],
"returns": {
"type": "object",
"isInstanceOf": "DOMWindow",
"properties": {},
"additionalProperties": { "type": "any" },
"optional": true
}
}
],
"events": []
},
{
"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 <a href='tabs.html#type-Tab'>Tab</a> 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.",
"enum": ["normal", "popup", "app"]
}
}
}
],
"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 <a href='tabs.html#type-Tab'>Tab</a> 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", "optional": true, "description": "The URL to navigate the first tab to. 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."},
"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."},
"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.",
"enum": ["normal", "popup"]
}
},
"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."}
}
},
{
"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.",
"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."},
"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": "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."
}
},
{
"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."
}
]
}
]
},
{
"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.",
"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>"
}
}
},
{
"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.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{
"type": "object",
"name": "updateProperties",
"properties": {
"url": {"type": "string", "optional": true},
"selected": {"type": "boolean", "optional": true}
}
},
{
"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.",
"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.",
"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.",
"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": "function", "name": "callback", "parameters": [
{"type": "string", "name": "dataUrl", "description": "A data URL of a JPEG encoding 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.",
"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",
"description": "The status of the tab. Can be either <em>loading</em> or <em>complete</em>."
},
"url": {
"type": "string",
"optional": true,
"description": "Only specified if the tab's URL changed."
}
}
},
{
"$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.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0}
]
}
]
},
{
"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. If not specified the current tab will be used.",
"optional": true
},
"htmlPath": {
"type": "string",
"description": "The html file that contains the infobar."
}
}
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "window", "$ref": "Window", "description": "Contains details about the window in which the infobar was created.",
"optional": true
}
]
}
]
}
]
},
{
"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": "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": []}
]
}
],
"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" } }
}
}
]
}
]
},
{
"namespace": "experimental.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 history page."},
"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": "integer", "minimum": 0, "maximum": 10, "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": {
"search": {"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": [
{
"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": [
{
"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": [
{
"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": [
{
"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.",
"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": "experimental.idle",
"nodoc": "true",
"types": [],
"functions": [
{
"name": "queryState",
"type": "function",
"description": "Returns the current state of the browser.",
"parameters": [
{
"name": "threshold",
"type": "integer",
"minimum": 15,
"description": "Threshold used to determine when a machine is in the idle state."
},
{
"name": "callback",
"type": "function",
"parameters": [
{
"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": [
{
"type": "string",
"enum": ["active"]
}
]
}
]
},
{
"namespace": "toolstrip",
"nodoc": true,
"types": [],
"functions": [
{
"name": "expand",
"type": "function",
"description": "",
"parameters": [
{
"type": "object",
"name": "expandInfo",
"properties": {
"height": { "type": "integer", "minimum": 0, "description": "The vertical pixel height required of the toolstrip area." },
"url": { "type": "string", "optional": true, "description": "If present, the toolstrip mole will change it's content to the provided URL. Otherwise, the current page will just be expanded in size." }
}
},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "collapse",
"type": "function",
"description": "",
"parameters": [
{
"type": "object",
"name": "collapseInfo",
"optional": true,
"properties": {
"url": { "type": "string", "optional": true, "description": "If present, the toolstrip mole will change it's content to the provided URL. Otherwise, the current page will just be collapsed in size." }
}
},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
}
],
"events": []
},
{
"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.popup",
"nodoc": true,
"types": [],
"functions": [
{
"name": "show",
"type": "function",
"description": "Displays a pop-up window hosting an extension view.",
"parameters": [
{
"type": "string",
"name": "url",
"description": "The URL of the contents to which the pop-up will be navigated."
},
{
"type": "object",
"name": "showDetails",
"properties": {
"relativeTo": {
"type": "object",
"properties": {},
"additionalProperties": { "type": "any" },
"isInstanceOf": "HTMLElement",
"description": "A HTML DOM object to which the pop-up's position will be made relative."
},
"giveFocus": {
"type": "boolean",
"description": "Pass true to give the focus to the popup window. The default behaviour is true.",
"optional": true
},
"borderStyle": {
"type": "string",
"description": "Pass 'bubble' to give the pop-up window a bubble-chrome border, including an arrow pointing at the relative-to point. Pass 'rectangle' to give the pop-up a rectangular black border with drop-shadow. Default behaviour is to pass 'bubble'.",
"optional": true,
"enum": ["bubble", "rectangle"]
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": []
}
]
},
{
"name": "getParentWindow",
"type": "function",
"description": "Returns a reference to the JavaScript 'window' object of the extension view that launched the popup. Returns undefined if called outside of a popup window.",
"parameters": [],
"returns": {
"type": "object",
"isInstanceOf": "DOMWindow",
"properties": {},
"additionalProperties": { "type": "any" },
"optional": true
}
}
],
"events": [
{
"name": "onClosed",
"type": "function",
"description": "Fired when the popup view is closed.",
"parameters": []
}
]
},
{
"namespace": "experimental.bookmarkManager",
"nodoc": true,
"types": [
{
"id": "BookmarkDragDataElement",
"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": "BookmarkDragDataElement"}
}
}
},
{
"id": "BookmarkDragData",
"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": "BookmarkDragDataElement"}
}
}
}
],
"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",
"nodoc": "true",
"parameters": [
{"type": "string", "name": "parentId"},
{"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": "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": []}
]
},
{
"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
}
]
}
],
"events": [
{
"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": []
},
{
"name": "onDragEnter",
"type": "function",
"description": "Fired when dragging bookmarks over the document",
"parameters": [
{"$ref": "BookmarkDragData"}
]
},
{
"name": "onDragLeave",
"type": "function",
"description": "Fired when the drag and drop leaves the document",
"parameters": [
{"$ref": "BookmarkDragData"}
]
},
{
"name": "onDrop",
"type": "function",
"description": "Fired when the user drops bookmarks on the document",
"parameters": [
{"$ref": "BookmarkDragData"}
]
}
]
},
{
"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 internal ID of the process."
}
}
}
],
"functions": [
{
"name": "getProcessForTab",
"type": "function",
"description": "Returns details about the current renderer process of the specified tab.",
"parameters": [
{
"name": "tabId",
"type": "integer",
"minimum": 0
},
{
"type": "function",
"name": "callback",
"parameters": [
{
"name": "process",
"$ref": "Process",
"description": "Details about the tab's process."
}
]
}
]
}
],
"events": []
},
{
"namespace": "experimental.contextMenu",
"types": [],
"functions": [
{
"name": "create",
"type": "function",
"description": "An API to add items to context menus.",
"parameters": [
{
"type": "object",
"name": "createProperties",
"properties": {
"type": {
"type": "string",
"optional": true,
"description": "The type of menu item - one of 'NORMAL', 'CHECKBOX', 'RADIO', or 'SEPARATOR'. Defaults to 'NORMAL' if not specified."
},
"title": {
"type": "string",
"optional": "true",
"description": "This must be specified unless type is 'SEPARATOR'."
},
"checked": {
"type": "boolean",
"optional": true,
"description": " For items of type CHECKBOX or RADIO, should this be selected (RADIO) or checked (CHECKBOX)? Only one RADIO item can be selected at a time in a given group of RADIO items, with the last one to have checked == true winning."
},
"contexts": {
"type": "array",
"items": {"type": "string"},
"minItems": 1,
"optional": true,
"description": "List of contexts this menu item will appear in. Legal values are: 'ALL', 'PAGE', 'SELECTION', 'LINK', 'EDITABLE', 'IMAGE', 'VIDEO', and 'AUDIO'. Defaults to ['PAGE']."
},
"enabledContexts": {
"type": "array",
"optional": true,
"items": {"type": "string"},
"minItems": 1,
"description": "By default the values you pass for the contexts parameter make an item both shown and selectable in those contexts. If you want to limit the contexts where an item is selectable (i.e. not greyed out), you put the ones you want selectable in enabledContexts and any not listed will be shown but disabled. So, for example, if you wanted an item to appear for links and images but only be enabled for links, you would set 'contexts' : ['LINK', 'IMAGE'] and 'enabledContexts' : ['LINK']."
},
"onclick": {
"type": "function",
"optional": true,
"description": "Function to be called back when your menu item or one of its children is clicked."
},
"parentId": {
"type": "integer",
"optional": true,
"description": "The id of a parent menu item - this makes the item a child of a previously added item."
}
}
},
{
"type": "function",
"name": "callback",
"optional": true,
"parameters": [
{
"name": "menuItemId",
"type": "integer",
"description": "The id of the newly created context menu item."
}
]
}
]
},
{
"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."
}
]
}
]
},
{
"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": "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": "test",
"nodoc": true,
"types": [],
"functions": [
{
"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"}
]
}
],
"events": []
},
{
"namespace": "experimental.clipboard",
"types": [],
"functions": [
{
"name": "executeCopy",
"type": "function",
"description": "Triggers a copy operation in the specified tab.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "executeCut",
"type": "function",
"description": "Triggers a cut operation in the specified tab.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
},
{
"name": "executePaste",
"type": "function",
"description": "Triggers a paste operation in the specified tab.",
"parameters": [
{"type": "integer", "name": "tabId", "minimum": 0},
{"type": "function", "name": "callback", "optional": true, "parameters": []}
]
}
],
"events": []
}
]
|