OLD | NEW |
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: |
2 1) The <head> information in this page is significant, should be uniform | 2 1) The <head> information in this page is significant, should be uniform |
3 across api docs and should be edited only with knowledge of the | 3 across api docs and should be edited only with knowledge of the |
4 templating mechanism. | 4 templating mechanism. |
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a |
6 browser, it will be re-generated from the template, json schema and | 6 browser, it will be re-generated from the template, json schema and |
7 authored overview content. | 7 authored overview content. |
8 4) The <body>.innerHTML is also generated by an offline step so that this | 8 4) The <body>.innerHTML is also generated by an offline step so that this |
9 page may easily be indexed by search engines. | 9 page may easily be indexed by search engines. |
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> |
(...skipping 272 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
283 <a href="#method-clear">clear</a> | 283 <a href="#method-clear">clear</a> |
284 </li><li> | 284 </li><li> |
285 <a href="#method-get">get</a> | 285 <a href="#method-get">get</a> |
286 </li><li> | 286 </li><li> |
287 <a href="#method-remove">remove</a> | 287 <a href="#method-remove">remove</a> |
288 </li><li> | 288 </li><li> |
289 <a href="#method-set">set</a> | 289 <a href="#method-set">set</a> |
290 </li> | 290 </li> |
291 </ol> | 291 </ol> |
292 </li> | 292 </li> |
293 <li style="display: none; "> | 293 <li> |
294 <a>Events</a> | 294 <a href="#global-events">Events</a> |
295 <ol> | 295 <ol> |
296 <li> | 296 <li> |
297 <a href="#event-anchor">eventName</a> | 297 <a href="#event-onChanged">onChanged</a> |
298 </li> | 298 </li> |
299 </ol> | 299 </ol> |
300 </li> | 300 </li> |
301 <li style="display: none; "> | 301 <li> |
302 <a href="#types">Types</a> | 302 <a href="#types">Types</a> |
303 <ol> | 303 <ol> |
304 <li> | 304 <li> |
305 <a href="#id-anchor">id</a> | 305 <a href="#type-SettingChange">SettingChange</a> |
306 </li> | 306 </li> |
307 </ol> | 307 </ol> |
308 </li> | 308 </li> |
309 </ol> | 309 </ol> |
310 </li> | 310 </li> |
311 </ol> | 311 </ol> |
312 </div> | 312 </div> |
313 <!-- /TABLE OF CONTENTS --> | 313 <!-- /TABLE OF CONTENTS --> |
314 | 314 |
315 <!-- Standard content lead-in for experimental API pages --> | 315 <!-- Standard content lead-in for experimental API pages --> |
(...skipping 884 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1200 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> | 1200 <a href="manifest.html#minimum_chrome_version">minimum_chrome_
version</a> |
1201 can ensure that your extension won't be run in an earlier brow
ser version. | 1201 can ensure that your extension won't be run in an earlier brow
ser version. |
1202 </p> | 1202 </p> |
1203 </div> <!-- /description --> | 1203 </div> <!-- /description --> |
1204 | 1204 |
1205 </div> <!-- /apiItem --> | 1205 </div> <!-- /apiItem --> |
1206 | 1206 |
1207 </div> <!-- /apiGroup --> | 1207 </div> <!-- /apiGroup --> |
1208 | 1208 |
1209 <!-- EVENTS --> | 1209 <!-- EVENTS --> |
1210 <div id="eventsTemplate" class="apiGroup" style="display: none; "> | 1210 <div id="eventsTemplate" class="apiGroup"> |
1211 <a></a> | 1211 <a name="global-events"></a> |
1212 <h3>Events</h3> | 1212 <h3>Events</h3> |
1213 <!-- iterates over all events --> | 1213 <!-- iterates over all events --> |
1214 <div class="apiItem"> | 1214 <div class="apiItem"> |
1215 <a></a> | 1215 <a name="event-onChanged"></a> |
1216 <h4>event name</h4> | 1216 <h4>onChanged</h4> |
1217 | 1217 |
1218 <div class="summary"> | 1218 <div class="summary"> |
1219 <!-- Note: intentionally longer 80 columns --> | 1219 <!-- Note: intentionally longer 80 columns --> |
1220 <span class="subdued">chrome.bookmarks</span><span>onEvent</span
><span class="subdued">.addListener</span>(function(<span>Type param1, Type para
m2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_p
aram2</span>); | 1220 <span class="subdued">chrome.experimental.settings.</span><span>
onChanged</span><span class="subdued">.addListener</span>(function(<span>array o
f SettingChange changes</span>) <span class="subdued">{...}</span><span></span>)
; |
1221 </div> | 1221 </div> |
1222 | 1222 |
1223 <div class="description"> | 1223 <div class="description"> |
1224 <p class="todo">Undocumented.</p> | 1224 <p class="todo" style="display: none; ">Undocumented.</p> |
1225 <p> | 1225 <p>Fired when one or more settings change.</p> |
1226 A description from the json schema def of the event goes here. | |
1227 </p> | |
1228 | 1226 |
1229 <!-- LISTENER PARAMETERS --> | 1227 <!-- LISTENER PARAMETERS --> |
1230 <div> | 1228 <div> |
1231 <h4>Listener parameters</h4> | 1229 <h4>Listener parameters</h4> |
1232 <dl> | 1230 <dl> |
1233 <div> | 1231 <div> |
1234 <div> | 1232 <div> |
1235 </div> | 1233 <dt> |
| 1234 <var>changes</var> |
| 1235 <em> |
| 1236 |
| 1237 <!-- TYPE --> |
| 1238 <div style="display:inline"> |
| 1239 ( |
| 1240 <span class="optional" style="display: none; ">optional</spa
n> |
| 1241 <span class="enum" style="display: none; ">enumerated</span> |
| 1242 <span id="typeTemplate"> |
| 1243 <span style="display: none; "> |
| 1244 <a> Type</a> |
| 1245 </span> |
| 1246 <span> |
| 1247 <span> |
| 1248 array of <span><span> |
| 1249 <span> |
| 1250 <a href="experimental.settings.html#type-SettingChange">
SettingChange</a> |
| 1251 </span> |
| 1252 <span style="display: none; "> |
| 1253 <span> |
| 1254 array of <span><span></span></span> |
| 1255 </span> |
| 1256 <span>paramType</span> |
| 1257 <span></span> |
| 1258 </span> |
| 1259 </span></span> |
| 1260 </span> |
| 1261 <span style="display: none; ">paramType</span> |
| 1262 <span style="display: none; "></span> |
| 1263 </span> |
| 1264 </span> |
| 1265 ) |
| 1266 </div> |
| 1267 |
| 1268 </em> |
| 1269 </dt> |
| 1270 <dd class="todo"> |
| 1271 Undocumented. |
| 1272 </dd> |
| 1273 <dd style="display: none; "> |
| 1274 Description of this parameter from the json schema. |
| 1275 </dd> |
| 1276 <dd style="display: none; "> |
| 1277 This parameter was added in version |
| 1278 <b><span></span></b>. |
| 1279 You must omit this parameter in earlier versions, |
| 1280 and you may omit it in any version. If you require this |
| 1281 parameter, the manifest key |
| 1282 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1283 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1284 </dd> |
| 1285 |
| 1286 <!-- OBJECT PROPERTIES --> |
| 1287 <dd style="display: none; "> |
| 1288 <dl> |
| 1289 <div> |
| 1290 <div> |
| 1291 </div> |
| 1292 </div> |
| 1293 </dl> |
| 1294 </dd> |
| 1295 |
| 1296 <!-- OBJECT METHODS --> |
| 1297 <dd style="display: none; "> |
| 1298 <div></div> |
| 1299 </dd> |
| 1300 |
| 1301 <!-- OBJECT EVENT FIELDS --> |
| 1302 <dd style="display: none; "> |
| 1303 <div></div> |
| 1304 </dd> |
| 1305 |
| 1306 <!-- FUNCTION PARAMETERS --> |
| 1307 <dd style="display: none; "> |
| 1308 <div></div> |
| 1309 </dd> |
| 1310 |
| 1311 </div> |
1236 </div> | 1312 </div> |
1237 </dl> | 1313 </dl> |
1238 </div> | 1314 </div> |
1239 | 1315 |
1240 <!-- EXTRA PARAMETERS --> | 1316 <!-- EXTRA PARAMETERS --> |
1241 <div> | 1317 <div style="display: none; "> |
1242 <h4>Extra parameters to addListener</h4> | 1318 <h4>Extra parameters to addListener</h4> |
1243 <dl> | 1319 <dl> |
1244 <div> | 1320 <div> |
1245 <div> | 1321 <div> |
1246 </div> | 1322 </div> |
1247 </div> | 1323 </div> |
1248 </dl> | 1324 </dl> |
1249 </div> | 1325 </div> |
1250 | 1326 |
1251 <!-- LISTENER RETURN VALUE --> | 1327 <!-- LISTENER RETURN VALUE --> |
1252 <h4>Listener returns</h4> | 1328 <h4 style="display: none; ">Listener returns</h4> |
1253 <dl> | 1329 <dl> |
1254 <div> | 1330 <div style="display: none; "> |
1255 <div> | 1331 <div> |
1256 </div> | 1332 </div> |
1257 </div> | 1333 </div> |
1258 </dl> | 1334 </dl> |
1259 | 1335 |
1260 </div> <!-- /description --> | 1336 </div> <!-- /description --> |
1261 </div> <!-- /apiItem --> | 1337 </div> <!-- /apiItem --> |
1262 | 1338 |
1263 </div> <!-- /apiGroup --> | 1339 </div> <!-- /apiGroup --> |
1264 | 1340 |
1265 <!-- TYPES --> | 1341 <!-- TYPES --> |
1266 <div class="apiGroup" style="display: none; "> | 1342 <div class="apiGroup"> |
1267 <a name="types"></a> | 1343 <a name="types"></a> |
1268 <h3 id="types">Types</h3> | 1344 <h3 id="types">Types</h3> |
1269 | 1345 |
1270 <!-- iterates over all types --> | 1346 <!-- iterates over all types --> |
1271 <div class="apiItem"> | 1347 <div class="apiItem"> |
1272 <a></a> | 1348 <a name="type-SettingChange"></a> |
1273 <h4>type name</h4> | 1349 <h4>SettingChange</h4> |
1274 | 1350 |
1275 <div> | 1351 <div> |
1276 </div> | 1352 <dt> |
| 1353 <var style="display: none; ">paramName</var> |
| 1354 <em> |
| 1355 |
| 1356 <!-- TYPE --> |
| 1357 <div style="display:inline"> |
| 1358 ( |
| 1359 <span class="optional" style="display: none; ">optional</spa
n> |
| 1360 <span class="enum" style="display: none; ">enumerated</span> |
| 1361 <span id="typeTemplate"> |
| 1362 <span style="display: none; "> |
| 1363 <a> Type</a> |
| 1364 </span> |
| 1365 <span> |
| 1366 <span style="display: none; "> |
| 1367 array of <span><span></span></span> |
| 1368 </span> |
| 1369 <span>object</span> |
| 1370 <span style="display: none; "></span> |
| 1371 </span> |
| 1372 </span> |
| 1373 ) |
| 1374 </div> |
| 1375 |
| 1376 </em> |
| 1377 </dt> |
| 1378 <dd class="todo"> |
| 1379 Undocumented. |
| 1380 </dd> |
| 1381 <dd style="display: none; "> |
| 1382 Description of this parameter from the json schema. |
| 1383 </dd> |
| 1384 <dd style="display: none; "> |
| 1385 This parameter was added in version |
| 1386 <b><span></span></b>. |
| 1387 You must omit this parameter in earlier versions, |
| 1388 and you may omit it in any version. If you require this |
| 1389 parameter, the manifest key |
| 1390 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1391 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1392 </dd> |
| 1393 |
| 1394 <!-- OBJECT PROPERTIES --> |
| 1395 <dd> |
| 1396 <dl> |
| 1397 <div> |
| 1398 <div> |
| 1399 <dt> |
| 1400 <var>key</var> |
| 1401 <em> |
| 1402 |
| 1403 <!-- TYPE --> |
| 1404 <div style="display:inline"> |
| 1405 ( |
| 1406 <span class="optional" style="display: none; ">optional</spa
n> |
| 1407 <span class="enum" style="display: none; ">enumerated</span> |
| 1408 <span id="typeTemplate"> |
| 1409 <span style="display: none; "> |
| 1410 <a> Type</a> |
| 1411 </span> |
| 1412 <span> |
| 1413 <span style="display: none; "> |
| 1414 array of <span><span></span></span> |
| 1415 </span> |
| 1416 <span>string</span> |
| 1417 <span style="display: none; "></span> |
| 1418 </span> |
| 1419 </span> |
| 1420 ) |
| 1421 </div> |
| 1422 |
| 1423 </em> |
| 1424 </dt> |
| 1425 <dd class="todo" style="display: none; "> |
| 1426 Undocumented. |
| 1427 </dd> |
| 1428 <dd>The ID of the setting which changed.</dd> |
| 1429 <dd style="display: none; "> |
| 1430 This parameter was added in version |
| 1431 <b><span></span></b>. |
| 1432 You must omit this parameter in earlier versions, |
| 1433 and you may omit it in any version. If you require this |
| 1434 parameter, the manifest key |
| 1435 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1436 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1437 </dd> |
| 1438 |
| 1439 <!-- OBJECT PROPERTIES --> |
| 1440 <dd style="display: none; "> |
| 1441 <dl> |
| 1442 <div> |
| 1443 <div> |
| 1444 </div> |
| 1445 </div> |
| 1446 </dl> |
| 1447 </dd> |
| 1448 |
| 1449 <!-- OBJECT METHODS --> |
| 1450 <dd style="display: none; "> |
| 1451 <div></div> |
| 1452 </dd> |
| 1453 |
| 1454 <!-- OBJECT EVENT FIELDS --> |
| 1455 <dd style="display: none; "> |
| 1456 <div></div> |
| 1457 </dd> |
| 1458 |
| 1459 <!-- FUNCTION PARAMETERS --> |
| 1460 <dd style="display: none; "> |
| 1461 <div></div> |
| 1462 </dd> |
| 1463 |
| 1464 </div> |
| 1465 </div><div> |
| 1466 <div> |
| 1467 <dt> |
| 1468 <var>oldValue</var> |
| 1469 <em> |
| 1470 |
| 1471 <!-- TYPE --> |
| 1472 <div style="display:inline"> |
| 1473 ( |
| 1474 <span class="optional">optional</span> |
| 1475 <span class="enum" style="display: none; ">enumerated</span> |
| 1476 <span id="typeTemplate"> |
| 1477 <span style="display: none; "> |
| 1478 <a> Type</a> |
| 1479 </span> |
| 1480 <span> |
| 1481 <span style="display: none; "> |
| 1482 array of <span><span></span></span> |
| 1483 </span> |
| 1484 <span>any</span> |
| 1485 <span style="display: none; "></span> |
| 1486 </span> |
| 1487 </span> |
| 1488 ) |
| 1489 </div> |
| 1490 |
| 1491 </em> |
| 1492 </dt> |
| 1493 <dd class="todo" style="display: none; "> |
| 1494 Undocumented. |
| 1495 </dd> |
| 1496 <dd>The old value of the setting, before it changed.</dd> |
| 1497 <dd style="display: none; "> |
| 1498 This parameter was added in version |
| 1499 <b><span></span></b>. |
| 1500 You must omit this parameter in earlier versions, |
| 1501 and you may omit it in any version. If you require this |
| 1502 parameter, the manifest key |
| 1503 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1504 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1505 </dd> |
| 1506 |
| 1507 <!-- OBJECT PROPERTIES --> |
| 1508 <dd style="display: none; "> |
| 1509 <dl> |
| 1510 <div> |
| 1511 <div> |
| 1512 </div> |
| 1513 </div> |
| 1514 </dl> |
| 1515 </dd> |
| 1516 |
| 1517 <!-- OBJECT METHODS --> |
| 1518 <dd style="display: none; "> |
| 1519 <div></div> |
| 1520 </dd> |
| 1521 |
| 1522 <!-- OBJECT EVENT FIELDS --> |
| 1523 <dd style="display: none; "> |
| 1524 <div></div> |
| 1525 </dd> |
| 1526 |
| 1527 <!-- FUNCTION PARAMETERS --> |
| 1528 <dd style="display: none; "> |
| 1529 <div></div> |
| 1530 </dd> |
| 1531 |
| 1532 </div> |
| 1533 </div><div> |
| 1534 <div> |
| 1535 <dt> |
| 1536 <var>newValue</var> |
| 1537 <em> |
| 1538 |
| 1539 <!-- TYPE --> |
| 1540 <div style="display:inline"> |
| 1541 ( |
| 1542 <span class="optional">optional</span> |
| 1543 <span class="enum" style="display: none; ">enumerated</span> |
| 1544 <span id="typeTemplate"> |
| 1545 <span style="display: none; "> |
| 1546 <a> Type</a> |
| 1547 </span> |
| 1548 <span> |
| 1549 <span style="display: none; "> |
| 1550 array of <span><span></span></span> |
| 1551 </span> |
| 1552 <span>any</span> |
| 1553 <span style="display: none; "></span> |
| 1554 </span> |
| 1555 </span> |
| 1556 ) |
| 1557 </div> |
| 1558 |
| 1559 </em> |
| 1560 </dt> |
| 1561 <dd class="todo" style="display: none; "> |
| 1562 Undocumented. |
| 1563 </dd> |
| 1564 <dd>The new value of the setting.</dd> |
| 1565 <dd style="display: none; "> |
| 1566 This parameter was added in version |
| 1567 <b><span></span></b>. |
| 1568 You must omit this parameter in earlier versions, |
| 1569 and you may omit it in any version. If you require this |
| 1570 parameter, the manifest key |
| 1571 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio
n</a> |
| 1572 can ensure that your extension won't be run in an earlier browser ve
rsion. |
| 1573 </dd> |
| 1574 |
| 1575 <!-- OBJECT PROPERTIES --> |
| 1576 <dd style="display: none; "> |
| 1577 <dl> |
| 1578 <div> |
| 1579 <div> |
| 1580 </div> |
| 1581 </div> |
| 1582 </dl> |
| 1583 </dd> |
| 1584 |
| 1585 <!-- OBJECT METHODS --> |
| 1586 <dd style="display: none; "> |
| 1587 <div></div> |
| 1588 </dd> |
| 1589 |
| 1590 <!-- OBJECT EVENT FIELDS --> |
| 1591 <dd style="display: none; "> |
| 1592 <div></div> |
| 1593 </dd> |
| 1594 |
| 1595 <!-- FUNCTION PARAMETERS --> |
| 1596 <dd style="display: none; "> |
| 1597 <div></div> |
| 1598 </dd> |
| 1599 |
| 1600 </div> |
| 1601 </div> |
| 1602 </dl> |
| 1603 </dd> |
| 1604 |
| 1605 <!-- OBJECT METHODS --> |
| 1606 <dd style="display: none; "> |
| 1607 <div></div> |
| 1608 </dd> |
| 1609 |
| 1610 <!-- OBJECT EVENT FIELDS --> |
| 1611 <dd style="display: none; "> |
| 1612 <div></div> |
| 1613 </dd> |
| 1614 |
| 1615 <!-- FUNCTION PARAMETERS --> |
| 1616 <dd style="display: none; "> |
| 1617 <div></div> |
| 1618 </dd> |
| 1619 |
| 1620 </div> |
1277 | 1621 |
1278 </div> <!-- /apiItem --> | 1622 </div> <!-- /apiItem --> |
1279 | 1623 |
1280 </div> <!-- /apiGroup --> | 1624 </div> <!-- /apiGroup --> |
1281 | 1625 |
1282 </div> <!-- /apiPage --> | 1626 </div> <!-- /apiPage --> |
1283 </div> <!-- /gc-pagecontent --> | 1627 </div> <!-- /gc-pagecontent --> |
1284 </div> <!-- /g-section --> | 1628 </div> <!-- /g-section --> |
1285 </div> <!-- /codesiteContent --> | 1629 </div> <!-- /codesiteContent --> |
1286 <div id="gc-footer" --=""> | 1630 <div id="gc-footer" --=""> |
(...skipping 26 matching lines...) Expand all Loading... |
1313 _uff=0; | 1657 _uff=0; |
1314 urchinTracker(); | 1658 urchinTracker(); |
1315 } | 1659 } |
1316 catch(e) {/* urchinTracker not available. */} | 1660 catch(e) {/* urchinTracker not available. */} |
1317 </script> | 1661 </script> |
1318 <!-- end analytics --> | 1662 <!-- end analytics --> |
1319 </div> | 1663 </div> |
1320 </div> <!-- /gc-footer --> | 1664 </div> <!-- /gc-footer --> |
1321 </div> <!-- /gc-container --> | 1665 </div> <!-- /gc-container --> |
1322 </body></html> | 1666 </body></html> |
OLD | NEW |