This repository has been archived by the owner on Mar 29, 2019. It is now read-only.
/
simple-storage.html
537 lines (421 loc) · 19.8 KB
/
simple-storage.html
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
<!DOCTYPE HTML PUBLIC "-//W</div3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
<html lang="en">
<head>
<base>
<meta content="text/html; charset=utf-8" http-equiv="Content-type">
<script src="../../static-files/syntaxhighlighter/scripts/shCore.js" type="text/javascript"></script>
<script src="../../static-files/syntaxhighlighter/scripts/shBrushCss.js" type="text/javascript"></script>
<script src="../../static-files/syntaxhighlighter/scripts/shBrushXml.js" type="text/javascript"></script>
<script src="../../static-files/syntaxhighlighter/scripts/shBrushJScript.js" type="text/javascript"></script>
<link media="all" href="../../static-files/css/base.css" type="text/css" rel="stylesheet">
<link media="all" href="../../static-files/css/header.css" type="text/css" rel="stylesheet">
<link media="all" href="../../static-files/css/footer.css" type="text/css" rel="stylesheet">
<link media="all" href="../../static-files/css/sdk-docs.css" type="text/css" rel="stylesheet">
<link media="all" href="../../static-files/css/api-reference.css" type="text/css" rel="stylesheet">
<link href="../../static-files/syntaxhighlighter/styles/shCore.css" type="text/css" rel="stylesheet">
<link href="../../static-files/syntaxhighlighter/styles/shThemeDefault.css" type="text/css" rel="stylesheet">
<!--[if IE]>
<style type="text/css">
.package-summary .module,
.package-entry .module,
.package-detail .module {
display: block;
}
</style>
<![endif]-->
<link href="../../static-files/media/favicon.png" type="image/x-icon" rel="shortcut icon">
<title>simple-storage - Add-on SDK Documentation</title>
</head>
<body><div id="obsolete-warning" style="background-color: rgb(251, 237, 237); border: 1px solid rgb(172,98,98); padding:5px 5px 5px 25px;">
<a style="display:block" href="../../../../sdk/1.13/modules/sdk/simple-storage.html">
You're looking at the docs for an old version of the SDK. Click here to read the latest version.</a></div>
<div style="position:relative">
<div id="global-header">
<div class="funnel">
<a href="http://www.mozilla.org/?ref=logo" id="mozilla-tab">Mozilla</a>
<div class="menu">
<p>
<a href="https://builder.addons.mozilla.org/">Add-on Builder</a>
</p>
<p>
<a href="https://addons.mozilla.org/en-US/developers/">Developer Hub</a>
</p>
</div>
</div>
</div>
<div id="site-header">
<div class="funnel">
<h1>
<a href="../../dev-guide/index.html">Add-on SDK<span></span></a>
</h1>
<div id="version">Version 1.10</div>
</div>
</div>
<div id="container">
<div id="columns">
<div id="main-content-column" class="column">
<div id="toc"></div>
<div id="main-content">
<div id="simple-storage_module_api_docs" class="module_api_docs">
<h1>simple-storage</h1>
<div class="module_description"><!-- This Source Code Form is subject to the terms of the Mozilla Public
- License, v. 2.0. If a copy of the MPL was not distributed with this
- file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
<p>The <code>simple-storage</code> module lets you easily and persistently store data across
Firefox restarts. If you're familiar with <a href="https://developer.mozilla.org/en/DOM/Storage">DOM storage</a> on the Web, it's
kind of like that, but for add-ons.</p>
<p>The simple storage module exports an object called <code>storage</code> that is persistent
and private to your add-on. It's a normal JavaScript object, and you can treat
it as you would any other.</p>
<p>To store a value, just assign it to a property on <code>storage</code>:</p>
<pre><code>var ss = require("simple-storage");
ss.storage.myArray = [1, 1, 2, 3, 5, 8, 13];
ss.storage.myBoolean = true;
ss.storage.myNull = null;
ss.storage.myNumber = 3.1337;
ss.storage.myObject = { a: "foo", b: { c: true }, d: null };
ss.storage.myString = "O frabjous day!";
</code></pre>
<p>You can store array, boolean, number, object, null, and string values.
If you'd like to store other types of values, you'll first have to convert
them to strings or another one of these types.</p>
<p>Be careful to set properties on the <code>storage</code> object and not the module itself:</p>
<pre><code>// This is no good!
var ss = require("simple-storage");
ss.foo = "I will not be saved! :(";
</code></pre>
<h2>Simple Storage and "cfx run"</h2>
<p>The simple storage module stores its data in your profile.
Because <code>cfx run</code> by default uses a fresh profile each time it runs,
simple storage won't work with add-ons executed using <code>cfx run</code> - that
is, stored data will not persist from one run to the next.</p>
<p>The easiest solution to this problem is to use the
<a href="../../dev-guide/cfx-tool.html#profiledir"><code>--profiledir</code> option to <code>cfx run</code></a>.</p>
<p>If you use this method, you must end your debugging session by
quitting Firefox normally, not by cancelling the shell command.
If you don't close Firefox normally, then simple storage will
not be notified that the session is finished, and will not write
your data to the backing store.</p>
<h2>Constructing Arrays</h2>
<p>Be careful to construct array objects conditionally in your code, or you may
zero them each time the construction code runs. For example, this add-on
tries to store the URLs of pages the user visits:</p>
<pre><code>
var ss = require("simple-storage");
ss.storage.pages = [];
require("tabs").on("ready", function(tab) {
ss.storage.pages.push(tab.url);
});
var widget = require("widget").Widget({
id: "log_history",
label: "Log History",
width: 30,
content: "Log",
onClick: function() {
console.log(ss.storage.pages);
}
});
</code></pre>
<p>But this isn't going to work, because it empties the array each time the
add-on runs (for example, each time Firefox is started). Line 2 needs
to be made conditional, so the array is only constructed if it does
not already exist:</p>
<pre><code>
if (!ss.storage.pages)
ss.storage.pages = [];
</code></pre>
<h2>Deleting Data</h2>
<p>You can delete properties using the <code>delete</code> operator. Here's an add-on
that adds three widgets to write, read, and delete a value:</p>
<pre><code>
var widgets = require("widget");
var ss = require("simple-storage");
var widget = widgets.Widget({
id: "write",
label: "Write",
width: 50,
content: "Write",
onClick: function() {
ss.storage.value = 1;
console.log("Setting value");
}
});
var widget = widgets.Widget({
id: "read",
label: "Read",
width: 50,
content: "Read",
onClick: function() {
console.log(ss.storage.value);
}
});
var widget = widgets.Widget({
id: "delete",
label: "Delete",
width: 50,
content: "Delete",
onClick: function() {
delete ss.storage.value;
console.log("Deleting value");
}
});
</pre></code>
<p>If you run it, you'll see that after clicking "Read" after clicking
"Delete" gives you the expected output:</p>
<pre>
info: undefined
</pre>
<h2>Quotas</h2>
<p>The simple storage available to your add-on is limited. Currently this limit is
about five megabytes (5,242,880 bytes). You can choose to be notified when you
go over quota, and you should respond by reducing the amount of data in storage.
If the user quits the application while you are over quota, all data stored
since the last time you were under quota will not be persisted. You should not
let that happen.</p>
<p>To listen for quota notifications, register a listener for the <code>"OverQuota"</code>
event. It will be called when your storage goes over quota.</p>
<pre><code>function myOnOverQuotaListener() {
console.log("Uh oh.");
}
ss.on("OverQuota", myOnOverQuotaListener);
</code></pre>
<p>Listeners can also be removed:</p>
<pre><code>ss.removeListener("OverQuota", myOnOverQuotaListener);
</code></pre>
<p>To find out how much of your quota you're using, check the module's <code>quotaUsage</code>
property. It indicates the percentage of quota your storage occupies. If
you're within your quota, it's a number from 0 to 1, inclusive, and if you're
over, it's a number greater than 1.</p>
<p>Therefore, when you're notified that you're over quota, respond by removing
storage until your <code>quotaUsage</code> is less than or equal to 1. Which particular
data you remove is up to you. For example:</p>
<pre><code>ss.storage.myList = [ /* some long array */ ];
ss.on("OverQuota", function () {
while (ss.quotaUsage > 1)
ss.storage.myList.pop();
});
</code></pre>
<h2>Private Browsing</h2>
<p>If your storage is related to your users' Web history, personal information, or
other sensitive data, your add-on should respect <a href="http://support.mozilla.com/en-US/kb/Private+Browsing">private browsing mode</a>.
While private browsing mode is active, you should not store any sensitive data.</p>
<p>Because any kind of data can be placed into simple storage, support for private
browsing is not built into the module. Instead, use the
<a href="../../packages/addon-kit/private-browsing.html"><code>private-browsing</code></a> module to
check private browsing status and respond accordingly.</p>
<p>For example, the URLs your users visit should not be stored during private
browsing. If your add-on records the URL of the selected tab, here's how you
might handle that:</p>
<pre><code>ss.storage.history = [];
var privateBrowsing = require("private-browsing");
if (!privateBrowsing.isActive) {
var url = getSelectedTabURL();
ss.storage.history.push(url);
}
</code></pre>
<p>For more information on supporting private browsing, see its <a href="https://developer.mozilla.org/En/Supporting_private_browsing_mode">Mozilla Developer
Network documentation</a>. While that page does not apply specifically to
SDK-based add-ons (and its code samples don't apply at all), you should follow
its guidance on best practices and policies.</p>
</div>
<div class="api_reference">
<h2 class="api_header">API Reference</h2>
<div class="api_component_group">
<h3 class="api_header">Properties</h3>
<div class="api_component">
<h4 class="api_name">storage : <span class="datatype">object</span></h4>
<p>A persistent object private to your add-on. Properties with array, boolean,
number, object, null, and string values will be persisted.</p>
</div>
<div class="api_component">
<h4 class="api_name">quotaUsage : <span class="datatype">number</span></h4>
<p>A number in the range [0, Infinity) that indicates the percentage of quota
occupied by storage. A value in the range [0, 1] indicates that the storage
is within quota. A value greater than 1 indicates that the storage exceeds
quota.</p>
</div>
</div>
<div class="api_component_group">
<h3 class="api_header">Events</h3>
<div class="api_component">
<h4 class="api_name">OverQuota</h4>
<p>The module emits this event when your add-on's storage goes over its quota.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div id="sidebar" class="column">
<div class="sidebar-section" id="addon-development">
<a href="../../dev-guide/index.html"><h2 class="sidebar-section-header">Developer Guide</h2></a>
<ul class="sidebar-section-contents" id="default-section-contents">
<li class="sidebar-subsection">
<a href="../../dev-guide/tutorials/installation.html"><h3>Installation</h3></a>
</li>
<li class="sidebar-subsection">
<a href="../../dev-guide/tutorials/index.html"><h3 class="sidebar-subsection-header">Tutorials</h3></a>
</li>
<li class="sidebar-subsection">
<a href="../../dev-guide/guides/index.html"><h3 class="sidebar-subsection-header">Guides</h3></a>
</li>
<li class="sidebar-subsection" id="third-party-packages-subsection">
<a href="../../dev-guide/third-party-apis.html"><h3 class="sidebar-subsection-header">Third-Party APIs</h3></a>
<div class="sidebar-subsection-contents">
<ul id="third-party-package-summaries"></ul>
</div>
</li>
<li class="sidebar-subsection">
<a href="../../dev-guide/high-level-apis.html"><h3 class="sidebar-subsection-header">High-Level APIs</h3></a>
<div class="sidebar-subsection-contents">
<ul id="high-level-package-summaries">
<li style="display: block;" class="package-summary">
<h4>
<a href="../../packages/addon-kit/index.html">addon-kit</a>
</h4>
<a href="../../packages/addon-kit/addon-page.html">addon-page</a>
<a href="../../packages/addon-kit/clipboard.html">clipboard</a>
<a href="../../packages/addon-kit/context-menu.html">context-menu</a>
<a href="../../packages/addon-kit/hotkeys.html">hotkeys</a>
<a href="../../packages/addon-kit/l10n.html">l10n</a>
<a href="../../packages/addon-kit/notifications.html">notifications</a>
<a href="../../packages/addon-kit/page-mod.html">page-mod</a>
<a href="../../packages/addon-kit/page-worker.html">page-worker</a>
<a href="../../packages/addon-kit/panel.html">panel</a>
<a href="../../packages/addon-kit/passwords.html">passwords</a>
<a href="../../packages/addon-kit/private-browsing.html">private-browsing</a>
<a href="../../packages/addon-kit/request.html">request</a>
<a href="../../packages/addon-kit/selection.html">selection</a>
<a href="../../packages/addon-kit/self.html">self</a>
<a href="../../packages/addon-kit/simple-prefs.html">simple-prefs</a>
<a href="../../packages/addon-kit/simple-storage.html">simple-storage</a>
<a href="../../packages/addon-kit/tabs.html">tabs</a>
<a href="../../packages/addon-kit/timers.html">timers</a>
<a href="../../packages/addon-kit/widget.html">widget</a>
<a href="../../packages/addon-kit/windows.html">windows</a>
</li>
</ul>
</div>
</li>
<li class="sidebar-subsection">
<a href="../../dev-guide/low-level-apis.html"><h3 class="sidebar-subsection-header">Low-Level APIs</h3></a>
<div class="sidebar-subsection-contents">
<ul id="low-level-package-summaries">
<li style="display: block;" class="package-summary">
<h4>
<a href="../../packages/api-utils/index.html">api-utils</a>
</h4>
<a href="../../packages/api-utils/api-utils.html">api-utils</a>
<a href="../../packages/api-utils/app-strings.html">app-strings</a>
<a href="../../packages/api-utils/base64.html">base64</a>
<a href="../../packages/api-utils/byte-streams.html">byte-streams</a>
<a href="../../packages/api-utils/collection.html">collection</a>
<a href="../../packages/api-utils/content.html">content</a>
<a href="../../packages/api-utils/content/loader.html">content/loader</a>
<a href="../../packages/api-utils/content/proxy.html">content/proxy</a>
<a href="../../packages/api-utils/content/symbiont.html">content/symbiont</a>
<a href="../../packages/api-utils/content/worker.html">content/worker</a>
<a href="../../packages/api-utils/cortex.html">cortex</a>
<a href="../../packages/api-utils/cuddlefish.html">cuddlefish</a>
<a href="../../packages/api-utils/environment.html">environment</a>
<a href="../../packages/api-utils/errors.html">errors</a>
<a href="../../packages/api-utils/event/core.html">event/core</a>
<a href="../../packages/api-utils/event/target.html">event/target</a>
<a href="../../packages/api-utils/events.html">events</a>
<a href="../../packages/api-utils/file.html">file</a>
<a href="../../packages/api-utils/frame/utils.html">frame/utils</a>
<a href="../../packages/api-utils/globals.html">globals</a>
<a href="../../packages/api-utils/heritage.html">heritage</a>
<a href="../../packages/api-utils/hidden-frame.html">hidden-frame</a>
<a href="../../packages/api-utils/httpd.html">httpd</a>
<a href="../../packages/api-utils/light-traits.html">light-traits</a>
<a href="../../packages/api-utils/list.html">list</a>
<a href="../../packages/api-utils/loader.html">loader</a>
<a href="../../packages/api-utils/match-pattern.html">match-pattern</a>
<a href="../../packages/api-utils/memory.html">memory</a>
<a href="../../packages/api-utils/message-manager.html">message-manager</a>
<a href="../../packages/api-utils/namespace.html">namespace</a>
<a href="../../packages/api-utils/observer-service.html">observer-service</a>
<a href="../../packages/api-utils/plain-text-console.html">plain-text-console</a>
<a href="../../packages/api-utils/preferences-service.html">preferences-service</a>
<a href="../../packages/api-utils/promise.html">promise</a>
<a href="../../packages/api-utils/querystring.html">querystring</a>
<a href="../../packages/api-utils/runtime.html">runtime</a>
<a href="../../packages/api-utils/sandbox.html">sandbox</a>
<a href="../../packages/api-utils/tab-browser.html">tab-browser</a>
<a href="../../packages/api-utils/test/assert.html">test/assert</a>
<a href="../../packages/api-utils/text-streams.html">text-streams</a>
<a href="../../packages/api-utils/traceback.html">traceback</a>
<a href="../../packages/api-utils/traits.html">traits</a>
<a href="../../packages/api-utils/unload.html">unload</a>
<a href="../../packages/api-utils/url.html">url</a>
<a href="../../packages/api-utils/uuid.html">uuid</a>
<a href="../../packages/api-utils/window/utils.html">window/utils</a>
<a href="../../packages/api-utils/window-utils.html">window-utils</a>
<a href="../../packages/api-utils/xhr.html">xhr</a>
<a href="../../packages/api-utils/xpcom.html">xpcom</a>
<a href="../../packages/api-utils/xul-app.html">xul-app</a>
</li>
<li style="display: block;" class="package-summary">
<h4>
<a href="../../packages/test-harness/index.html">test-harness</a>
</h4>
<a href="../../packages/test-harness/harness.html">harness</a>
<a href="../../packages/test-harness/run-tests.html">run-tests</a>
</li>
</ul>
</div>
</li>
<li class="sidebar-subsection">
<h3 class="sidebar-subsection-header">Tools Reference</h3>
<div class="sidebar-subsection-contents">
<a href="../../dev-guide/console.html">console</a>
<a href="../../dev-guide/cfx-tool.html">cfx</a>
<a href="../../dev-guide/package-spec.html">package.json</a>
</div>
</li>
</ul>
</div>
<ul class="sidebar-section" id="appendices">
<li><a href="https://wiki.mozilla.org/Labs/Jetpack/Release_Notes"><h3>Release Notes</h3></a></li>
<li><a href="https://wiki.mozilla.org/Labs/Jetpack"><h3>Jetpack Wiki</h3></a></li>
<li><a href="../../dev-guide/glossary.html"><h3>Glossary</h3></a></li>
<li><a href="../../dev-guide/credits.html"><h3>Credits</h3></a></li>
</ul>
<!--end of sidebar column-->
</div>
<!--end of 'columns'-->
<div class="clearfooter"></div>
</div>
</div>
<div id="footer">
<div class="section">
<img src="../../static-files/media/footer-logo-med.png" alt="" class="footerlogo">
<div id="social-footer">
<ul>
<li>get to know <b>add-ons</b></li>
<li><a href="https://addons.mozilla.org/en-US/firefox/about">About</a></li>
<li><a href="http://blog.mozilla.com/addons">Blog</a></li>
<li class="footer-devhub-link"><a href="https://addons.mozilla.org/en-US/developers/">Developer Hub</a></li>
<li><a href="https://addons.mozilla.org/en-US/firefox/faq">FAQ</a></li>
<li><a href="https://forums.addons.mozilla.org">Forum</a></li>
</ul>
</div>
<div id="copyright">
<p id="footer-links">
<a href="http://mozilla.com/privacy-policy.html">Privacy Policy</a> |
<a href="http://mozilla.com/about/legal.html">Legal Notices</a> |
<a href="http://mozilla.com/legal/fraud-report/index.html">Report Trademark Abuse</a>
| <a href="https://addons.mozilla.org/z/en-US/developers/" class="mobile-link">View Mobile Site</a>
</p>
<p>
Except where otherwise <a href="http://mozilla.com/about/legal.html#site">noted</a>, content on this site is licensed under the <br> <a href="http://creativecommons.org/licenses/by-sa/3.0/"> Creative Commons Attribution Share-Alike License v3.0 </a> or any later version.
</p>
</div>
</div>
</div>
<script src="../../static-files/js/jquery.js" type="text/javascript"></script>
<script src="../../static-files/js/main.js" type="text/javascript"></script>
</body>
</html>