Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(72)

Issues Search
    My Issues | Starred     Open | Closed | All

Side by Side Diff: chrome/common/extensions/docs/storage.html

Issue 9284013: Extension Storage API: expose storage quota information to extensions, via: (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: . Created 8 years, 11 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
« chrome/common/extensions/api/storage.json ('K') | « chrome/common/extensions/api/storage.json ('k') | chrome/renderer/resources/extensions/schema_generated_bindings.js » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
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 344 matching lines...) Expand 10 before | Expand all | Expand 10 after
355 <li style="display: none; "> 355 <li style="display: none; ">
356 <a>Events</a> 356 <a>Events</a>
357 <ol> 357 <ol>
358 <li> 358 <li>
359 <a href="#event-anchor">eventName</a> 359 <a href="#event-anchor">eventName</a>
360 </li> 360 </li>
361 </ol> 361 </ol>
362 </li> 362 </li>
363 </ol> 363 </ol>
364 </li><li> 364 </li><li>
365 <a href="#type-StorageNamespace">StorageNamespace</a> 365 <a href="#type-StorageArea">StorageArea</a>
366 <ol> 366 <ol>
367 <li> 367 <li>
368 <a href="#global-StorageNamespace-methods">Methods</a> 368 <a href="#global-StorageArea-methods">Methods</a>
369 <ol> 369 <ol>
370 <li> 370 <li>
371 <a href="#method-StorageNamespace-clear">clear</a> 371 <a href="#method-StorageArea-clear">clear</a>
372 </li><li> 372 </li><li>
373 <a href="#method-StorageNamespace-get">get</a> 373 <a href="#method-StorageArea-get">get</a>
374 </li><li> 374 </li><li>
375 <a href="#method-StorageNamespace-remove">remove</a> 375 <a href="#method-StorageArea-getBytesInUse">getBytesInUse</a>
376 </li><li> 376 </li><li>
377 <a href="#method-StorageNamespace-set">set</a> 377 <a href="#method-StorageArea-remove">remove</a>
378 </li><li>
379 <a href="#method-StorageArea-set">set</a>
378 </li> 380 </li>
379 </ol> 381 </ol>
380 </li> 382 </li>
381 <li style="display: none; "> 383 <li style="display: none; ">
382 <a>Events</a> 384 <a>Events</a>
383 <ol> 385 <ol>
384 <li> 386 <li>
385 <a href="#event-anchor">eventName</a> 387 <a href="#event-anchor">eventName</a>
386 </li> 388 </li>
387 </ol> 389 </ol>
(...skipping 38 matching lines...) Expand 10 before | Expand all | Expand 10 after
426 <var>sync</var> 428 <var>sync</var>
427 <em> 429 <em>
428 430
429 <!-- TYPE --> 431 <!-- TYPE -->
430 <div style="display:inline"> 432 <div style="display:inline">
431 ( 433 (
432 <span class="optional" style="display: none; ">optional</spa n> 434 <span class="optional" style="display: none; ">optional</spa n>
433 <span class="enum" style="display: none; ">enumerated</span> 435 <span class="enum" style="display: none; ">enumerated</span>
434 <span id="typeTemplate"> 436 <span id="typeTemplate">
435 <span> 437 <span>
436 <a href="storage.html#type-StorageNamespace">StorageName space</a> 438 <a href="storage.html#type-StorageArea">StorageArea</a>
437 </span> 439 </span>
438 <span style="display: none; "> 440 <span style="display: none; ">
439 <span> 441 <span>
440 array of <span><span></span></span> 442 array of <span><span></span></span>
441 </span> 443 </span>
442 <span>paramType</span> 444 <span>paramType</span>
443 <span></span> 445 <span></span>
444 </span> 446 </span>
445 </span> 447 </span>
446 ) 448 )
(...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after
500 <var>local</var> 502 <var>local</var>
501 <em> 503 <em>
502 504
503 <!-- TYPE --> 505 <!-- TYPE -->
504 <div style="display:inline"> 506 <div style="display:inline">
505 ( 507 (
506 <span class="optional" style="display: none; ">optional</spa n> 508 <span class="optional" style="display: none; ">optional</spa n>
507 <span class="enum" style="display: none; ">enumerated</span> 509 <span class="enum" style="display: none; ">enumerated</span>
508 <span id="typeTemplate"> 510 <span id="typeTemplate">
509 <span> 511 <span>
510 <a href="storage.html#type-StorageNamespace">StorageName space</a> 512 <a href="storage.html#type-StorageArea">StorageArea</a>
511 </span> 513 </span>
512 <span style="display: none; "> 514 <span style="display: none; ">
513 <span> 515 <span>
514 array of <span><span></span></span> 516 array of <span><span></span></span>
515 </span> 517 </span>
516 <span>paramType</span> 518 <span>paramType</span>
517 <span></span> 519 <span></span>
518 </span> 520 </span>
519 </span> 521 </span>
520 ) 522 )
(...skipping 515 matching lines...) Expand 10 before | Expand all | Expand 10 after
1036 </dd> 1038 </dd>
1037 1039
1038 <!-- FUNCTION PARAMETERS --> 1040 <!-- FUNCTION PARAMETERS -->
1039 <dd style="display: none; "> 1041 <dd style="display: none; ">
1040 <div></div> 1042 <div></div>
1041 </dd> 1043 </dd>
1042 1044
1043 </div> 1045 </div>
1044 1046
1045 </div><div class="apiItem"> 1047 </div><div class="apiItem">
1046 <a name="type-StorageNamespace"></a> 1048 <a name="type-StorageArea"></a>
1047 <h4>StorageNamespace</h4> 1049 <h4>StorageArea</h4>
1048 1050
1049 <div> 1051 <div>
1050 <dt> 1052 <dt>
1051 <var style="display: none; ">paramName</var> 1053 <var style="display: none; ">paramName</var>
1052 <em> 1054 <em>
1053 1055
1054 <!-- TYPE --> 1056 <!-- TYPE -->
1055 <div style="display:inline"> 1057 <div style="display:inline">
1056 ( 1058 (
1057 <span class="optional" style="display: none; ">optional</spa n> 1059 <span class="optional" style="display: none; ">optional</spa n>
(...skipping 37 matching lines...) Expand 10 before | Expand all | Expand 10 after
1095 <div> 1097 <div>
1096 <div> 1098 <div>
1097 </div> 1099 </div>
1098 </div> 1100 </div>
1099 </dl> 1101 </dl>
1100 </dd> 1102 </dd>
1101 1103
1102 <!-- OBJECT METHODS --> 1104 <!-- OBJECT METHODS -->
1103 <dd> 1105 <dd>
1104 <div class="apiGroup" style=""> 1106 <div class="apiGroup" style="">
1105 <a name="global-StorageNamespace-methods"></a> 1107 <a name="global-StorageArea-methods"></a>
1106 <h3>Methods of StorageNamespace</h3> 1108 <h3>Methods of StorageArea</h3>
1107 1109
1108 <!-- iterates over all functions --> 1110 <!-- iterates over all functions -->
1109 <div class="apiItem"> 1111 <div class="apiItem">
1110 <a name="method-StorageNamespace-clear"></a> <!-- method-anchor -- > 1112 <a name="method-StorageArea-clear"></a> <!-- method-anchor -->
1111 <h4>clear</h4> 1113 <h4>clear</h4>
1112 1114
1113 <div class="summary"><span style="display: none; ">void</span> 1115 <div class="summary"><span style="display: none; ">void</span>
1114 <!-- Note: intentionally longer 80 columns --> 1116 <!-- Note: intentionally longer 80 columns -->
1115 <span>storageNamespace.clear</span>(<span class="optional"><sp an style="display: none; ">, </span><span>function</span> 1117 <span>storageArea.clear</span>(<span class="optional"><span st yle="display: none; ">, </span><span>function</span>
1116 <var><span>callback</span></var></span>)</div> 1118 <var><span>callback</span></var></span>)</div>
1117 1119
1118 <div class="description"> 1120 <div class="description">
1119 <p class="todo" style="display: none; ">Undocumented.</p> 1121 <p class="todo" style="display: none; ">Undocumented.</p>
1120 <p>Removes all items from storage.</p> 1122 <p>Removes all items from storage.</p>
1121 1123
1122 <!-- PARAMETERS --> 1124 <!-- PARAMETERS -->
1123 <h4>Parameters</h4> 1125 <h4>Parameters</h4>
1124 <dl> 1126 <dl>
1125 <div> 1127 <div>
(...skipping 103 matching lines...) Expand 10 before | Expand all | Expand 10 after
1229 <!-- MIN_VERSION --> 1231 <!-- MIN_VERSION -->
1230 <p style="display: none; "> 1232 <p style="display: none; ">
1231 This function was added in version <b><span></span></b>. 1233 This function was added in version <b><span></span></b>.
1232 If you require this function, the manifest key 1234 If you require this function, the manifest key
1233 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1235 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1234 can ensure that your extension won't be run in an earlier brow ser version. 1236 can ensure that your extension won't be run in an earlier brow ser version.
1235 </p> 1237 </p>
1236 </div> <!-- /description --> 1238 </div> <!-- /description -->
1237 1239
1238 </div><div class="apiItem"> 1240 </div><div class="apiItem">
1239 <a name="method-StorageNamespace-get"></a> <!-- method-anchor --> 1241 <a name="method-StorageArea-get"></a> <!-- method-anchor -->
1240 <h4>get</h4> 1242 <h4>get</h4>
1241 1243
1242 <div class="summary"><span style="display: none; ">void</span> 1244 <div class="summary"><span style="display: none; ">void</span>
1243 <!-- Note: intentionally longer 80 columns --> 1245 <!-- Note: intentionally longer 80 columns -->
1244 <span>storageNamespace.get</span>(<span class="optional"><span style="display: none; ">, </span><span>string or array of string or object</spa n> 1246 <span>storageArea.get</span>(<span class="optional"><span styl e="display: none; ">, </span><span>string or array of string or object</span>
1245 <var><span>keys</span></var></span><span class="null"><spa n>, </span><span>function</span> 1247 <var><span>keys</span></var></span><span class="null"><spa n>, </span><span>function</span>
1246 <var><span>callback</span></var></span>)</div> 1248 <var><span>callback</span></var></span>)</div>
1247 1249
1248 <div class="description"> 1250 <div class="description">
1249 <p class="todo" style="display: none; ">Undocumented.</p> 1251 <p class="todo" style="display: none; ">Undocumented.</p>
1250 <p>Gets one or more items from storage.</p> 1252 <p>Gets one or more items from storage.</p>
1251 1253
1252 <!-- PARAMETERS --> 1254 <!-- PARAMETERS -->
1253 <h4>Parameters</h4> 1255 <h4>Parameters</h4>
1254 <dl> 1256 <dl>
(...skipping 237 matching lines...) Expand 10 before | Expand all | Expand 10 after
1492 <!-- MIN_VERSION --> 1494 <!-- MIN_VERSION -->
1493 <p style="display: none; "> 1495 <p style="display: none; ">
1494 This function was added in version <b><span></span></b>. 1496 This function was added in version <b><span></span></b>.
1495 If you require this function, the manifest key 1497 If you require this function, the manifest key
1496 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1498 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1497 can ensure that your extension won't be run in an earlier brow ser version. 1499 can ensure that your extension won't be run in an earlier brow ser version.
1498 </p> 1500 </p>
1499 </div> <!-- /description --> 1501 </div> <!-- /description -->
1500 1502
1501 </div><div class="apiItem"> 1503 </div><div class="apiItem">
1502 <a name="method-StorageNamespace-remove"></a> <!-- method-anchor - -> 1504 <a name="method-StorageArea-getBytesInUse"></a> <!-- method-anchor -->
1503 <h4>remove</h4> 1505 <h4>getBytesInUse</h4>
1504 1506
1505 <div class="summary"><span style="display: none; ">void</span> 1507 <div class="summary"><span style="display: none; ">void</span>
1506 <!-- Note: intentionally longer 80 columns --> 1508 <!-- Note: intentionally longer 80 columns -->
1507 <span>storageNamespace.remove</span>(<span class="null"><span style="display: none; ">, </span><span>string or array of string</span> 1509 <span>storageArea.getBytesInUse</span>(<span class="null"><spa n style="display: none; ">, </span><span>function</span>
1510 <var><span>callback</span></var></span>)</div>
1511
1512 <div class="description">
1513 <p class="todo" style="display: none; ">Undocumented.</p>
1514 <p>Get the amount of space being used in storage, in bytes.</p>
1515
1516 <!-- PARAMETERS -->
1517 <h4>Parameters</h4>
1518 <dl>
1519 <div>
1520 <div>
1521 <dt>
1522 <var>callback</var>
1523 <em>
1524
1525 <!-- TYPE -->
1526 <div style="display:inline">
1527 (
1528 <span class="optional" style="display: none; ">optional</spa n>
1529 <span class="enum" style="display: none; ">enumerated</span>
1530 <span id="typeTemplate">
1531 <span style="display: none; ">
1532 <a> Type</a>
1533 </span>
1534 <span>
1535 <span style="display: none; ">
1536 array of <span><span></span></span>
1537 </span>
1538 <span>function</span>
1539 <span style="display: none; "></span>
1540 </span>
1541 </span>
1542 )
1543 </div>
1544
1545 </em>
1546 </dt>
1547 <dd class="todo" style="display: none; ">
1548 Undocumented.
1549 </dd>
1550 <dd>Callback with the amount of space being used by storage, or on fai lure (in which case lastError will be set).</dd>
1551 <dd style="display: none; ">
1552 This parameter was added in version
1553 <b><span></span></b>.
1554 You must omit this parameter in earlier versions,
1555 and you may omit it in any version. If you require this
1556 parameter, the manifest key
1557 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1558 can ensure that your extension won't be run in an earlier browser ve rsion.
1559 </dd>
1560
1561 <!-- OBJECT PROPERTIES -->
1562 <dd style="display: none; ">
1563 <dl>
1564 <div>
1565 <div>
1566 </div>
1567 </div>
1568 </dl>
1569 </dd>
1570
1571 <!-- OBJECT METHODS -->
1572 <dd style="display: none; ">
1573 <div></div>
1574 </dd>
1575
1576 <!-- OBJECT EVENT FIELDS -->
1577 <dd style="display: none; ">
1578 <div></div>
1579 </dd>
1580
1581 <!-- FUNCTION PARAMETERS -->
1582 <dd style="display: none; ">
1583 <div></div>
1584 </dd>
1585
1586 </div>
1587 </div>
1588 </dl>
1589
1590 <!-- RETURNS -->
1591 <h4 style="display: none; ">Returns</h4>
1592 <dl>
1593 <div style="display: none; ">
1594 <div>
1595 </div>
1596 </div>
1597 </dl>
1598
1599 <!-- CALLBACK -->
1600 <div>
1601 <div>
1602 <h4>Callback function</h4>
1603 <p>
1604 The callback <em>parameter</em> should specify a function
1605 that looks like this:
1606 </p>
1607 <p style="display: none; ">
1608 If you specify the <em>callback</em> parameter, it should
1609 specify a function that looks like this:
1610 </p>
1611
1612 <!-- Note: intentionally longer 80 columns -->
1613 <pre>function(<span>integer bytesInUse</span>) <span class="su bdued">{...}</span>;</pre>
1614 <dl>
1615 <div>
1616 <div>
1617 <dt>
1618 <var>bytesInUse</var>
1619 <em>
1620
1621 <!-- TYPE -->
1622 <div style="display:inline">
1623 (
1624 <span class="optional" style="display: none; ">optional</spa n>
1625 <span class="enum" style="display: none; ">enumerated</span>
1626 <span id="typeTemplate">
1627 <span style="display: none; ">
1628 <a> Type</a>
1629 </span>
1630 <span>
1631 <span style="display: none; ">
1632 array of <span><span></span></span>
1633 </span>
1634 <span>integer</span>
1635 <span style="display: none; "></span>
1636 </span>
1637 </span>
1638 )
1639 </div>
1640
1641 </em>
1642 </dt>
1643 <dd class="todo" style="display: none; ">
1644 Undocumented.
1645 </dd>
1646 <dd>Amount of space being used in storage, in bytes.</dd>
1647 <dd style="display: none; ">
1648 This parameter was added in version
1649 <b><span></span></b>.
1650 You must omit this parameter in earlier versions,
1651 and you may omit it in any version. If you require this
1652 parameter, the manifest key
1653 <a href="manifest.html#minimum_chrome_version">minimum_chrome_versio n</a>
1654 can ensure that your extension won't be run in an earlier browser ve rsion.
1655 </dd>
1656
1657 <!-- OBJECT PROPERTIES -->
1658 <dd style="display: none; ">
1659 <dl>
1660 <div>
1661 <div>
1662 </div>
1663 </div>
1664 </dl>
1665 </dd>
1666
1667 <!-- OBJECT METHODS -->
1668 <dd style="display: none; ">
1669 <div></div>
1670 </dd>
1671
1672 <!-- OBJECT EVENT FIELDS -->
1673 <dd style="display: none; ">
1674 <div></div>
1675 </dd>
1676
1677 <!-- FUNCTION PARAMETERS -->
1678 <dd style="display: none; ">
1679 <div></div>
1680 </dd>
1681
1682 </div>
1683 </div>
1684 </dl>
1685 </div>
1686 </div>
1687
1688 <!-- MIN_VERSION -->
1689 <p style="display: none; ">
1690 This function was added in version <b><span></span></b>.
1691 If you require this function, the manifest key
1692 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1693 can ensure that your extension won't be run in an earlier brow ser version.
1694 </p>
1695 </div> <!-- /description -->
1696
1697 </div><div class="apiItem">
1698 <a name="method-StorageArea-remove"></a> <!-- method-anchor -->
1699 <h4>remove</h4>
1700
1701 <div class="summary"><span style="display: none; ">void</span>
1702 <!-- Note: intentionally longer 80 columns -->
1703 <span>storageArea.remove</span>(<span class="null"><span style ="display: none; ">, </span><span>string or array of string</span>
1508 <var><span>keys</span></var></span><span class="optional"> <span>, </span><span>function</span> 1704 <var><span>keys</span></var></span><span class="optional"> <span>, </span><span>function</span>
1509 <var><span>callback</span></var></span>)</div> 1705 <var><span>callback</span></var></span>)</div>
1510 1706
1511 <div class="description"> 1707 <div class="description">
1512 <p class="todo" style="display: none; ">Undocumented.</p> 1708 <p class="todo" style="display: none; ">Undocumented.</p>
1513 <p>Removes one or more items from storage.</p> 1709 <p>Removes one or more items from storage.</p>
1514 1710
1515 <!-- PARAMETERS --> 1711 <!-- PARAMETERS -->
1516 <h4>Parameters</h4> 1712 <h4>Parameters</h4>
1517 <dl> 1713 <dl>
(...skipping 172 matching lines...) Expand 10 before | Expand all | Expand 10 after
1690 <!-- MIN_VERSION --> 1886 <!-- MIN_VERSION -->
1691 <p style="display: none; "> 1887 <p style="display: none; ">
1692 This function was added in version <b><span></span></b>. 1888 This function was added in version <b><span></span></b>.
1693 If you require this function, the manifest key 1889 If you require this function, the manifest key
1694 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a> 1890 <a href="manifest.html#minimum_chrome_version">minimum_chrome_ version</a>
1695 can ensure that your extension won't be run in an earlier brow ser version. 1891 can ensure that your extension won't be run in an earlier brow ser version.
1696 </p> 1892 </p>
1697 </div> <!-- /description --> 1893 </div> <!-- /description -->
1698 1894
1699 </div><div class="apiItem"> 1895 </div><div class="apiItem">
1700 <a name="method-StorageNamespace-set"></a> <!-- method-anchor --> 1896 <a name="method-StorageArea-set"></a> <!-- method-anchor -->
1701 <h4>set</h4> 1897 <h4>set</h4>
1702 1898
1703 <div class="summary"><span style="display: none; ">void</span> 1899 <div class="summary"><span style="display: none; ">void</span>
1704 <!-- Note: intentionally longer 80 columns --> 1900 <!-- Note: intentionally longer 80 columns -->
1705 <span>storageNamespace.set</span>(<span class="null"><span sty le="display: none; ">, </span><span>object</span> 1901 <span>storageArea.set</span>(<span class="null"><span style="d isplay: none; ">, </span><span>object</span>
1706 <var><span>items</span></var></span><span class="optional" ><span>, </span><span>function</span> 1902 <var><span>items</span></var></span><span class="optional" ><span>, </span><span>function</span>
1707 <var><span>callback</span></var></span>)</div> 1903 <var><span>callback</span></var></span>)</div>
1708 1904
1709 <div class="description"> 1905 <div class="description">
1710 <p class="todo" style="display: none; ">Undocumented.</p> 1906 <p class="todo" style="display: none; ">Undocumented.</p>
1711 <p>Sets multiple items.</p> 1907 <p>Sets multiple items.</p>
1712 1908
1713 <!-- PARAMETERS --> 1909 <!-- PARAMETERS -->
1714 <h4>Parameters</h4> 1910 <h4>Parameters</h4>
1715 <dl> 1911 <dl>
(...skipping 233 matching lines...) Expand 10 before | Expand all | Expand 10 after
1949 _uff=0; 2145 _uff=0;
1950 urchinTracker(); 2146 urchinTracker();
1951 } 2147 }
1952 catch(e) {/* urchinTracker not available. */} 2148 catch(e) {/* urchinTracker not available. */}
1953 </script> 2149 </script>
1954 <!-- end analytics --> 2150 <!-- end analytics -->
1955 </div> 2151 </div>
1956 </div> <!-- /gc-footer --> 2152 </div> <!-- /gc-footer -->
1957 </div> <!-- /gc-container --> 2153 </div> <!-- /gc-container -->
1958 </body></html> 2154 </body></html>
OLDNEW
« chrome/common/extensions/api/storage.json ('K') | « chrome/common/extensions/api/storage.json ('k') | chrome/renderer/resources/extensions/schema_generated_bindings.js » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698