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

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 8670012: Extension Settings API: move the API functions into an object SettingsNamepace, (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 9 years, 1 month 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
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/samples.json » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/experimental.settings.html
diff --git a/chrome/common/extensions/docs/experimental.settings.html b/chrome/common/extensions/docs/experimental.settings.html
index 52714b25c9b470d2865c38a35c220d3402dd6ad6..81b7224335eaab933d165fa57200fe4206cbae10 100644
--- a/chrome/common/extensions/docs/experimental.settings.html
+++ b/chrome/common/extensions/docs/experimental.settings.html
@@ -311,25 +311,21 @@
<li>
<a href="#apiReference">API reference: chrome.experimental.settings</a>
<ol>
- <li style="display: none; ">
+ <li>
<a href="#properties">Properties</a>
<ol>
<li>
- <a href="#property-anchor">propertyName</a>
+ <a href="#property-sync">sync</a>
+ </li><li>
+ <a href="#property-local">local</a>
</li>
</ol>
</li>
- <li>
- <a href="#global-methods">Methods</a>
+ <li style="display: none; ">
+ <a>Methods</a>
<ol>
<li>
- <a href="#method-clear">clear</a>
- </li><li>
- <a href="#method-get">get</a>
- </li><li>
- <a href="#method-remove">remove</a>
- </li><li>
- <a href="#method-set">set</a>
+ <a href="#method-anchor">methodName</a>
</li>
</ol>
</li>
@@ -364,6 +360,32 @@
</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>
@@ -387,66 +409,111 @@
<h2>API reference: chrome.experimental.settings</h2>
<!-- PROPERTIES -->
- <div class="apiGroup" style="display: none; ">
+ <div class="apiGroup">
<a name="properties"></a>
<h3 id="properties">Properties</h3>
<div>
- <a></a>
- <h4>getLastError</h4>
+ <a name="property-sync"></a>
+ <h4>sync</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension</span><span>lastError</span>
+ <span>chrome.experimental.settings.</span><span>sync</span>
</div>
<div>
- </div>
- </div>
+ <dt>
+ <var>sync</var>
+ <em>
- </div> <!-- /apiGroup -->
+ <!-- TYPE -->
+ <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.settings.html#type-StorageNamespace">StorageNamespace</a>
+ </span>
+ <span style="display: none; ">
+ <span>
+ array of <span><span></span></span>
+ </span>
+ <span>paramType</span>
+ <span></span>
+ </span>
+ </span>
+ )
+ </div>
- <!-- METHODS -->
- <div id="methodsTemplate" class="apiGroup">
- <a name="global-methods"></a>
- <h3>Methods</h3>
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>Settings 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>
- <!-- iterates over all functions -->
- <div class="apiItem">
- <a name="method-clear"></a> <!-- method-anchor -->
- <h4>clear</h4>
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </dd>
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.settings.clear</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>
- <var><span>callback</span></var></span>)</div>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Removes all values from settings.</p>
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div><div>
+ <a name="property-local"></a>
+ <h4>local</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.settings.</span><span>local</span>
+ </div>
+ <div>
<dt>
- <var>callback</var>
+ <var>local</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional">optional</span>
+ <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; ">
+ <a href="experimental.settings.html#type-StorageNamespace">StorageNamespace</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>function</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -457,7 +524,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Callback on success, or on failure (in which case lastError will be set).</dd>
+ <dd>Settings under the "local" namespace are local to each browser.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -494,13 +561,44 @@
</dd>
</div>
+ </div>
+
+ </div> <!-- /apiGroup -->
+
+ <!-- METHODS -->
+ <div id="methodsTemplate" class="apiGroup" style="display: none; ">
+ <a></a>
+ <h3>Methods</h3>
+
+ <!-- iterates over all functions -->
+ <div class="apiItem">
+ <a></a> <!-- method-anchor -->
+ <h4>method name</h4>
+
+ <div class="summary"><span>void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <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>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
</div>
</dl>
<!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
+ <h4>Returns</h4>
<dl>
- <div style="display: none; ">
+ <div>
<div>
</div>
</div>
@@ -510,7 +608,7 @@
<div>
<div>
<h4>Callback function</h4>
- <p style="display: none; ">
+ <p>
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
@@ -520,9 +618,9 @@
</p>
<!-- Note: intentionally longer 80 columns -->
- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
<dl>
- <div style="display: none; ">
+ <div>
<div>
</div>
</div>
@@ -531,7 +629,7 @@
</div>
<!-- MIN_VERSION -->
- <p style="display: none; ">
+ <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>
@@ -539,43 +637,63 @@
</p>
</div> <!-- /description -->
- </div><div class="apiItem">
- <a name="method-get"></a> <!-- method-anchor -->
- <h4>get</h4>
+ </div> <!-- /apiItem -->
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.settings.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> <!-- /apiGroup -->
+
+ <!-- EVENTS -->
+ <div id="eventsTemplate" class="apiGroup">
+ <a name="global-events"></a>
+ <h3>Events</h3>
+ <!-- iterates over all events -->
+ <div class="apiItem">
+ <a name="event-onChanged"></a>
+ <h4>onChanged</h4>
+
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span class="subdued">chrome.experimental.settings.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>array of SettingChange changes, string namespace</span>) <span class="subdued">{...}</span><span></span>);
+ </div>
<div class="description">
<p class="todo" style="display: none; ">Undocumented.</p>
- <p>Gets one or more values from settings.</p>
+ <p>Fired when one or more settings change.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
+ <!-- LISTENER PARAMETERS -->
+ <div>
+ <h4>Listener parameters</h4>
+ <dl>
<div>
+ <div>
<dt>
- <var>keys</var>
+ <var>changes</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional">optional</span>
+ <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; ">
+ <span>
+ array of <span><span>
+ <span>
+ <a href="experimental.settings.html#type-SettingChange">SettingChange</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>string or array of string or object</span>
+ <span>paramType</span>
+ <span></span>
+ </span>
+ </span></span>
+ </span>
+ <span style="display: none; ">paramType</span>
<span style="display: none; "></span>
</span>
</span>
@@ -584,10 +702,12 @@
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
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 settings object. Pass in null or undefined to get the entire contents of settings; this should only be used for debugging.</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>.
@@ -624,10 +744,10 @@
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>callback</var>
+ <var>namespace</var>
<em>
<!-- TYPE -->
@@ -643,7 +763,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -655,7 +775,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Callback with settings values, or on failure (in which case lastError will be set).</dd>
+ <dd>The namespace (e.g. sync or local) of the area the changes are for.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -692,11 +812,23 @@
</dd>
</div>
- </div>
- </dl>
+ </div>
+ </dl>
+ </div>
- <!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
+ <!-- EXTRA PARAMETERS -->
+ <div style="display: none; ">
+ <h4>Extra parameters to addListener</h4>
+ <dl>
+ <div>
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+
+ <!-- LISTENER RETURN VALUE -->
+ <h4 style="display: none; ">Listener returns</h4>
<dl>
<div style="display: none; ">
<div>
@@ -704,26 +836,24 @@
</div>
</dl>
- <!-- CALLBACK -->
- <div>
- <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>
+ </div> <!-- /description -->
+ </div> <!-- /apiItem -->
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span>object settings</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
+ </div> <!-- /apiGroup -->
+
+ <!-- TYPES -->
+ <div class="apiGroup">
+ <a name="types"></a>
+ <h3 id="types">Types</h3>
+
+ <!-- iterates over all types -->
+ <div class="apiItem">
+ <a name="type-SettingChange"></a>
+ <h4>SettingChange</h4>
+
+ <div>
<dt>
- <var>settings</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -748,10 +878,12 @@
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>Object with given keys set to settings values.</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>.
@@ -765,7 +897,52 @@
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
- <div style="display: none; ">
+ <div>
+ <div>
+ <dt>
+ <var>key</var>
+ <em>
+
+ <!-- TYPE -->
+ <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>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>The ID of the setting which changed.</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>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
<div>
</div>
</div>
@@ -788,47 +965,16 @@
</dd>
</div>
- </div>
- </dl>
- </div>
- </div>
-
- <!-- MIN_VERSION -->
- <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> <!-- /description -->
-
- </div><div class="apiItem">
- <a name="method-remove"></a> <!-- method-anchor -->
- <h4>remove</h4>
-
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.settings.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 values from settings.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>keys</var>
+ <var>oldValue</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="display: none; ">optional</span>
+ <span class="optional">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -838,7 +984,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string or array of string</span>
+ <span>any</span>
<span style="display: none; "></span>
</span>
</span>
@@ -850,7 +996,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>A single key or a list of keys to remove from settings.</dd>
+ <dd>The old value of the setting, before it changed.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -887,10 +1033,10 @@
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>callback</var>
+ <var>newValue</var>
<em>
<!-- TYPE -->
@@ -906,7 +1052,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>any</span>
<span style="display: none; "></span>
</span>
</span>
@@ -918,7 +1064,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Callback on success, or on failure (in which case lastError will be set).</dd>
+ <dd>The new value of the setting.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -955,72 +1101,34 @@
</dd>
</div>
- </div>
- </dl>
+ </div>
+ </dl>
+ </dd>
- <!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <!-- CALLBACK -->
- <div>
- <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>
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
- </div>
- </div>
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <!-- MIN_VERSION -->
- <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> <!-- /description -->
+ </div>
</div><div class="apiItem">
- <a name="method-set"></a> <!-- method-anchor -->
- <h4>set</h4>
-
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.experimental.settings.set</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
- <var><span>settings</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 settings values.</p>
+ <a name="type-StorageNamespace"></a>
+ <h4>StorageNamespace</h4>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ <div>
<dt>
- <var>settings</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -1045,10 +1153,12 @@
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>Object to augment settings with. Values that cannot be serialized (functions, etc) will be ignored.</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>.
@@ -1060,9 +1170,9 @@
</dd>
<!-- OBJECT PROPERTIES -->
- <dd>
+ <dd style="display: none; ">
<dl>
- <div style="display: none; ">
+ <div>
<div>
</div>
</div>
@@ -1070,22 +1180,29 @@
</dd>
<!-- OBJECT METHODS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <dd>
+ <div class="apiGroup" style="">
+ <a name="global-StorageNamespace-methods"></a>
+ <h3>Methods of StorageNamespace</h3>
- <!-- OBJECT EVENT FIELDS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <!-- iterates over all functions -->
+ <div class="apiItem">
+ <a name="method-StorageNamespace-clear"></a> <!-- method-anchor -->
+ <h4>clear</h4>
- <!-- FUNCTION PARAMETERS -->
- <dd style="display: none; ">
- <div></div>
- </dd>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>storageNamespace.clear</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span>
+ <var><span>callback</span></var></span>)</div>
- </div>
- </div><div>
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Removes all values from settings.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
<div>
<dt>
<var>callback</var>
@@ -1198,63 +1315,43 @@
</p>
</div> <!-- /description -->
- </div> <!-- /apiItem -->
-
- </div> <!-- /apiGroup -->
-
- <!-- EVENTS -->
- <div id="eventsTemplate" class="apiGroup">
- <a name="global-events"></a>
- <h3>Events</h3>
- <!-- iterates over all events -->
- <div class="apiItem">
- <a name="event-onChanged"></a>
- <h4>onChanged</h4>
+ </div><div class="apiItem">
+ <a name="method-StorageNamespace-get"></a> <!-- method-anchor -->
+ <h4>get</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.experimental.settings.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>array of SettingChange changes</span>) <span class="subdued">{...}</span><span></span>);
- </div>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <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>Fired when one or more settings change.</p>
+ <p>Gets one or more values from settings.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
<div>
- <div>
<dt>
- <var>changes</var>
+ <var>keys</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional" style="display: none; ">optional</span>
+ <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>
- array of <span><span>
- <span>
- <a href="experimental.settings.html#type-SettingChange">SettingChange</a>
- </span>
- <span style="display: none; ">
- <span>
+ <span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>paramType</span>
- <span></span>
- </span>
- </span></span>
- </span>
- <span style="display: none; ">paramType</span>
+ <span>string or array of string or object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -1263,12 +1360,10 @@
</em>
</dt>
- <dd class="todo">
+ <dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd style="display: none; ">
- Description of this parameter from the json schema.
- </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 settings object. Pass in null or undefined to get the entire contents of settings; this should only be used for debugging.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1305,23 +1400,79 @@
</dd>
</div>
- </div>
- </dl>
+ </div><div>
+ <div>
+ <dt>
+ <var>callback</var>
+ <em>
+
+ <!-- TYPE -->
+ <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>
+ </span>
+ )
</div>
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
+ </em>
+ </dt>
+ <dd class="todo" style="display: none; ">
+ Undocumented.
+ </dd>
+ <dd>Callback with settings values, 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>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
</div>
+ </div>
+ </dl>
+ </dd>
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
<dl>
<div style="display: none; ">
<div>
@@ -1329,24 +1480,26 @@
</div>
</dl>
- </div> <!-- /description -->
- </div> <!-- /apiItem -->
-
- </div> <!-- /apiGroup -->
-
- <!-- TYPES -->
- <div class="apiGroup">
- <a name="types"></a>
- <h3 id="types">Types</h3>
-
- <!-- iterates over all types -->
- <div class="apiItem">
- <a name="type-SettingChange"></a>
- <h4>SettingChange</h4>
+ <!-- CALLBACK -->
+ <div>
+ <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>
- <div>
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span>object settings</span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div>
+ <div>
<dt>
- <var style="display: none; ">paramName</var>
+ <var>settings</var>
<em>
<!-- TYPE -->
@@ -1371,12 +1524,10 @@
</em>
</dt>
- <dd class="todo">
+ <dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd style="display: none; ">
- Description of this parameter from the json schema.
- </dd>
+ <dd>Object with given keys set to settings values.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1390,10 +1541,64 @@
<!-- OBJECT PROPERTIES -->
<dd>
<dl>
- <div>
+ <div style="display: none; ">
<div>
+ </div>
+ </div>
+ </dl>
+ </dd>
+
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <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> <!-- /description -->
+
+ </div><div class="apiItem">
+ <a name="method-StorageNamespace-remove"></a> <!-- method-anchor -->
+ <h4>remove</h4>
+
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <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 values from settings.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
<dt>
- <var>key</var>
+ <var>keys</var>
<em>
<!-- TYPE -->
@@ -1409,7 +1614,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>string or array of string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -1421,7 +1626,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The ID of the setting which changed.</dd>
+ <dd>A single key or a list of keys to remove from settings.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1458,10 +1663,10 @@
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>oldValue</var>
+ <var>callback</var>
<em>
<!-- TYPE -->
@@ -1477,7 +1682,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>function</span>
<span style="display: none; "></span>
</span>
</span>
@@ -1489,7 +1694,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The old value of the setting, before it changed.</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>.
@@ -1526,16 +1731,78 @@
</dd>
</div>
- </div><div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ <!-- CALLBACK -->
<div>
+ <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>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <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> <!-- /description -->
+
+ </div><div class="apiItem">
+ <a name="method-StorageNamespace-set"></a> <!-- method-anchor -->
+ <h4>set</h4>
+
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>storageNamespace.set</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
+ <var><span>settings</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 settings values.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
<dt>
- <var>newValue</var>
+ <var>settings</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
- <span class="optional">optional</span>
+ <span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span style="display: none; ">
@@ -1545,7 +1812,7 @@
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -1557,7 +1824,7 @@
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The new value of the setting.</dd>
+ <dd>Object to augment settings 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>.
@@ -1569,9 +1836,9 @@
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<dl>
- <div>
+ <div style="display: none; ">
<div>
</div>
</div>
@@ -1594,6 +1861,54 @@
</dd>
</div>
+ </div><div>
+ <div>
+ <dt>
+ <var>callback</var>
+ <em>
+
+ <!-- TYPE -->
+ <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>
+ </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>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd style="display: none; ">
+ <dl>
+ <div>
+ <div>
+ </div>
</div>
</dl>
</dd>
@@ -1614,6 +1929,67 @@
</dd>
</div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+
+ <!-- CALLBACK -->
+ <div>
+ <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>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div style="display: none; ">
+ <div>
+ </div>
+ </div>
+ </dl>
+ </div>
+ </div>
+
+ <!-- MIN_VERSION -->
+ <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> <!-- /description -->
+
+ </div> <!-- /apiItem -->
+
+ </div>
+ </dd>
+
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
+
+ </div>
</div> <!-- /apiItem -->
« chrome/common/extensions/api/extension_api.json ('K') | « chrome/common/extensions/api/extension_api.json ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/samples.json » ('J')

Powered by Google App Engine
This is Rietveld 408576698