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 217 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
228 <ol> | 228 <ol> |
229 <li> | 229 <li> |
230 <a href="#event-onChanged">onChanged</a> | 230 <a href="#event-onChanged">onChanged</a> |
231 </li> | 231 </li> |
232 </ol> | 232 </ol> |
233 </li> | 233 </li> |
234 <li> | 234 <li> |
235 <a href="#types">Types</a> | 235 <a href="#types">Types</a> |
236 <ol> | 236 <ol> |
237 <li> | 237 <li> |
238 <a href="#type-StorageChange">null</a> | 238 <a href="#type-storage.StorageChange">StorageChange</a> |
239 <ol> | 239 <ol> |
240 </ol> | 240 </ol> |
241 </li><li> | 241 </li><li> |
242 <a href="#type-StorageArea">null</a> | 242 <a href="#type-storage.StorageArea">StorageArea</a> |
243 <ol> | 243 <ol> |
244 <li> | 244 <li> |
245 <a href="#global-StorageArea-methods">Methods</a> | 245 <a href="#global-storage.StorageArea-methods">Methods</a> |
246 <ol> | 246 <ol> |
247 <li> | 247 <li> |
248 <a href="#method-StorageArea-clear">clear</a> | 248 <a href="#method-storage.StorageArea-clear">clear</a> |
249 </li><li> | 249 </li><li> |
250 <a href="#method-StorageArea-get">get</a> | 250 <a href="#method-storage.StorageArea-get">get</a> |
251 </li><li> | 251 </li><li> |
252 <a href="#method-StorageArea-getBytesInUse">getBytesInUse</a> | 252 <a href="#method-storage.StorageArea-getBytesInUse">getBytesInUs
e</a> |
253 </li><li> | 253 </li><li> |
254 <a href="#method-StorageArea-remove">remove</a> | 254 <a href="#method-storage.StorageArea-remove">remove</a> |
255 </li><li> | 255 </li><li> |
256 <a href="#method-StorageArea-set">set</a> | 256 <a href="#method-storage.StorageArea-set">set</a> |
257 </li> | 257 </li> |
258 </ol> | 258 </ol> |
259 </li> | 259 </li> |
260 </ol> | 260 </ol> |
261 </li> | 261 </li> |
262 </ol> | 262 </ol> |
263 </li> | 263 </li> |
264 </ol> | 264 </ol> |
265 </li> | 265 </li> |
266 </ol> | 266 </ol> |
(...skipping 142 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
409 </div> | 409 </div> |
410 <div> | 410 <div> |
411 <dt> | 411 <dt> |
412 <var>sync</var> | 412 <var>sync</var> |
413 <em> | 413 <em> |
414 <!-- TYPE --> | 414 <!-- TYPE --> |
415 <div style="display:inline"> | 415 <div style="display:inline"> |
416 ( | 416 ( |
417 <span id="typeTemplate"> | 417 <span id="typeTemplate"> |
418 <span> | 418 <span> |
419 <a href="storage.html#type-StorageArea">StorageArea</a> | 419 <a href="storage.html#type-storage.StorageArea">storage.
StorageArea</a> |
420 </span> | 420 </span> |
421 </span> | 421 </span> |
422 ) | 422 ) |
423 </div> | 423 </div> |
424 </em> | 424 </em> |
425 </dt> | 425 </dt> |
426 <dd>Items under the "sync" namespace are synced using Chrome Sync.</dd
> | 426 <dd>Items under the "sync" namespace are synced using Chrome Sync.</dd
> |
427 <!-- OBJECT PROPERTIES --> | 427 <!-- OBJECT PROPERTIES --> |
428 <dd> | 428 <dd> |
429 <dl> | 429 <dl> |
(...skipping 118 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
548 </div> | 548 </div> |
549 <div> | 549 <div> |
550 <dt> | 550 <dt> |
551 <var>local</var> | 551 <var>local</var> |
552 <em> | 552 <em> |
553 <!-- TYPE --> | 553 <!-- TYPE --> |
554 <div style="display:inline"> | 554 <div style="display:inline"> |
555 ( | 555 ( |
556 <span id="typeTemplate"> | 556 <span id="typeTemplate"> |
557 <span> | 557 <span> |
558 <a href="storage.html#type-StorageArea">StorageArea</a> | 558 <a href="storage.html#type-storage.StorageArea">storage.
StorageArea</a> |
559 </span> | 559 </span> |
560 </span> | 560 </span> |
561 ) | 561 ) |
562 </div> | 562 </div> |
563 </em> | 563 </em> |
564 </dt> | 564 </dt> |
565 <dd>Items under the "local" namespace are local to each machine.</dd> | 565 <dd>Items under the "local" namespace are local to each machine.</dd> |
566 <!-- OBJECT PROPERTIES --> | 566 <!-- OBJECT PROPERTIES --> |
567 <dd> | 567 <dd> |
568 <dl> | 568 <dl> |
(...skipping 103 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
672 </div> <!-- /description --> | 672 </div> <!-- /description --> |
673 <!-- /description --> | 673 <!-- /description --> |
674 </div> <!-- /apiItem --> | 674 </div> <!-- /apiItem --> |
675 </div> <!-- /apiGroup --> | 675 </div> <!-- /apiGroup --> |
676 <!-- TYPES --> | 676 <!-- TYPES --> |
677 <div class="apiGroup"> | 677 <div class="apiGroup"> |
678 <a name="types"></a> | 678 <a name="types"></a> |
679 <h3 id="types">Types</h3> | 679 <h3 id="types">Types</h3> |
680 <!-- iterates over all types --> | 680 <!-- iterates over all types --> |
681 <div class="apiItem"> | 681 <div class="apiItem"> |
682 <a name="type-StorageChange"></a> | 682 <a name="type-storage.StorageChange"></a> |
683 <h4>StorageChange</h4> | 683 <h4>storage.StorageChange</h4> |
684 <div> | 684 <div> |
685 <dt> | 685 <dt> |
686 <em> | 686 <em> |
687 <!-- TYPE --> | 687 <!-- TYPE --> |
688 <div style="display:inline"> | 688 <div style="display:inline"> |
689 ( | 689 ( |
690 <span id="typeTemplate"> | 690 <span id="typeTemplate"> |
691 <span> | 691 <span> |
692 <span>object</span> | 692 <span>object</span> |
693 </span> | 693 </span> |
(...skipping 57 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
751 <!-- FUNCTION PARAMETERS --> | 751 <!-- FUNCTION PARAMETERS --> |
752 </div> | 752 </div> |
753 </div> | 753 </div> |
754 </dl> | 754 </dl> |
755 </dd> | 755 </dd> |
756 <!-- OBJECT METHODS --> | 756 <!-- OBJECT METHODS --> |
757 <!-- OBJECT EVENT FIELDS --> | 757 <!-- OBJECT EVENT FIELDS --> |
758 <!-- FUNCTION PARAMETERS --> | 758 <!-- FUNCTION PARAMETERS --> |
759 </div> | 759 </div> |
760 </div><div class="apiItem"> | 760 </div><div class="apiItem"> |
761 <a name="type-StorageArea"></a> | 761 <a name="type-storage.StorageArea"></a> |
762 <h4>StorageArea</h4> | 762 <h4>storage.StorageArea</h4> |
763 <div> | 763 <div> |
764 <dt> | 764 <dt> |
765 <em> | 765 <em> |
766 <!-- TYPE --> | 766 <!-- TYPE --> |
767 <div style="display:inline"> | 767 <div style="display:inline"> |
768 ( | 768 ( |
769 <span id="typeTemplate"> | 769 <span id="typeTemplate"> |
770 <span> | 770 <span> |
771 <span>object</span> | 771 <span>object</span> |
772 </span> | 772 </span> |
773 </span> | 773 </span> |
774 ) | 774 ) |
775 </div> | 775 </div> |
776 </em> | 776 </em> |
777 </dt> | 777 </dt> |
778 <dd class="todo"> | 778 <dd class="todo"> |
779 Undocumented. | 779 Undocumented. |
780 </dd> | 780 </dd> |
781 <!-- OBJECT PROPERTIES --> | 781 <!-- OBJECT PROPERTIES --> |
782 <!-- OBJECT METHODS --> | 782 <!-- OBJECT METHODS --> |
783 <dd> | 783 <dd> |
784 <div class="apiGroup"> | 784 <div class="apiGroup"> |
785 <a name="global-StorageArea-methods"></a> | 785 <a name="global-storage.StorageArea-methods"></a> |
786 <h3>Methods of StorageArea</h3> | 786 <h3>Methods of storage.StorageArea</h3> |
787 <!-- iterates over all functions --> | 787 <!-- iterates over all functions --> |
788 <div class="apiItem"> | 788 <div class="apiItem"> |
789 <a name="method-StorageArea-clear"></a> <!-- method-anchor --> | 789 <a name="method-storage.StorageArea-clear"></a> <!-- method-anchor
--> |
790 <h4>clear</h4> | 790 <h4>clear</h4> |
791 <div class="summary"> | 791 <div class="summary"> |
792 <!-- Note: intentionally longer 80 columns --> | 792 <!-- Note: intentionally longer 80 columns --> |
793 <span>storageArea.clear</span>(<span class="optional"><span>fu
nction</span> | 793 <span>storage.StorageArea.clear</span>(<span class="optional">
<span>function</span> |
794 <var><span>callback</span></var></span>)</div> | 794 <var><span>callback</span></var></span>)</div> |
795 <div class="description"> | 795 <div class="description"> |
796 <p>Removes all items from storage.</p> | 796 <p>Removes all items from storage.</p> |
797 <!-- PARAMETERS --> | 797 <!-- PARAMETERS --> |
798 <h4>Parameters</h4> | 798 <h4>Parameters</h4> |
799 <dl> | 799 <dl> |
800 <div> | 800 <div> |
801 <div> | 801 <div> |
802 <dt> | 802 <dt> |
803 <var>callback</var> | 803 <var>callback</var> |
(...skipping 19 matching lines...) Expand all Loading... |
823 </div> | 823 </div> |
824 </div> | 824 </div> |
825 </dl> | 825 </dl> |
826 <!-- RETURNS --> | 826 <!-- RETURNS --> |
827 <dl> | 827 <dl> |
828 </dl> | 828 </dl> |
829 <!-- CALLBACK --> | 829 <!-- CALLBACK --> |
830 <!-- MIN_VERSION --> | 830 <!-- MIN_VERSION --> |
831 </div> <!-- /description --> | 831 </div> <!-- /description --> |
832 </div><div class="apiItem"> | 832 </div><div class="apiItem"> |
833 <a name="method-StorageArea-get"></a> <!-- method-anchor --> | 833 <a name="method-storage.StorageArea-get"></a> <!-- method-anchor -
-> |
834 <h4>get</h4> | 834 <h4>get</h4> |
835 <div class="summary"> | 835 <div class="summary"> |
836 <!-- Note: intentionally longer 80 columns --> | 836 <!-- Note: intentionally longer 80 columns --> |
837 <span>storageArea.get</span>(<span class="optional"><span>stri
ng or array of string or object</span> | 837 <span>storage.StorageArea.get</span>(<span class="optional"><s
pan>string or array of string or object</span> |
838 <var><span>keys</span></var></span><span class="null"><spa
n>, </span><span>function</span> | 838 <var><span>keys</span></var></span><span class="null"><spa
n>, </span><span>function</span> |
839 <var><span>callback</span></var></span>)</div> | 839 <var><span>callback</span></var></span>)</div> |
840 <div class="description"> | 840 <div class="description"> |
841 <p>Gets one or more items from storage.</p> | 841 <p>Gets one or more items from storage.</p> |
842 <!-- PARAMETERS --> | 842 <!-- PARAMETERS --> |
843 <h4>Parameters</h4> | 843 <h4>Parameters</h4> |
844 <dl> | 844 <dl> |
845 <div> | 845 <div> |
846 <div> | 846 <div> |
847 <dt> | 847 <dt> |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
891 </div> | 891 </div> |
892 </div> | 892 </div> |
893 </dl> | 893 </dl> |
894 <!-- RETURNS --> | 894 <!-- RETURNS --> |
895 <dl> | 895 <dl> |
896 </dl> | 896 </dl> |
897 <!-- CALLBACK --> | 897 <!-- CALLBACK --> |
898 <!-- MIN_VERSION --> | 898 <!-- MIN_VERSION --> |
899 </div> <!-- /description --> | 899 </div> <!-- /description --> |
900 </div><div class="apiItem"> | 900 </div><div class="apiItem"> |
901 <a name="method-StorageArea-getBytesInUse"></a> <!-- method-anchor
--> | 901 <a name="method-storage.StorageArea-getBytesInUse"></a> <!-- metho
d-anchor --> |
902 <h4>getBytesInUse</h4> | 902 <h4>getBytesInUse</h4> |
903 <div class="summary"> | 903 <div class="summary"> |
904 <!-- Note: intentionally longer 80 columns --> | 904 <!-- Note: intentionally longer 80 columns --> |
905 <span>storageArea.getBytesInUse</span>(<span class="optional">
<span>string or array of string</span> | 905 <span>storage.StorageArea.getBytesInUse</span>(<span class="op
tional"><span>string or array of string</span> |
906 <var><span>keys</span></var></span><span class="null"><spa
n>, </span><span>function</span> | 906 <var><span>keys</span></var></span><span class="null"><spa
n>, </span><span>function</span> |
907 <var><span>callback</span></var></span>)</div> | 907 <var><span>callback</span></var></span>)</div> |
908 <div class="description"> | 908 <div class="description"> |
909 <p>Gets the amount of space (in bytes) being used by one or more
items.</p> | 909 <p>Gets the amount of space (in bytes) being used by one or more
items.</p> |
910 <!-- PARAMETERS --> | 910 <!-- PARAMETERS --> |
911 <h4>Parameters</h4> | 911 <h4>Parameters</h4> |
912 <dl> | 912 <dl> |
913 <div> | 913 <div> |
914 <div> | 914 <div> |
915 <dt> | 915 <dt> |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
959 </div> | 959 </div> |
960 </div> | 960 </div> |
961 </dl> | 961 </dl> |
962 <!-- RETURNS --> | 962 <!-- RETURNS --> |
963 <dl> | 963 <dl> |
964 </dl> | 964 </dl> |
965 <!-- CALLBACK --> | 965 <!-- CALLBACK --> |
966 <!-- MIN_VERSION --> | 966 <!-- MIN_VERSION --> |
967 </div> <!-- /description --> | 967 </div> <!-- /description --> |
968 </div><div class="apiItem"> | 968 </div><div class="apiItem"> |
969 <a name="method-StorageArea-remove"></a> <!-- method-anchor --> | 969 <a name="method-storage.StorageArea-remove"></a> <!-- method-ancho
r --> |
970 <h4>remove</h4> | 970 <h4>remove</h4> |
971 <div class="summary"> | 971 <div class="summary"> |
972 <!-- Note: intentionally longer 80 columns --> | 972 <!-- Note: intentionally longer 80 columns --> |
973 <span>storageArea.remove</span>(<span class="null"><span>strin
g or array of string</span> | 973 <span>storage.StorageArea.remove</span>(<span class="null"><sp
an>string or array of string</span> |
974 <var><span>keys</span></var></span><span class="optional">
<span>, </span><span>function</span> | 974 <var><span>keys</span></var></span><span class="optional">
<span>, </span><span>function</span> |
975 <var><span>callback</span></var></span>)</div> | 975 <var><span>callback</span></var></span>)</div> |
976 <div class="description"> | 976 <div class="description"> |
977 <p>Removes one or more items from storage.</p> | 977 <p>Removes one or more items from storage.</p> |
978 <!-- PARAMETERS --> | 978 <!-- PARAMETERS --> |
979 <h4>Parameters</h4> | 979 <h4>Parameters</h4> |
980 <dl> | 980 <dl> |
981 <div> | 981 <div> |
982 <div> | 982 <div> |
983 <dt> | 983 <dt> |
(...skipping 43 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1027 </div> | 1027 </div> |
1028 </div> | 1028 </div> |
1029 </dl> | 1029 </dl> |
1030 <!-- RETURNS --> | 1030 <!-- RETURNS --> |
1031 <dl> | 1031 <dl> |
1032 </dl> | 1032 </dl> |
1033 <!-- CALLBACK --> | 1033 <!-- CALLBACK --> |
1034 <!-- MIN_VERSION --> | 1034 <!-- MIN_VERSION --> |
1035 </div> <!-- /description --> | 1035 </div> <!-- /description --> |
1036 </div><div class="apiItem"> | 1036 </div><div class="apiItem"> |
1037 <a name="method-StorageArea-set"></a> <!-- method-anchor --> | 1037 <a name="method-storage.StorageArea-set"></a> <!-- method-anchor -
-> |
1038 <h4>set</h4> | 1038 <h4>set</h4> |
1039 <div class="summary"> | 1039 <div class="summary"> |
1040 <!-- Note: intentionally longer 80 columns --> | 1040 <!-- Note: intentionally longer 80 columns --> |
1041 <span>storageArea.set</span>(<span class="null"><span>object</
span> | 1041 <span>storage.StorageArea.set</span>(<span class="null"><span>
object</span> |
1042 <var><span>items</span></var></span><span class="optional"
><span>, </span><span>function</span> | 1042 <var><span>items</span></var></span><span class="optional"
><span>, </span><span>function</span> |
1043 <var><span>callback</span></var></span>)</div> | 1043 <var><span>callback</span></var></span>)</div> |
1044 <div class="description"> | 1044 <div class="description"> |
1045 <p>Sets multiple items.</p> | 1045 <p>Sets multiple items.</p> |
1046 <!-- PARAMETERS --> | 1046 <!-- PARAMETERS --> |
1047 <h4>Parameters</h4> | 1047 <h4>Parameters</h4> |
1048 <dl> | 1048 <dl> |
1049 <div> | 1049 <div> |
1050 <div> | 1050 <div> |
1051 <dt> | 1051 <dt> |
(...skipping 97 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
1149 _uff=0; | 1149 _uff=0; |
1150 urchinTracker(); | 1150 urchinTracker(); |
1151 } | 1151 } |
1152 catch(e) {/* urchinTracker not available. */} | 1152 catch(e) {/* urchinTracker not available. */} |
1153 </script> | 1153 </script> |
1154 <!-- end analytics --> | 1154 <!-- end analytics --> |
1155 </div> | 1155 </div> |
1156 </div> <!-- /gc-footer --> | 1156 </div> <!-- /gc-footer --> |
1157 </div> <!-- /gc-container --> | 1157 </div> <!-- /gc-container --> |
1158 </body></html> | 1158 </body></html> |
OLD | NEW |