chrome/common/extensions/docs/experimental.storage.html - Issue 9274004: Take the Extension Storage API out of experimental.

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

Issue 9274004: Take the Extension Storage API out of experimental. (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 side-by-side diff with in-line comments

Download patch

« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/js/api_page_generator.js » ('j') | chrome/common/extensions/extension_permission_set.cc » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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

deleted file mode 100644

index 7b0a5bfa0dc78ce688b4b3f056ce80ae48c97e3a..0000000000000000000000000000000000000000

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

+++ /dev/null

@@ -1,1958 +0,0 @@

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

Aaron Boodman 2012/01/23 01:51:33 It's traditional to leave a page here redirecting

not at google - send to devlin 2012/01/23 03:59:24 Done. I don't think webNavigation is an example t

- 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="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.experimental.storage module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.storage - Google Chrome Extensions - Google Code</title></head>

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

- <div id="devModeWarning">

- 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>

-

- <!-- 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" -->

- <div style="display:none">

-

- <div id="valueTemplate">

- <dt>

- <var>paramName</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <a> Type</a>

- </span>

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd>

- Description of this parameter from the json schema.

- </dd>

- <dd>

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd>

- <div></div>

- </dd>

-

- <dd>

- <div></div>

- </dd>

-

- <dd>

- <div></div>

- </dd>

- </div>

- <div id="functionParametersTemplate">

- <h5>Parameters</h5>

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

- <ol>

- <li id="propertiesTocTemplate">

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

- <ol>

- <li>

- <a href="#property-anchor">propertyName</a>

- </li>

- </ol>

- </li>

- <li id="methodsTocTemplate">

- <a>Methods</a>

- <ol>

- <li>

- <a href="#method-anchor">methodName</a>

- </li>

- </ol>

- </li>

- <li id="eventsTocTemplate">

- <a>Events</a>

- <ol>

- <li>

- <a href="#event-anchor">eventName</a>

- </li>

- </ol>

- </li>

- <li id="typesTocTemplate">

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

- <ol>

- <li>

- <a href="#id-anchor">id</a>

- <ol>

- <div></div>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

- <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">chrome.experimental.storage</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li style="display: none; ">

- <a>h2Name</a>

- <ol>

- <li>

- <a>h3Name</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.experimental.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 style="display: none; ">

- <a>Methods</a>

- <ol>

- <li>

- <a href="#method-anchor">methodName</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>

- <li style="display: none; ">

- <a>Methods</a>

- <ol>

- <li>

- <a href="#method-anchor">methodName</a>

- </li>

- </ol>

- </li>

- <li style="display: none; ">

- <a>Events</a>

- <ol>

- <li>

- <a href="#event-anchor">eventName</a>

- </li>

- </ol>

- </li>

- </ol>

- </li><li>

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

- <ol>

- <li>

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

- <ol>

- <li>

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

- </li><li>

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

- </li><li>

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

- </li><li>

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

- </li>

- </ol>

- </li>

- <li style="display: none; ">

- <a>Events</a>

- <ol>

- <li>

- <a href="#event-anchor">eventName</a>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <p id="classSummary">

- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.

- </p>

-

- <div id="static"></div>

-

- <div class="apiPage">

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

- <h2>API reference: chrome.experimental.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.experimental.storage.</span><span>sync</span>

- </div>

- <div>

- <dt>

- <var>sync</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span>

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

- </span>

- <span style="display: none; ">

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

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

- <h4>local</h4>

- <div class="summary">

-

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

- </div>

- <div>

- <dt>

- <var>local</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span>

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

- </span>

- <span style="display: none; ">

- <span>

- array of <span><span></span></span>

- </span>

- <span>paramType</span>

- <span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div>

-

- <div id="methodsTemplate" class="apiGroup" style="display: none; ">

- <a></a>

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a></a>

- <h4>method name</h4>

- <div class="summary"><span>void</span>

-

- <span>chrome.module.methodName</span>(<span><span>, </span><span></span>

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

- <div class="description">

- <p class="todo">Undocumented.</p>

- <p>

- A description from the json schema def of the function goes here.

- </p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- </div>

- </dl>

-

- <h4>Returns</h4>

- <dl>

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- that looks like this:

- </p>

- <p>

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

- specify a function that looks like this:

- </p>

-

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

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

- <p>

- This function was added in version <b><span></span></b>.

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

- </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.experimental.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 class="todo" style="display: none; ">Undocumented.</p>

- <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 class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>object</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>namespace</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>string</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

- </div>

-

- <div style="display: none; ">

- <h4>Extra parameters to addListener</h4>

- <dl>

- <div>

- </div>

- </dl>

- </div>

-

- <h4 style="display: none; ">Listener returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </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>

- <var style="display: none; ">paramName</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>object</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd style="display: none; ">

- Description of this parameter from the json schema.

- </dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>oldValue</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>any</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>newValue</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>any</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

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

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

- <h4>StorageNamespace</h4>

- <div>

- <dt>

- <var style="display: none; ">paramName</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>object</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- <dd style="display: none; ">

- Description of this parameter from the json schema.

- </dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd>

- <div class="apiGroup" style="">

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

- <h3>Methods of StorageNamespace</h3>

-

- <div class="apiItem">

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

- <h4>clear</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>storageNamespace.clear</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>

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

- <div class="description">

- <p class="todo" style="display: none; ">Undocumented.</p>

- <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 class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>function</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

- <dd>Callback on success, or on failure (in which case lastError will be set).</dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p style="display: none; ">

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

- that looks like this:

- </p>

- <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>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </div>

-

- <p style="display: none; ">

- This function was added in version <b><span></span></b>.

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

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

- <h4>get</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>storageNamespace.get</span>(<span class="optional"><span style="display: none; ">, </span><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 class="todo" style="display: none; ">Undocumented.</p>

- <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 class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

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

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

- <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 null or undefined to get the entire contents of storage; this should only be used for debugging.</dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>function</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

- <dd>Callback with storage items, or on failure (in which case lastError will be set).</dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- that looks like this:

- </p>

- <p style="display: none; ">

- If you specify the <em>callback</em> parameter, it 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 class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>object</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

- </div>

-

- <p style="display: none; ">

- This function was added in version <b><span></span></b>.

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

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

- <h4>remove</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>storageNamespace.remove</span>(<span class="null"><span style="display: none; ">, </span><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 class="todo" style="display: none; ">Undocumented.</p>

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

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>keys</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

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

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>function</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

- <dd>Callback on success, or on failure (in which case lastError will be set).</dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p style="display: none; ">

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

- that looks like this:

- </p>

- <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>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </div>

-

- <p style="display: none; ">

- This function was added in version <b><span></span></b>.

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

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

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

- <h4>set</h4>

- <div class="summary"><span style="display: none; ">void</span>

-

- <span>storageNamespace.set</span>(<span class="null"><span style="display: none; ">, </span><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 class="todo" style="display: none; ">Undocumented.</p>

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

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>items</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional" style="display: none; ">optional</span>

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>object</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

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

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span class="enum" style="display: none; ">enumerated</span>

- <span id="typeTemplate">

- <span style="display: none; ">

- <a> Type</a>

- </span>

- <span>

- <span style="display: none; ">

- array of <span><span></span></span>

- </span>

- <span>function</span>

- <span style="display: none; "></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo" style="display: none; ">

- Undocumented.

- </dd>

- <dd>Callback on success, or on failure (in which case lastError will be set).</dd>

- <dd style="display: none; ">

- This parameter was added in version

- <b><span></span></b>.

- You must omit this parameter in earlier versions,

- and you may omit it in any version. If you require this

- parameter, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </dd>

-

- <dd style="display: none; ">

- <dl>

- <div>

- </div>

- </dl>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

- </div>

- </dl>

-

- <h4 style="display: none; ">Returns</h4>

- <dl>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p style="display: none; ">

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

- that looks like this:

- </p>

- <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>

- <div style="display: none; ">

- <div>

- </div>

- </dl>

- </div>

-

- <p style="display: none; ">

- This function was added in version <b><span></span></b>.

- If you require this function, the manifest key

- <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>

- can ensure that your extension won't be run in an earlier browser version.

- </p>

- </div>

- </div>

- </div>

- </dd>

-

- <dd style="display: none; ">

- <div></div>

- </dd>

-

- <dd style="display: none; ">

- <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>