chrome/common/extensions/docs/storage.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/storage.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 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 side-by-side diff with in-line comments

Index: chrome/common/extensions/docs/storage.html

diff --git a/chrome/common/extensions/docs/storage.html b/chrome/common/extensions/docs/storage.html

deleted file mode 100644

index ce1d594776a4941bc69e0f00293967e3b9e37b5c..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/storage.html

+++ /dev/null

@@ -1,1260 +0,0 @@

-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

- 1) The <head> information in this page is significant, should be uniform

- across api docs and should be edited only with knowledge of the

- templating mechanism.

- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

- browser, it will be re-generated from the template, json schema and

- authored overview content.

- 4) The <body>.innerHTML is also generated by an offline step so that this

- page may easily be indexed by search engines.

---><html xmlns="http://www.w3.org/1999/xhtml"><head>

- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

- </script>

- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">

- </script>

- <script type="text/javascript" src="js/api_page_generator.js"></script>

- <script type="text/javascript" src="js/bootstrap.js"></script>

- <script type="text/javascript" src="js/sidebar.js"></script>

- <meta name="description" content="Documentation for the chrome.storage module, which is part of the Google Chrome extension APIs."><title>Storage - Google Chrome Extensions - Google Code</title></head>

- <body> <div id="devModeWarning" class="displayModeWarning">

- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

- </div>

- <div id="branchWarning" class="displayModeWarning">

- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

- It may not work with the stable release of Chrome.</span>

- <select id="branchChooser">

- <option>Choose a different version...

- </option><option value="">Stable

- </option><option value="beta">Beta

- </option><option value="dev">Dev

- </option><option value="trunk">Trunk

- </option></select>

- </div>

- <div id="unofficialWarning" class="displayModeWarning">

- <span>WARNING: This is unofficial documentation. It may not work with the

- current release of Chrome.</span>

- <button id="goToOfficialDocs">Go to the official docs</button>

- </div>

- <div id="gc-container" class="labs">

-

- <!-- In particular, sub-templates that recurse, must be used by allowing

- jstemplate to make a copy of the template in this section which

- are not operated on by way of the jsskip="true" -->

-

- <a id="top"></a>

- <div id="skipto">

- <a href="#gc-pagecontent">Skip to page content</a>

- <a href="#gc-toc">Skip to main navigation</a>

- </div>

-

- <table id="header" width="100%" cellspacing="0" border="0">

- <tbody><tr>

- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

- <td valign="middle" width="100%" style="padding-left:0.6em;">

- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

- <div id="gsc-search-box">

- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

- <input type="hidden" name="ie" value="UTF-8">

- <input type="text" name="q" value="" size="55">

- <input class="gsc-search-button" type="submit" name="sa" value="Search">

- <br>

- <span class="greytext">e.g. "page action" or "tabs"</span>

- </div>

- </form>

- <script type="text/javascript" src="https://www.google.com/jsapi"></script>

- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

- </td>

- </tr>

- </tbody></table>

- <div id="codesiteContent" class="">

- <a id="gc-topnav-anchor"></a>

- <div id="gc-topnav">

- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

- <ul id="home" class="gc-topnav-tabs">

- <li id="home_link">

- <a href="index.html" title="Google Chrome Extensions home page">Home</a>

- </li>

- <li id="docs_link">

- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

- </li>

- <li id="faq_link">

- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

- </li>

- <li id="samples_link">

- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

- </li>

- <li id="group_link">

- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

- </li>

- <li id="so_link">

- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

- </li>

- </ul>

- </div>

- <div class="g-section g-tpl-170">

-

- <div class="g-unit g-first" id="gc-toc">

- <ul>

- <li><a href="getstarted.html">Getting Started</a></li>

- <li><a href="overview.html">Overview</a></li>

- <li><a href="whats_new.html">What's New?</a></li>

- <li><h2><a href="devguide.html">Developer's Guide</a></h2>

- <ul>

- <li>Browser UI

- <ul>

- <li><a href="browserAction.html">Browser Actions</a></li>

- <li><a href="contextMenus.html">Context Menus</a></li>

- <li><a href="notifications.html">Desktop Notifications</a></li>

- <li><a href="omnibox.html">Omnibox</a></li>

- <li><a href="options.html">Options Pages</a></li>

- <li><a href="override.html">Override Pages</a></li>

- <li><a href="pageAction.html">Page Actions</a></li>

- </ul>

- </li>

- <li>Browser Interaction

- <ul>

- <li><a href="bookmarks.html">Bookmarks</a></li>

- <li><a href="cookies.html">Cookies</a></li>

- <li><a href="devtools.html">Developer Tools</a></li>

- <li><a href="events.html">Events</a></li>

- <li><a href="history.html">History</a></li>

- <li><a href="management.html">Management</a></li>

- <li><a href="tabs.html">Tabs</a></li>

- <li><a href="windows.html">Windows</a></li>

- </ul>

- </li>

- <li>Implementation

- <ul>

- <li><a href="a11y.html">Accessibility</a></li>

- <li><a href="background_pages.html">Background Pages</a></li>

- <li><a href="content_scripts.html">Content Scripts</a></li>

- <li><a href="xhr.html">Cross-Origin XHR</a></li>

- <li><a href="i18n.html">Internationalization</a></li>

- <li><a href="messaging.html">Message Passing</a></li>

- <li><a href="permissions.html">Optional Permissions</a></li>

- <li><a href="npapi.html">NPAPI Plugins</a></li>

- </ul>

- </li>

- <li>Finishing

- <ul>

- <li><a href="hosting.html">Hosting</a></li>

- <li><a href="external_extensions.html">Other Deployment Options</a></li>

- </ul>

- </li>

- </ul>

- </li>

- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

- <li><h2><a href="tutorials.html">Tutorials</a></h2>

- <ul>

- <li><a href="tut_debugging.html">Debugging</a></li>

- <li><a href="tut_analytics.html">Google Analytics</a></li>

- <li><a href="tut_oauth.html">OAuth</a></li>

- </ul>

- </li>

- <li><h2>Reference</h2>

- <ul>

- <li>Formats

- <ul>

- <li><a href="manifest.html">Manifest Files</a></li>

- <li><a href="match_patterns.html">Match Patterns</a></li>

- </ul>

- </li>

- <li><a href="permission_warnings.html">Permission Warnings</a></li>

- <li><a href="api_index.html">chrome.* APIs</a></li>

- <li><a href="api_other.html">Other APIs</a></li>

- </ul>

- </li>

- <li><h2><a href="samples.html">Samples</a></h2></li>

- <div class="line"> </div>

- <li><h2>More</h2>

- <ul>

- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

- <li><a href="themes.html">Themes</a></li>

- </ul>

- </li>

- </ul>

- </div>

- <script>

- initToggles();

- </script>

- <div class="g-unit" id="gc-pagecontent">

- <div id="pageTitle">

- <h1 class="page_title">Storage</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#using-sync">Usage</a>

- <ol>

- </ol>

- </li><li>

- <a href="#limits">Storage and throttling limits</a>

- <ol>

- </ol>

- </li><li>

- <a href="#examples">Examples</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.storage</a>

- <ol>

- <li>

- <a href="#properties">Properties</a>

- <ol>

- <li>

- <a href="#property-sync">sync</a>

- </li><li>

- <a href="#property-local">local</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#global-events">Events</a>

- <ol>

- <li>

- <a href="#event-onChanged">onChanged</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#type-StorageChange">StorageChange</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-StorageArea">StorageArea</a>

- <ol>

- <li>

- <a href="#global-StorageArea-methods">Methods</a>

- <ol>

- <li>

- <a href="#method-StorageArea-clear">clear</a>

- </li><li>

- <a href="#method-StorageArea-get">get</a>

- </li><li>

- <a href="#method-StorageArea-getBytesInUse">getBytesInUse</a>

- </li><li>

- <a href="#method-StorageArea-remove">remove</a>

- </li><li>

- <a href="#method-StorageArea-set">set</a>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static"><div id="pageData-name" class="pageData">Storage</div>

-

-<p id="classSummary">

-Use the <code>chrome.storage</code> module

-to store, retrieve, and track changes to user data.

-This API has been optimized

-to meet the specific storage needs of extensions.

-It provides the same storage capabilities as the

-<a href="https://developer.mozilla.org/en/DOM/Storage#localStorage">localStorage API</a>

-with the following key differences:

-</p>

-<ul>

- <li>User data can be automatically synced with Chrome sync

- (using <code>storage.sync</code>).</li>

- <li>Your extension's content scripts can directly access user data

- without the need for a background page.</li>

- <li>A user's extension settings can be persisted

- even when using

- <a href="http://code.google.com/chrome/extensions/manifest.html#incognito">split incognito behavior</a>.</li>

- <li>User data can be stored as objects

- (the <code>localStorage API</code> stores data in strings).</li>

-</ul>

-<h2 id="manifest">Manifest</h2>

-<p>You must declare the "storage" permission in the <a href="manifest.html">extension manifest</a>

- to use the storage API.

- For example:</p>

-<pre>{

- "name": "My extension",

- ...

- <b>"permissions": [

- "storage"

- ]</b>,

- ...

-}</pre>

-<h2 id="using-sync">Usage</h2>

-<p>

-To store user data for your extension,

-you can use either

-<code>storage.sync</code> or

-<code>storage.local</code>.

-When using <code>storage.sync</code>,

-the stored data will automatically be synced

-to any Chrome browser that the user is logged into,

-provided the user has sync enabled.

-</p>

-<p>

-When Chrome is offline,

-Chrome stores the data locally.

-The next time the browser is online,

-Chrome syncs the data.

-Even if a user disables syncing,

-<code>storage.sync</code> will still work.

-In this case, it will behave identically

-to <code>storage.local</code>.

-</p>

-<p class="warning">

-Confidential user information should not be stored!

-The storage area isn't encrypted.

-</p>

-<h2 id="limits">Storage and throttling limits</h2>

-<p><code>chrome.storage</code> is not a big truck.

-It's a series of tubes.

-And if you don't understand,

-those tubes can be filled,

-and if they are filled

-when you put your message in,

-it gets in line,

-and it's going to be delayed

-by anyone that puts into that tube

-enormous amounts of material.

-</p><p>For details on the current limits

-of the storage API, and what happens

-when those limits are exceeded, please

-see the <a href="#apiReference">API reference</a>.

-</p><h2 id="examples">Examples</h2>

-<p>

-The following example checks for

-CSS code saved by a user on a form,

-and if found,

-stores it.

-</p>

-<pre>function saveChanges() {

- // Get a value saved in a form.

- var theValue = textarea.value;

- // Check that there's some code there.

- if (!theValue) {

- message('Error: No value specified');

- return;

- }

- // Save it using the Chrome extension storage API.

- chrome.storage.sync.set({'value': theValue}, function() {

- // Notify that we saved.

- message('Settings saved');

- });

-</pre>

-<p>

-If you're interested in tracking changes made

-to a data object,

-you can add a listener

-to its <code>onChanged</code> event.

-Whenever anything changes in storage,

-that event fires.

-Here's sample code

-to listen for saved changes:

-</p>

-<pre>chrome.storage.onChanged.addListener(function(changes, namespace) {

- for (key in changes) {

- var storageChange = changes[key];

- console.log('Storage key "%s" in namespace "%s" changed. ' +

- 'Old value was "%s", new value is "%s".',

- key,

- namespace,

- storageChange.oldValue,

- storageChange.newValue);

- }

-});

-</pre>

-<p>

-You can find examples that use this API on the

-<a href="samples.html#sty">Samples page</a>.

-</p>

-

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.storage</h2>

-

- <div class="apiGroup">

- <a name="properties"></a>

- <h3 id="properties">Properties</h3>

- <div>

- <a name="property-sync"></a>

- <h4>sync</h4>

- <div class="summary">

-

- <span>chrome.storage.</span><span>sync</span>

- </div>

- <div>

- <dt>

- <var>sync</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="storage.html#type-StorageArea">StorageArea</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Items under the "sync" namespace are synced using Chrome Sync.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>QUOTA_BYTES</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>102,400</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum total amount (in bytes) of data that can be stored in sync storage. Updates that would cause this limit to be exceeded fail immediately and set chrome.extension.lastError.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>QUOTA_BYTES_PER_ITEM</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>2,048</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum size (in bytes) of each individual item in sync storage. Updates containing items larger than this limit will fail.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>MAX_ITEMS</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>512</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum number of items that can be stored in sync storage. Updates that would cause this limit to be exceeded will fail</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>MAX_WRITE_OPERATIONS_PER_HOUR</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>1,000</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum number of <code>set</code>, <code>remove</code>, or <code>clear</code> operations that can be performed each hour. Updates that would cause this limit to be exceeded fail.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>MAX_SUSTAINED_WRITE_OPERATIONS_PER_MINUTE</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>10</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum number of <code>set</code>, <code>remove</code>, or <code>clear</code> operations that can be performed each minute, sustained over 10 minutes. Updates that would cause this limit to be exceeded fail.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <a name="property-local"></a>

- <h4>local</h4>

- <div class="summary">

-

- <span>chrome.storage.</span><span>local</span>

- </div>

- <div>

- <dt>

- <var>local</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="storage.html#type-StorageArea">StorageArea</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Items under the "local" namespace are local to each machine.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>QUOTA_BYTES</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <code>5,242,880</code>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The maximum amount (in bytes) of data that can be stored in local storage. This value will be ignored if the extension has the <code>unlimitedStorage</code> permission. Updates that would cause this limit to be exceeded fail.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div>

-

-

-

- <div id="eventsTemplate" class="apiGroup">

- <a name="global-events"></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onChanged"></a>

- <h4>onChanged</h4>

- <div class="summary">

-

- <span class="subdued">chrome.storage.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>object changes, string namespace</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when one or more items change.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>changes</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object mapping each key that changed to its corresponding <a href="#type-StorageChange">StorageChange</a> for that item.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>namespace</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The namespace ("sync" or "local") of the storage area the changes are for.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-StorageChange"></a>

- <h4>StorageChange</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>oldValue</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>any</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The old value of the item, if there was an old value.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>newValue</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>any</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The new value of the item, if there is a new value.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-StorageArea"></a>

- <h4>StorageArea</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

- <dd>

- <div class="apiGroup">

- <a name="global-StorageArea-methods"></a>

- <h3>Methods of StorageArea</h3>

-

- <div class="apiItem">

- <a name="method-StorageArea-clear"></a>

- <h4>clear</h4>

- <div class="summary">

-

- <span>storageArea.clear</span>(<span class="optional"><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Removes all items from storage.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Callback on success, or on failure (in which case <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set).</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-StorageArea-get"></a>

- <h4>get</h4>

- <div class="summary">

-

- <span>storageArea.get</span>(<span class="optional"><span>string or array of string or object</span>

- <var><span>keys</span></var></span><span class="null"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Gets one or more items from storage.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>keys</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string or array of string or object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A single key to get, list of keys to get, or a dictionary specifying default values (see description of the object). An empty list or object will return an empty result object. Pass in <code>null</code> to get the entire contents of storage.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Callback with storage items, or on failure (in which case <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set).</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>object items</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>items</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object with items in their key-value mappings.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-StorageArea-getBytesInUse"></a>

- <h4>getBytesInUse</h4>

- <div class="summary">

-

- <span>storageArea.getBytesInUse</span>(<span class="optional"><span>string or array of string</span>

- <var><span>keys</span></var></span><span class="null"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Gets the amount of space (in bytes) being used by one or more items.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>keys</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string or array of string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A single key or list of keys to get the total usage for. An empty list will return 0. Pass in <code>null</code> to get the total usage of all of storage.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Callback with the amount of space being used by storage, or on failure (in which case <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set).</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- The <em>callback</em> parameter should specify a function

- that looks like this:

- </p>

-

- <pre>function(<span>integer bytesInUse</span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- <div>

- <dt>

- <var>bytesInUse</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Amount of space being used in storage, in bytes.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-StorageArea-remove"></a>

- <h4>remove</h4>

- <div class="summary">

-

- <span>storageArea.remove</span>(<span class="null"><span>string or array of string</span>

- <var><span>keys</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Removes one or more items from storage.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>keys</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string or array of string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A single key or a list of keys for items to remove.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Callback on success, or on failure (in which case <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set).</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- </dl>

- </div>

-

- </div>

- </div><div class="apiItem">

- <a name="method-StorageArea-set"></a>

- <h4>set</h4>

- <div class="summary">

-

- <span>storageArea.set</span>(<span class="null"><span>object</span>

- <var><span>items</span></var></span><span class="optional"><span>, </span><span>function</span>

- <var><span>callback</span></var></span>)</div>

- <div class="description">

- <p>Sets multiple items.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>items</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Object specifying items to augment storage with. Values that cannot be serialized (functions, etc) will be ignored.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Callback on success, or on failure (in which case <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set).</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

- If you specify the <em>callback</em> parameter, it should

- specify a function that looks like this:

- </p>

-

- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

- </dd>

-

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <div id="gc-footer" --="">

- <div class="text">

- <p>

- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,

- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons

- Attribution 3.0 License</a>, and code samples are licensed under the

- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

- </p>

- <p>

- </p>

-

-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>

-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>

-<script type="text/javascript">

- // chrome doc tracking

- try {

- var engdocs = _gat._getTracker("YT-10763712-2");

- engdocs._trackPageview();

- } catch(err) {}

- // code.google.com site-wide tracking

- try {

- _uacct="UA-18071-1";

- _uanchor=1;

- _uff=0;

- urchinTracker();

- }

- catch(e) {/* urchinTracker not available. */}

-</script>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/samples.html ('k') | chrome/common/extensions/docs/tabs.html » ('j') | no next file with comments »