summaryrefslogtreecommitdiffstats
path: root/chrome/common/extensions/docs/privacy.html
diff options
context:
space:
mode:
authorkalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-02-02 05:41:48 +0000
committerkalman@chromium.org <kalman@chromium.org@0039d316-1c4b-4281-b951-d872f2087c98>2012-02-02 05:41:48 +0000
commite34acbbaecc29d97d9242930cc30492069d3c513 (patch)
tree6d8d307216966b03e95fefef7b3c668a018566a1 /chrome/common/extensions/docs/privacy.html
parentb66bfd6cbcb3e14d0bcb4609d869485dbc9d5271 (diff)
downloadchromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.zip
chromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.tar.gz
chromium_src-e34acbbaecc29d97d9242930cc30492069d3c513.tar.bz2
Delete display:none nodes while generating the extension API documentation.
This significantly cuts down on the size of the generated documentation: git says "92 files changed, 3716 insertions, 84733 deletions". BUG= TEST=eyeballs Review URL: https://chromiumcodereview.appspot.com/9295046 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@120164 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common/extensions/docs/privacy.html')
-rw-r--r--chrome/common/extensions/docs/privacy.html927
1 files changed, 4 insertions, 923 deletions
diff --git a/chrome/common/extensions/docs/privacy.html b/chrome/common/extensions/docs/privacy.html
index d3ddc80..e941622 100644
--- a/chrome/common/extensions/docs/privacy.html
+++ b/chrome/common/extensions/docs/privacy.html
@@ -41,130 +41,7 @@
<!-- 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">
-
- <!-- VALUE -->
- <div id="valueTemplate">
- <dt>
- <var>paramName</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <a> Type</a>
- </span>
- <span>
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <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>
-
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </dd>
-
- <!-- OBJECT METHODS -->
- <dd>
- <div></div>
- </dd>
-
- <!-- OBJECT EVENT FIELDS -->
- <dd>
- <div></div>
- </dd>
-
- <!-- FUNCTION PARAMETERS -->
- <dd>
- <div></div>
- </dd>
-
- </div> <!-- /VALUE -->
-
- <div id="functionParametersTemplate">
- <h5>Parameters</h5>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- Individual subsections from the table of contents -->
- <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>
- <div></div>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
- </div> <!-- /SUBTEMPLATES -->
-
+ <!-- /SUBTEMPLATES -->
<a id="top"></a>
<div id="skipto">
<a href="#gc-pagecontent">Skip to page content</a>
@@ -185,7 +62,6 @@
<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&amp;t13n_langs=en"></script>
@@ -193,9 +69,7 @@
</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>
@@ -220,7 +94,6 @@
</li>
</ul>
</div> <!-- end gc-topnav -->
-
<div class="g-section g-tpl-170">
<!-- SIDENAV -->
<div class="g-unit g-first" id="gc-toc">
@@ -308,7 +181,6 @@
<script>
initToggles();
</script>
-
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
<h1 class="page_title">Privacy</h1>
@@ -320,44 +192,26 @@
<li>
<a href="#manifest">Manifest</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li><li>
<a href="#usage">Usage</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li><li>
<a href="#examples">Examples</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li><li>
<a href="#manifest">Manifest</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li><li>
<a href="#usage">Usage</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li><li>
<a href="#examples">Examples</a>
<ol>
- <li style="display: none; ">
- <a>h3Name</a>
- </li>
</ol>
</li>
<li>
@@ -375,48 +229,14 @@
</li>
</ol>
</li>
- <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>
- <li style="display: none; ">
- <a href="#types">Types</a>
- <ol>
- <li>
- <a href="#id-anchor">id</a>
- <ol>
- <div></div>
- <div></div>
- </ol>
- </li>
- </ol>
- </li>
</ol>
</li>
</ol>
</div>
<!-- /TABLE OF CONTENTS -->
-
<!-- Standard content lead-in for experimental API pages -->
- <p id="classSummary" style="display: none; ">
- For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page.
- </p>
-
<!-- STATIC CONTENT PLACEHOLDER -->
<div id="static"><div id="pageData-name" class="pageData">Privacy</div>
-
<!-- BEGIN AUTHORED CONTENT -->
<p id="classSummary">
Use the <code>chrome.privacy</code> module to control usage of the features in
@@ -424,18 +244,15 @@
<a href="types.html#ChromeSetting">ChromeSetting prototype of the type API</a>
for getting and setting Chrome's configuration.
</p>
-
<p class="note">
The <a href="http://www.google.com/intl/en/landing/chrome/google-chrome-privacy-whitepaper.pdf">Chrome Privacy Whitepaper</a>
gives background detail regarding the features which this API can control.
</p>
-
<h2 id="manifest">Manifest</h2>
<p>
You must declare the "privacy" permission in your extension's
<a href="manifest.html">manifest</a> to use the API. For example:
</p>
-
<pre>{
"name": "My extension",
...
@@ -444,9 +261,7 @@
]</b>,
...
}</pre>
-
<h2 id="usage">Usage</h2>
-
<p>
Reading the current value of a Chrome setting is straightforward. You'll first
need to find the property you're interested in, then you'll call
@@ -454,14 +269,12 @@
your extension's level of control. For example, to determine if Chrome's
Autofill feature is enabled, you'd write:
</p>
-
<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
if (details.value)
console.log('Autofill is on!');
else
console.log('Autofill is off!');
});</pre>
-
<p>
Changing the value of a setting is a little bit more complex, simply because
you first must verify that your extension can control the setting. The user
@@ -474,14 +287,12 @@
is advisable to warn the user when the settings they've chosen aren't
practically applied.
</p>
-
<p class="note">
Full details about extensions' ability to control <code>ChromeSetting</code>s
can be found under
<a href="types.html#ChromeSetting">
<code>chrome.types.ChromeSetting</code></a>.
</p>
-
<p>
This means that you ought to use the <code>get()</code> method to determine
your level of access, and then only call <code>set()</code> if your extension
@@ -489,7 +300,6 @@
setting it's probably a good idea to visibly disable the functionality to
reduce user confusion):
</p>
-
<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
if (details.levelOfControl === 'controllable_by_this_extension') {
chrome.privacy.services.autofillEnabled.set({ value: true }, function() {
@@ -500,7 +310,6 @@
}
}
});</pre>
-
<p>
If you're interested in changes to a setting's value, add a listener to its
<code>onChange</code> event. Among other uses, this will allow you to warn the
@@ -508,21 +317,18 @@
enterprise policy overrides your control. To listen for changes to Autofill's
status, for example, the following code would suffice:
</p>
-
<pre>chrome.privacy.services.autofillEnabled.onChange.addListener(
function (details) {
// The new value is stored in `details.value`, the new level of control
// in `details.levelOfControl`, and `details.incognitoSpecific` will be
// `true` if the value is specific to Incognito mode.
});</pre>
-
<h2 id="examples">Examples</h2>
<p>
For example code, see the
<a href="samples.html#privacy">Privacy API samples</a>.
</p>
<!-- END AUTHORED CONTENT --><div id="pageData-name" class="pageData">Privacy</div>
-
<!-- BEGIN AUTHORED CONTENT -->
<p id="classSummary">
Use the <code>chrome.privacy</code> module to control usage of the features in
@@ -530,18 +336,15 @@
<a href="types.html#ChromeSetting">ChromeSetting prototype of the type API</a>
for getting and setting Chrome's configuration.
</p>
-
<p class="note">
The <a href="http://www.google.com/intl/en/landing/chrome/google-chrome-privacy-whitepaper.pdf">Chrome Privacy Whitepaper</a>
gives background detail regarding the features which this API can control.
</p>
-
<h2 id="manifest">Manifest</h2>
<p>
You must declare the "privacy" permission in your extension's
<a href="manifest.html">manifest</a> to use the API. For example:
</p>
-
<pre>{
"name": "My extension",
...
@@ -550,9 +353,7 @@
]</b>,
...
}</pre>
-
<h2 id="usage">Usage</h2>
-
<p>
Reading the current value of a Chrome setting is straightforward. You'll first
need to find the property you're interested in, then you'll call
@@ -560,14 +361,12 @@
your extension's level of control. For example, to determine if Chrome's
Autofill feature is enabled, you'd write:
</p>
-
<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
if (details.value)
console.log('Autofill is on!');
else
console.log('Autofill is off!');
});</pre>
-
<p>
Changing the value of a setting is a little bit more complex, simply because
you first must verify that your extension can control the setting. The user
@@ -580,14 +379,12 @@
is advisable to warn the user when the settings they've chosen aren't
practically applied.
</p>
-
<p class="note">
Full details about extensions' ability to control <code>ChromeSetting</code>s
can be found under
<a href="types.html#ChromeSetting">
<code>chrome.types.ChromeSetting</code></a>.
</p>
-
<p>
This means that you ought to use the <code>get()</code> method to determine
your level of access, and then only call <code>set()</code> if your extension
@@ -595,7 +392,6 @@
setting it's probably a good idea to visibly disable the functionality to
reduce user confusion):
</p>
-
<pre>chrome.privacy.services.autofillEnabled.get({}, function(details) {
if (details.levelOfControl === 'controllable_by_this_extension') {
chrome.privacy.services.autofillEnabled.set({ value: true }, function() {
@@ -606,7 +402,6 @@
}
}
});</pre>
-
<p>
If you're interested in changes to a setting's value, add a listener to its
<code>onChange</code> event. Among other uses, this will allow you to warn the
@@ -614,14 +409,12 @@
enterprise policy overrides your control. To listen for changes to Autofill's
status, for example, the following code would suffice:
</p>
-
<pre>chrome.privacy.services.autofillEnabled.onChange.addListener(
function (details) {
// The new value is stored in `details.value`, the new level of control
// in `details.levelOfControl`, and `details.incognitoSpecific` will be
// `true` if the value is specific to Incognito mode.
});</pre>
-
<h2 id="examples">Examples</h2>
<p>
For example code, see the
@@ -629,17 +422,14 @@
</p>
<!-- END AUTHORED CONTENT -->
</div>
-
<!-- API PAGE -->
<div class="apiPage">
<a name="apiReference"></a>
<h2>API reference: chrome.privacy</h2>
-
<!-- PROPERTIES -->
<div class="apiGroup">
<a name="properties"></a>
<h3 id="properties">Properties</h3>
-
<div>
<a name="property-network"></a>
<h4>network</h4>
@@ -651,43 +441,19 @@
<dt>
<var>network</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>object</span>
- <span style="display: none; "></span>
</span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>Settings that influence Chrome's handling of network connections in general.</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>
<dl>
@@ -696,88 +462,30 @@
<dt>
<var>networkPredictionEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome attempts to speed up your web browsing experience by pre-resolving DNS entries, prerendering sites (<code>&lt;link rel='prefetch' ...&gt;</code>), and preemptively opening TCP and SSL connections to servers. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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>
</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><div>
<a name="property-services"></a>
@@ -790,43 +498,19 @@
<dt>
<var>services</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>object</span>
- <span style="display: none; "></span>
</span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>Settings that enable or disable features that require third-party network services provided by Google and your default search provider.</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>
<dl>
@@ -835,428 +519,145 @@
<dt>
<var>alternateErrorPagesEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome uses a web service to help resolve navigation errors. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>autofillEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome offers to automatically fill in forms. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>instantEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome automatically performs and displays search requests for text you type into the Omnibox as you type it. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>safeBrowsingEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome does its best to protect you from phishing and malware. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>searchSuggestEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome sends the text you type into the Omnibox to your default search engine, which provides predictions of websites and searches that are likely completions of what you've typed so far. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>translationServiceEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome offers to translate pages that aren't in a language you read. This preference's value is a boolean, defaulting to <code>true</code>.</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>
-
<!-- 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>
</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><div>
<a name="property-websites"></a>
@@ -1269,43 +670,19 @@
<dt>
<var>websites</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>object</span>
- <span style="display: none; "></span>
</span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>Settings that determine what information Chrome sends when requesting websites.</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>
<dl>
@@ -1314,378 +691,85 @@
<dt>
<var>thirdPartyCookiesAllowed</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If disabled, Chrome blocks third-party sites from setting cookies. The value of this preference is of type boolean, and the default value is <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>hyperlinkAuditingEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome sends auditing pings when requested by a website (<code>&lt;a ping&gt;</code>). The value of this preference is of type boolean, and the default value is <code>true</code>.</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>
-
<!-- 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><div>
<div>
<dt>
<var>referrersEnabled</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>
<a href="types.html#type-ChromeSetting">ChromeSetting</a>
</span>
- <span style="display: none; ">
- <span>
- array of <span><span></span></span>
- </span>
- <span>paramType</span>
- <span></span>
- </span>
</span>
)
</div>
-
</em>
</dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
<dd>If enabled, Chrome sends <code>referer</code> headers with your requests. Yes, the name of this preference doesn't match the misspelled header. No, we're not going to change it. The value of this preference is of type boolean, and the default value is <code>true</code>.</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>
-
<!-- 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>
</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>
-
</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>Returns</h4>
- <dl>
- <div>
- <div>
- </div>
- </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>
- 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>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
- </div>
-
- <!-- MIN_VERSION -->
- <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> <!-- /description -->
-
- </div> <!-- /apiItem -->
-
- </div> <!-- /apiGroup -->
-
+ <!-- /apiGroup -->
<!-- EVENTS -->
- <div id="eventsTemplate" class="apiGroup" style="display: none; ">
- <a></a>
- <h3>Events</h3>
- <!-- iterates over all events -->
- <div class="apiItem">
- <a></a>
- <h4>event name</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_param2</span>);
- </div>
-
- <div class="description">
- <p class="todo">Undocumented.</p>
- <p>
- A description from the json schema def of the event goes here.
- </p>
-
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
- </div>
-
- <!-- LISTENER RETURN VALUE -->
- <h4>Listener returns</h4>
- <dl>
- <div>
- <div>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
- </div> <!-- /apiItem -->
-
- </div> <!-- /apiGroup -->
-
+ <!-- /apiGroup -->
<!-- TYPES -->
- <div class="apiGroup" style="display: none; ">
- <a name="types"></a>
- <h3 id="types">Types</h3>
-
- <!-- iterates over all types -->
- <div class="apiItem">
- <a></a>
- <h4>type name</h4>
-
- <div>
- </div>
-
- </div> <!-- /apiItem -->
-
- </div> <!-- /apiGroup -->
-
+ <!-- /apiGroup -->
</div> <!-- /apiPage -->
</div> <!-- /gc-pagecontent -->
</div> <!-- /g-section -->
@@ -1701,18 +785,15 @@
<p>
©2011 Google
</p>
-
<!-- begin analytics -->
<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";