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

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

Issue 10829142: Disable the managed storage API behind a flag for M22. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: nit Created 8 years, 4 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
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 172 matching lines...) Expand 10 before | Expand all | Expand 10 after
183 <li> 183 <li>
184 <a href="#apiReference">API reference: chrome.storage</a> 184 <a href="#apiReference">API reference: chrome.storage</a>
185 <ol> 185 <ol>
186 <li> 186 <li>
187 <a href="#properties">Properties</a> 187 <a href="#properties">Properties</a>
188 <ol> 188 <ol>
189 <li> 189 <li>
190 <a href="#property-sync">sync</a> 190 <a href="#property-sync">sync</a>
191 </li><li> 191 </li><li>
192 <a href="#property-local">local</a> 192 <a href="#property-local">local</a>
193 </li><li>
194 <a href="#property-managed">managed</a>
195 </li> 193 </li>
196 </ol> 194 </ol>
197 </li> 195 </li>
198 <li> 196 <li>
199 <a href="#global-events">Events</a> 197 <a href="#global-events">Events</a>
200 <ol> 198 <ol>
201 <li> 199 <li>
202 <a href="#event-onChanged">onChanged</a> 200 <a href="#event-onChanged">onChanged</a>
203 </li> 201 </li>
204 </ol> 202 </ol>
(...skipping 49 matching lines...) Expand 10 before | Expand all | Expand 10 after
254 <ul> 252 <ul>
255 <li>User data can be automatically synced with Chrome sync 253 <li>User data can be automatically synced with Chrome sync
256 (using <code>storage.sync</code>).</li> 254 (using <code>storage.sync</code>).</li>
257 <li>Your extension's content scripts can directly access user data 255 <li>Your extension's content scripts can directly access user data
258 without the need for a background page.</li> 256 without the need for a background page.</li>
259 <li>A user's extension settings can be persisted 257 <li>A user's extension settings can be persisted
260 even when using 258 even when using
261 <a href="manifest.html#incognito">split incognito behavior</a>.</li> 259 <a href="manifest.html#incognito">split incognito behavior</a>.</li>
262 <li>User data can be stored as objects 260 <li>User data can be stored as objects
263 (the <code>localStorage API</code> stores data in strings).</li> 261 (the <code>localStorage API</code> stores data in strings).</li>
264 <li>Domain policies configured by the administrator for the extension
265 can be read (using <code>storage.managed</code>).</li>
266 </ul> 262 </ul>
267 <h2 id="manifest">Manifest</h2> 263 <h2 id="manifest">Manifest</h2>
268 <p>You must declare the "storage" permission in the <a href="manifest.html">exte nsion manifest</a> 264 <p>You must declare the "storage" permission in the <a href="manifest.html">exte nsion manifest</a>
269 to use the storage API. 265 to use the storage API.
270 For example:</p> 266 For example:</p>
271 <pre>{ 267 <pre>{
272 "name": "My extension", 268 "name": "My extension",
273 ... 269 ...
274 <b>"permissions": [ 270 <b>"permissions": [
275 "storage" 271 "storage"
(...skipping 18 matching lines...) Expand all
294 Chrome syncs the data. 290 Chrome syncs the data.
295 Even if a user disables syncing, 291 Even if a user disables syncing,
296 <code>storage.sync</code> will still work. 292 <code>storage.sync</code> will still work.
297 In this case, it will behave identically 293 In this case, it will behave identically
298 to <code>storage.local</code>. 294 to <code>storage.local</code>.
299 </p> 295 </p>
300 <p class="warning"> 296 <p class="warning">
301 Confidential user information should not be stored! 297 Confidential user information should not be stored!
302 The storage area isn't encrypted. 298 The storage area isn't encrypted.
303 </p> 299 </p>
304 <p>
305 The <code>storage.managed</code> is a read-only
306 storage that contains settings configured by the
307 domain administrator for the extension. Enforcing
308 these settings allows administrators to configure
309 your extension on enterprise deployments.
310 </p>
311 <h2 id="limits">Storage and throttling limits</h2> 300 <h2 id="limits">Storage and throttling limits</h2>
312 <p><code>chrome.storage</code> is not a big truck. 301 <p><code>chrome.storage</code> is not a big truck.
313 It's a series of tubes. 302 It's a series of tubes.
314 And if you don't understand, 303 And if you don't understand,
315 those tubes can be filled, 304 those tubes can be filled,
316 and if they are filled 305 and if they are filled
317 when you put your message in, 306 when you put your message in,
318 it gets in line, 307 it gets in line,
319 and it's going to be delayed 308 and it's going to be delayed
320 by anyone that puts into that tube 309 by anyone that puts into that tube
(...skipping 247 matching lines...) Expand 10 before | Expand all | Expand 10 after
568 <!-- OBJECT EVENT FIELDS --> 557 <!-- OBJECT EVENT FIELDS -->
569 <!-- FUNCTION PARAMETERS --> 558 <!-- FUNCTION PARAMETERS -->
570 </div> 559 </div>
571 </div> 560 </div>
572 </dl> 561 </dl>
573 </dd> 562 </dd>
574 <!-- OBJECT METHODS --> 563 <!-- OBJECT METHODS -->
575 <!-- OBJECT EVENT FIELDS --> 564 <!-- OBJECT EVENT FIELDS -->
576 <!-- FUNCTION PARAMETERS --> 565 <!-- FUNCTION PARAMETERS -->
577 </div> 566 </div>
578 </div><div>
579 <a name="property-managed"></a>
580 <h4>managed</h4>
581 <div class="summary">
582 <!-- Note: intentionally longer 80 columns -->
583 <span>chrome.storage.</span><span>managed</span>
584 </div>
585 <div>
586 <dt>
587 <var>managed</var>
588 <em>
589 <!-- TYPE -->
590 <div style="display:inline">
591 (
592 <span id="typeTemplate">
593 <span>
594 <a href="storage.html#type-storage.StorageArea">storage. StorageArea</a>
595 </span>
596 </span>
597 )
598 </div>
599 </em>
600 </dt>
601 <dd>Items under the "managed" storage area are set by the domain admin istrator, and are read-only by the extension; trying to modify this namespace re sults in an error.</dd>
602 <!-- OBJECT PROPERTIES -->
603 <!-- OBJECT METHODS -->
604 <!-- OBJECT EVENT FIELDS -->
605 <!-- FUNCTION PARAMETERS -->
606 </div>
607 </div> 567 </div>
608 </div> <!-- /apiGroup --> 568 </div> <!-- /apiGroup -->
609 <!-- METHODS --> 569 <!-- METHODS -->
610 <!-- /apiGroup --> 570 <!-- /apiGroup -->
611 <!-- EVENTS --> 571 <!-- EVENTS -->
612 <div id="eventsTemplate" class="apiGroup"> 572 <div id="eventsTemplate" class="apiGroup">
613 <a name="global-events"></a> 573 <a name="global-events"></a>
614 <h3>Events</h3> 574 <h3>Events</h3>
615 <!-- iterates over all events --> 575 <!-- iterates over all events -->
616 <div class="apiItem"> 576 <div class="apiItem">
(...skipping 42 matching lines...) Expand 10 before | Expand all | Expand 10 after
659 ( 619 (
660 <span id="typeTemplate"> 620 <span id="typeTemplate">
661 <span> 621 <span>
662 <span>string</span> 622 <span>string</span>
663 </span> 623 </span>
664 </span> 624 </span>
665 ) 625 )
666 </div> 626 </div>
667 </em> 627 </em>
668 </dt> 628 </dt>
669 <dd>The name of the storage area ("sync", "local" or "managed") the ch anges are for.</dd> 629 <dd>The name of the storage area ("sync" or "local") the changes are f or.</dd>
670 <!-- OBJECT PROPERTIES --> 630 <!-- OBJECT PROPERTIES -->
671 <!-- OBJECT METHODS --> 631 <!-- OBJECT METHODS -->
672 <!-- OBJECT EVENT FIELDS --> 632 <!-- OBJECT EVENT FIELDS -->
673 <!-- FUNCTION PARAMETERS --> 633 <!-- FUNCTION PARAMETERS -->
674 </div> 634 </div>
675 </div> 635 </div>
676 </dl> 636 </dl>
677 </div> 637 </div>
678 <!-- EXTRA PARAMETERS --> 638 <!-- EXTRA PARAMETERS -->
679 <!-- LISTENER RETURN VALUE --> 639 <!-- LISTENER RETURN VALUE -->
(...skipping 479 matching lines...) Expand 10 before | Expand all | Expand 10 after
1159 _uff=0; 1119 _uff=0;
1160 urchinTracker(); 1120 urchinTracker();
1161 } 1121 }
1162 catch(e) {/* urchinTracker not available. */} 1122 catch(e) {/* urchinTracker not available. */}
1163 </script> 1123 </script>
1164 <!-- end analytics --> 1124 <!-- end analytics -->
1165 </div> 1125 </div>
1166 </div> <!-- /gc-footer --> 1126 </div> <!-- /gc-footer -->
1167 </div> <!-- /gc-container --> 1127 </div> <!-- /gc-container -->
1168 </body></html> 1128 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/api/storage.json ('k') | chrome/common/extensions/docs/extensions/storage.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698