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