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

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

Issue 7029031: Content settings extension API (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: sync & review Created 9 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/extension.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/experimental.contentSettings.html
diff --git a/chrome/common/extensions/docs/extension.html b/chrome/common/extensions/docs/experimental.contentSettings.html
similarity index 67%
copy from chrome/common/extensions/docs/extension.html
copy to chrome/common/extensions/docs/experimental.contentSettings.html
index 528190993a46ad9942dae1bbbe0993335aba6514..913abda92e2f9b8e367310dffcecc9967cfd596b 100644
--- a/chrome/common/extensions/docs/extension.html
+++ b/chrome/common/extensions/docs/experimental.contentSettings.html
@@ -16,7 +16,7 @@
<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>
- <title>chrome.extension - Google Chrome Extensions - Google Code</title></head>
+ <title>chrome.experimental.contentSettings - 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.
@@ -251,70 +251,56 @@
<div class="g-unit" id="gc-pagecontent">
<div id="pageTitle">
- <h1 class="page_title">chrome.extension</h1>
+ <h1 class="page_title">chrome.experimental.contentSettings</h1>
</div>
<!-- TABLE OF CONTENTS -->
<div id="toc">
<h2>Contents</h2>
<ol>
- <li>
- <a href="#content scripts">Support for content scripts</a>
+ <li style="display: none; ">
+ <a>h2Name</a>
<ol>
- <li style="display: none; ">
+ <li>
<a>h3Name</a>
</li>
</ol>
</li>
<li>
- <a href="#apiReference">API reference: chrome.extension</a>
+ <a href="#apiReference">API reference: chrome.experimental.contentSettings</a>
<ol>
<li>
<a href="#properties">Properties</a>
<ol>
<li>
- <a href="#property-lastError">lastError</a>
+ <a href="#property-global">global</a>
</li><li>
- <a href="#property-inIncognitoContext">inIncognitoContext</a>
+ <a href="#property-cookies">cookies</a>
+ </li><li>
+ <a href="#property-images">images</a>
+ </li><li>
+ <a href="#property-javascript">javascript</a>
+ </li><li>
+ <a href="#property-plugins">plugins</a>
+ </li><li>
+ <a href="#property-popups">popups</a>
+ </li><li>
+ <a href="#property-notifications">notifications</a>
</li>
</ol>
</li>
- <li>
- <a href="#global-methods">Methods</a>
+ <li style="display: none; ">
+ <a>Methods</a>
<ol>
<li>
- <a href="#method-connect">connect</a>
- </li><li>
- <a href="#method-getBackgroundPage">getBackgroundPage</a>
- </li><li style="display: none; ">
- <a href="#method-anchor">methodName</a>
- </li><li style="display: none; ">
<a href="#method-anchor">methodName</a>
- </li><li>
- <a href="#method-getURL">getURL</a>
- </li><li>
- <a href="#method-getViews">getViews</a>
- </li><li>
- <a href="#method-isAllowedFileSchemeAccess">isAllowedFileSchemeAccess</a>
- </li><li>
- <a href="#method-isAllowedIncognitoAccess">isAllowedIncognitoAccess</a>
- </li><li>
- <a href="#method-sendRequest">sendRequest</a>
- </li><li>
- <a href="#method-setUpdateUrlData">setUpdateUrlData</a>
</li>
</ol>
</li>
- <li>
- <a href="#global-events">Events</a>
+ <li style="display: none; ">
+ <a>Events</a>
<ol>
<li>
- <a href="#event-onConnect">onConnect</a>
- </li><li>
- <a href="#event-onConnectExternal">onConnectExternal</a>
- </li><li>
- <a href="#event-onRequest">onRequest</a>
- </li><li>
- <a href="#event-onRequestExternal">onRequestExternal</a>
+ <a href="#event-anchor">eventName</a>
</li>
</ol>
</li>
@@ -322,11 +308,13 @@
<a href="#types">Types</a>
<ol>
<li>
- <a href="#type-MessageSender">MessageSender</a>
+ <a href="#type-ResourceIdentifier">ResourceIdentifier</a>
</li><li>
- <a href="#type-Event">Event</a>
+ <a href="#type-Pattern">Pattern</a>
</li><li>
- <a href="#type-Port">Port</a>
+ <a href="#type-ContentSettingRule">ContentSettingRule</a>
+ </li><li>
+ <a href="#type-ContentSetting">ContentSetting</a>
</li>
</ol>
</li>
@@ -337,64 +325,17 @@
<!-- /TABLE OF CONTENTS -->
<!-- Standard content lead-in for experimental API pages -->
- <p id="classSummary" style="display: none; ">
+ <p id="classSummary">
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"><!-- BEGIN AUTHORED CONTENT -->
-<p id="classSummary">
-The <code>chrome.extension</code> module
-has utilities that can be used by any extension page.
-It includes support for exchanging messages
-between an extension and its content scripts
-or between extensions,
-as described in detail in
-<a href="messaging.html">Message Passing</a>.
-</p>
-
-<h2 id="content scripts">Support for content scripts</h2>
-<p>
-Unlike the other chrome.* APIs,
-parts of <code>chrome.extension</code>
-can be used by content scripts:
-</p>
-
-<dl>
- <dt>
- <a href="#method-sendRequest"><code>sendRequest()</code></a> and
- <a href="#event-onRequest"><code>onRequest</code></a>
- </dt>
- <dd>
- Simple communication with extension pages
- </dd>
- <dt>
- <a href="#method-connect"><code>connect()</code></a> and
- <a href="#event-onConnect"><code>onConnect</code></a>
- </dt>
- <dd>
- Extended communication with extension pages
- </dd>
- <dt>
- <a href="#method-getURL"><code>getURL()</code></a>
- </dt>
- <dd>
- Access to extension resources such as image files
- </dd>
-</dl>
-
-<p>
-For details, see
-<a href="content_scripts.html">Content Scripts</a>.
-</p>
-
-<!-- END AUTHORED CONTENT -->
-</div>
+ <div id="static"></div>
<!-- API PAGE -->
<div class="apiPage">
<a name="apiReference"></a>
- <h2>API reference: chrome.extension</h2>
+ <h2>API reference: chrome.experimental.contentSettings</h2>
<!-- PROPERTIES -->
<div class="apiGroup">
@@ -402,21 +343,21 @@ For details, see
<h3 id="properties">Properties</h3>
<div>
- <a name="property-lastError"></a>
- <h4>lastError</h4>
+ <a name="property-global"></a>
+ <h4>global</h4>
<div class="summary">
<!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.</span><span>lastError</span>
+ <span>chrome.experimental.contentSettings.</span><span>global</span>
</div>
<div>
<dt>
- <var>lastError</var>
+ <var>global</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; ">
@@ -435,10 +376,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>Set for the lifetime of a callback if an ansychronous extension api has resulted in an error. If no error has occured lastError will be <var>undefined</var>.</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>.
@@ -455,7 +398,7 @@ For details, see
<div>
<div>
<dt>
- <var>message</var>
+ <var>thirdPartyCookiesAllowed</var>
<em>
<!-- TYPE -->
@@ -464,15 +407,15 @@ For details, see
<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="types.html#type-ChromeSetting">ChromeSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>string</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -483,7 +426,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Description of the error that has taken place.</dd>
+ <dd>Whether third party cookies should be allowed. The value of this preference is of type boolean, and the default value is true.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -520,53 +463,27 @@ For details, see
</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-inIncognitoContext"></a>
- <h4>inIncognitoContext</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.</span><span>inIncognitoContext</span>
- </div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>inIncognitoContext</var>
+ <var>referrersEnabled</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="types.html#type-ChromeSetting">ChromeSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>object</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -577,7 +494,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>True for content scripts running inside incognito tabs, and for extension pages running inside an incognito process. The latter only applies to extensions with 'split' incognito_behavior.</dd>
+ <dd>Whether referrers should be enabled. The value of this preference is of type boolean, and the default value is true.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -589,12 +506,35 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd>
+ <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>message</var>
+ <var>hyperlinkAuditingEnabled</var>
<em>
<!-- TYPE -->
@@ -603,15 +543,15 @@ For details, see
<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="types.html#type-ChromeSetting">ChromeSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>boolean</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -622,7 +562,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>True if the page or script is in an incongito process.</dd>
+ <dd>Whether to enable hyperlink auditing ("&lt;a ping&gt;"). The value of this preference is of type boolean, and the default value is true.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -679,54 +619,33 @@ For details, see
</dd>
</div>
- </div>
-
- </div> <!-- /apiGroup -->
-
- <!-- METHODS -->
- <div id="methodsTemplate" class="apiGroup">
- <a name="global-methods"></a>
- <h3>Methods</h3>
-
- <!-- iterates over all functions -->
- <div class="apiItem">
- <a name="method-connect"></a> <!-- method-anchor -->
- <h4>connect</h4>
-
- <div class="summary"><span>Port</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.connect</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span>
- <var><span>extensionId</span></var></span><span class="optional"><span>, </span><span>object</span>
- <var><span>connectInfo</span></var></span>)</div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Attempts to connect to other listeners within the extension (such as the extension's background page). This is primarily useful for content scripts connecting to their extension processes. Extensions may connect to content scripts embedded in tabs via <a href="tabs.html#method-connect"><code>chrome.tabs.connect()</code></a>.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ </div><div>
+ <a name="property-cookies"></a>
+ <h4>cookies</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>cookies</span>
+ </div>
+ <div>
<dt>
- <var>extensionId</var>
+ <var>cookies</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.contentSettings.html#type-ContentSetting">ContentSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>string</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -737,7 +656,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd>
+ <dd>Whether to allow cookies and other local data to be set by websites. One of<br><var>allow</var>: Accept cookies,<br><var>block</var>: Block cookies,<br><var>session_only</var>: Accept cookies only for the current session. Default is <var>allow</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -774,27 +693,33 @@ For details, see
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <a name="property-images"></a>
+ <h4>images</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>images</span>
+ </div>
+ <div>
<dt>
- <var>connectInfo</var>
+ <var>images</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.contentSettings.html#type-ContentSetting">ContentSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>object</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -802,12 +727,10 @@ For details, see
</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>Whether to show images. One of<br><var>allow</var>: Show images,<br><var>block</var>: Don't show images. Default is <var>allow</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -819,29 +742,58 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd>
+ <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>
+ <a name="property-javascript"></a>
+ <h4>javascript</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>javascript</span>
+ </div>
+ <div>
<dt>
- <var>name</var>
+ <var>javascript</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.contentSettings.html#type-ContentSetting">ContentSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>string</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -852,7 +804,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Will be passed into onConnect for extension processes that are listening for the connection event.</dd>
+ <dd>Whether to run Javascript. One of<br><var>allow</var>: Run Javascript,<br><var>block</var>: Don't run Javascript. Default is <var>allow</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -889,36 +841,16 @@ For details, see
</dd>
</div>
+ </div><div>
+ <a name="property-plugins"></a>
+ <h4>plugins</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>plugins</span>
</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>
-
- <!-- RETURNS -->
- <h4>Returns</h4>
- <dl>
- <div>
- <div>
+ <div>
<dt>
- <var style="display: none; ">paramName</var>
+ <var>plugins</var>
<em>
<!-- TYPE -->
@@ -928,7 +860,7 @@ For details, see
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span>
- <a href="extension.html#type-Port">Port</a>
+ <a href="experimental.contentSettings.html#type-ContentSetting">ContentSetting</a>
</span>
<span style="display: none; ">
<span>
@@ -946,7 +878,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>Port through which messages can be sent and received with the extension. The port's <a href="extension.html#type-Port">onDisconnect</a> event is fired if extension does not exist. </dd>
+ <dd>Whether to run plug-ins. One of<br><var>allow</var>: Run plug-ins automatically,<br><var>block</var>: Don't run plug-ins automatically. Default is <var>allow</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -983,957 +915,16 @@ For details, see
</dd>
</div>
- </div>
- </dl>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <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 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-getBackgroundPage"></a> <!-- method-anchor -->
- <h4>getBackgroundPage</h4>
-
- <div class="summary"><span>DOMWindow</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.getBackgroundPage</span>(<span style="display: none; "><span>, </span><span></span>
- <var><span></span></var></span>)</div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Returns the JavaScript 'window' object for the background page running inside the current extension. Returns null if the extension has no background page.</p>
-
- <!-- PARAMETERS -->
- <h4 style="display: none; ">Parameters</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- <!-- RETURNS -->
- <h4>Returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var style="display: none; ">paramName</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>DOMWindow</span>
- <span style="display: none; "></span>
- </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>
-
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <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>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <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 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" style="display: none; ">
- <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><div class="apiItem" style="display: none; ">
- <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><div class="apiItem">
- <a name="method-getURL"></a> <!-- method-anchor -->
- <h4>getURL</h4>
-
- <div class="summary"><span>string</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.getURL</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>path</span></var></span>)</div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Converts a relative path within an extension install directory to a fully-qualified URL.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>path</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>A path to a resource within an extension expressed relative to its install directory.</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>
-
- <!-- RETURNS -->
- <h4>Returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var style="display: none; ">paramName</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 fully-qualified URL to the resource.</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>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <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 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-getViews"></a> <!-- method-anchor -->
- <h4>getViews</h4>
-
- <div class="summary"><span>array of DOMWindow</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.getViews</span>(<span class="optional"><span style="display: none; ">, </span><span>object</span>
- <var><span>fetchProperties</span></var></span>)</div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Returns an array of the JavaScript 'window' objects for each of the pages running inside the current extension.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>fetchProperties</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>object</span>
- <span style="display: none; "></span>
- </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>
-
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>type</var>
- <em>
-
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span class="enum">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>["tab", "infobar", "notification", "popup"]</span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>The type of view to get. If omitted, returns all views (including background pages and tabs). Valid values: 'tab', 'infobar', 'notification', 'popup'.</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>windowId</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>integer</span>
- <span style="display: none; "></span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>The window to restrict the search to. If omitted, returns all views.</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>
- </dl>
-
- <!-- RETURNS -->
- <h4>Returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var style="display: none; ">paramName</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>
- array of <span><span>
- <span style="display: none; ">
- <a> Type</a>
- </span>
- <span>
- <span style="display: none; ">
- array of <span><span></span></span>
- </span>
- <span>DOMWindow</span>
- <span style="display: none; "></span>
- </span>
- </span></span>
- </span>
- <span style="display: none; ">paramType</span>
- <span style="display: none; "></span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>Array of global objects</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>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <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 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-isAllowedFileSchemeAccess"></a> <!-- method-anchor -->
- <h4>isAllowedFileSchemeAccess</h4>
-
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.isAllowedFileSchemeAccess</span>(<span class="null"><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>Retrieves the state of the extension's access to the 'file://' scheme (as determined by the user-controlled 'Allow access to File URLs' checkbox.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <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>
-
- </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>
-
- <!-- 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>
-
- <!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
- <dl>
- <div style="display: none; ">
- <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 style="display: none; ">
- 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>boolean isAllowedAccess</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
+ </div><div>
+ <a name="property-popups"></a>
+ <h4>popups</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>popups</span>
+ </div>
+ <div>
<dt>
- <var>isAllowedAccess</var>
+ <var>popups</var>
<em>
<!-- TYPE -->
@@ -1942,15 +933,15 @@ For details, see
<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.contentSettings.html#type-ContentSetting">ContentSetting</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>boolean</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -1961,7 +952,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>True if the extension can access the 'file://' scheme, false otherwise.</dd>
+ <dd>Whether to allow sites to show pop-ups. One of<br><var>allow</var>: Allow sites to show pop-ups,<br><var>block</var>: Don't allow sites to show pop-ups. Default is <var>block</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -1998,40 +989,16 @@ For details, see
</dd>
</div>
- </div>
- </dl>
- </div>
- </div>
-
- <!-- MIN_VERSION -->
- <p>
- This function was added in version <b><span>12.0.706.0</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-isAllowedIncognitoAccess"></a> <!-- method-anchor -->
- <h4>isAllowedIncognitoAccess</h4>
-
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.isAllowedIncognitoAccess</span>(<span class="null"><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>Retrieves the state of the extension's access to Incognito-mode (as determined by the user-controlled 'Allowed in Incognito' checkbox.</p>
-
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ </div><div>
+ <a name="property-notifications"></a>
+ <h4>notifications</h4>
+ <div class="summary">
+ <!-- Note: intentionally longer 80 columns -->
+ <span>chrome.experimental.contentSettings.</span><span>notifications</span>
+ </div>
+ <div>
<dt>
- <var>callback</var>
+ <var>notifications</var>
<em>
<!-- TYPE -->
@@ -2040,15 +1007,15 @@ For details, see
<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.contentSettings.html#type-ContentSetting">ContentSetting</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>
)
@@ -2056,12 +1023,10 @@ For details, see
</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>Whether to allow sites to show desktop notifications. One of<br><var>allow</var>: Allow sites to show desktop notifications,<br><var>block</var>: Don't allow sites to show desktop notifications,<br><var>ask</var>: Ask when a site wants to show desktop notifications. Default is <var>ask</var>.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2098,13 +1063,44 @@ For details, see
</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>
@@ -2118,82 +1114,17 @@ For details, see
The callback <em>parameter</em> should specify a function
that looks like this:
</p>
- <p style="display: none; ">
+ <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>boolean isAllowedAccess</span>) <span class="subdued">{...}</span>;</pre>
+ <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre>
<dl>
<div>
<div>
- <dt>
- <var>isAllowedAccess</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>boolean</span>
- <span style="display: none; "></span>
- </span>
- </span>
- )
- </div>
-
- </em>
- </dt>
- <dd class="todo" style="display: none; ">
- Undocumented.
- </dd>
- <dd>True if the extension has access to Incognito mode, false otherwise.</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>
</dl>
</div>
@@ -2201,41 +1132,92 @@ For details, see
<!-- MIN_VERSION -->
<p>
- This function was added in version <b><span>12.0.706.0</span></b>.
+ 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-sendRequest"></a> <!-- method-anchor -->
- <h4>sendRequest</h4>
+ </div> <!-- /apiItem -->
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.sendRequest</span>(<span class="optional"><span style="display: none; ">, </span><span>string</span>
- <var><span>extensionId</span></var></span><span class="null"><span>, </span><span>any</span>
- <var><span>request</span></var></span><span class="optional"><span>, </span><span>function</span>
- <var><span>responseCallback</span></var></span>)</div>
+ </div> <!-- /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" style="display: none; ">Undocumented.</p>
- <p>Sends a single request to other listeners within the extension. Similar to chrome.extension.connect, but only sends a single request with an optional response. The <a href="extension.html#event-onRequest">chrome.extension.onRequest</a> event is fired in each page of the extension.</p>
+ <p class="todo">Undocumented.</p>
+ <p>
+ A description from the json schema def of the event goes here.
+ </p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
+ <!-- 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 -->
+
+ <!-- TYPES -->
+ <div class="apiGroup">
+ <a name="types"></a>
+ <h3 id="types">Types</h3>
+
+ <!-- iterates over all types -->
+ <div class="apiItem">
+ <a name="type-ResourceIdentifier"></a>
+ <h4>ResourceIdentifier</h4>
+
+ <div>
<dt>
- <var>extensionId</var>
+ <var style="display: none; ">paramName</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; ">
@@ -2245,7 +1227,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2257,7 +1239,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The extension ID of the extension you want to connect to. If omitted, default is your own extension.</dd>
+ <dd>Currently, no content types use resource identifiers.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2269,35 +1251,12 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<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>request</var>
+ <var>id</var>
<em>
<!-- TYPE -->
@@ -2313,7 +1272,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2322,12 +1281,10 @@ For details, see
</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>The resource identifier for the given content type.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2364,16 +1321,16 @@ For details, see
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>responseCallback</var>
+ <var>description</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; ">
@@ -2383,7 +1340,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2392,12 +1349,10 @@ For details, see
</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 human readable description of the resource.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2429,14 +1384,39 @@ For details, see
</dd>
<!-- FUNCTION PARAMETERS -->
- <dd>
- <div>
- <h5>Parameters</h5>
- <dl>
- <div>
+ <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 class="apiItem">
+ <a name="type-Pattern"></a>
+ <h4>Pattern</h4>
+
<div>
<dt>
- <var>response</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -2452,7 +1432,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2461,10 +1441,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set to the error message.</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>.
@@ -2476,69 +1458,12 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<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>
- </div>
- </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>any response</span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- <div>
- <div>
<dt>
- <var>response</var>
+ <var>pattern</var>
<em>
<!-- TYPE -->
@@ -2554,7 +1479,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>string</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2566,7 +1491,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The JSON response object sent by the handler of the request. If an error occurs while connecting to the extension, the callback will be called with no arguments and <a href="extension.html#property-lastError">chrome.extension.lastError</a> will be set to the error message.</dd>
+ <dd>The pattern string. The pattern should never be constructed directly, but should always be derived from an URL using the methods in the <var>contentSettings.patterns</var> module.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2603,40 +1528,34 @@ For details, see
</dd>
</div>
- </div>
- </dl>
- </div>
- </div>
+ </div>
+ </dl>
+ </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 -->
+ <!-- OBJECT METHODS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- </div><div class="apiItem">
- <a name="method-setUpdateUrlData"></a> <!-- method-anchor -->
- <h4>setUpdateUrlData</h4>
+ <!-- OBJECT EVENT FIELDS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="summary"><span style="display: none; ">void</span>
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.extension.setUpdateUrlData</span>(<span class="null"><span style="display: none; ">, </span><span>string</span>
- <var><span>data</span></var></span>)</div>
+ <!-- FUNCTION PARAMETERS -->
+ <dd style="display: none; ">
+ <div></div>
+ </dd>
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Sets the value of the ap CGI parameter used in the extension's update URL. This value is ignored for extensions that are hosted in the Chrome Extension Gallery.</p>
+ </div>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
+ </div><div class="apiItem">
+ <a name="type-ContentSettingRule"></a>
+ <h4>ContentSettingRule</h4>
+
+ <div>
<dt>
- <var>data</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -2652,7 +1571,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>string</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -2678,106 +1597,12 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<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>
-
- <!-- RETURNS -->
- <h4 style="display: none; ">Returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
- </div>
- </dl>
-
- <!-- CALLBACK -->
- <div style="display: none; ">
- <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 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> <!-- /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-onConnect"></a>
- <h4>onConnect</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.extension.</span><span>onConnect</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span><span></span>));
- </div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when a connection is made from either an extension process or a content script.</p>
-
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
+ <div>
+ <div>
<dt>
- <var>port</var>
+ <var>topLevelPattern</var>
<em>
<!-- TYPE -->
@@ -2787,7 +1612,7 @@ For details, see
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span>
- <a href="extension.html#type-Port">Port</a>
+ <a href="experimental.contentSettings.html#type-Pattern">Pattern</a>
</span>
<span style="display: none; ">
<span>
@@ -2802,12 +1627,10 @@ For details, see
</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>The pattern for the top-level frame URL.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2844,52 +1667,10 @@ For details, see
</dd>
</div>
- </div>
- </dl>
- </div>
-
- <!-- 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>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onConnectExternal"></a>
- <h4>onConnectExternal</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.extension.</span><span>onConnectExternal</span><span class="subdued">.addListener</span>(function(<span>Port port</span>) <span class="subdued">{...}</span><span></span>));
- </div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when a connection is made from another extension.</p>
-
- <!-- LISTENER PARAMETERS -->
+ </div><div>
<div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
<dt>
- <var>port</var>
+ <var>embeddedPattern</var>
<em>
<!-- TYPE -->
@@ -2899,7 +1680,7 @@ For details, see
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span>
- <a href="extension.html#type-Port">Port</a>
+ <a href="experimental.contentSettings.html#type-Pattern">Pattern</a>
</span>
<span style="display: none; ">
<span>
@@ -2914,12 +1695,10 @@ For details, see
</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>The pattern for the frame or object URL.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -2956,69 +1735,27 @@ For details, see
</dd>
</div>
- </div>
- </dl>
- </div>
-
- <!-- 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>
- </div>
- </div>
- </dl>
-
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onRequest"></a>
- <h4>onRequest</h4>
-
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.extension.</span><span>onRequest</span><span class="subdued">.addListener</span>(function(<span>any request, MessageSender sender, function sendResponse</span>) <span class="subdued">{...}</span><span></span>));
- </div>
-
- <div class="description">
- <p class="todo" style="display: none; ">Undocumented.</p>
- <p>Fired when a request is sent from either an extension process or a content script.</p>
-
- <!-- LISTENER PARAMETERS -->
+ </div><div>
<div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
<dt>
- <var>request</var>
+ <var>resourceIdentifier</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 style="display: none; ">
+ <a href="experimental.contentSettings.html#type-ResourceIdentifier">ResourceIdentifier</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>any</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -3029,7 +1766,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The request sent by the calling script.</dd>
+ <dd>The resource identifier for the content type.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3066,10 +1803,10 @@ For details, see
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>sender</var>
+ <var>setting</var>
<em>
<!-- TYPE -->
@@ -3078,15 +1815,15 @@ For details, see
<span class="optional" style="display: none; ">optional</span>
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
- <span>
- <a href="extension.html#type-MessageSender">MessageSender</a>
- </span>
<span style="display: none; ">
- <span>
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>paramType</span>
- <span></span>
+ <span>any</span>
+ <span style="display: none; "></span>
</span>
</span>
)
@@ -3094,12 +1831,10 @@ For details, see
</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>The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3136,10 +1871,34 @@ For details, see
</dd>
</div>
- </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 class="apiItem">
+ <a name="type-ContentSetting"></a>
+ <h4>ContentSetting</h4>
+
+ <div>
<dt>
- <var>sendResponse</var>
+ <var style="display: none; ">paramName</var>
<em>
<!-- TYPE -->
@@ -3155,7 +1914,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -3164,10 +1923,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</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>.
@@ -3189,67 +1950,33 @@ For details, see
</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>
-
- <!-- 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>
- </div>
- </div>
- </dl>
+ <dd>
+ <div class="apiGroup" style="">
+ <a name="global-ContentSetting-methods"></a>
+ <h3>Methods of ContentSetting</h3>
- </div> <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onRequestExternal"></a>
- <h4>onRequestExternal</h4>
+ <!-- iterates over all functions -->
+ <div class="apiItem">
+ <a name="method-ContentSetting-clear"></a> <!-- method-anchor -->
+ <h4>clear</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.extension.</span><span>onRequestExternal</span><span class="subdued">.addListener</span>(function(<span>any request, MessageSender sender, function sendResponse</span>) <span class="subdued">{...}</span><span></span>));
- </div>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>contentSetting.clear</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
+ <var><span>details</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>Fired when a request is sent from another extension.</p>
+ <p>Clear all content setting rules set by this extension.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
<div>
- <div>
<dt>
- <var>request</var>
+ <var>details</var>
<em>
<!-- TYPE -->
@@ -3265,7 +1992,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>any</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -3274,10 +2001,57 @@ For details, see
</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>
+
+ <!-- OBJECT PROPERTIES -->
+ <dd>
+ <dl>
+ <div>
+ <div>
+ <dt>
+ <var>scope</var>
+ <em>
+
+ <!-- TYPE -->
+ <div style="display:inline">
+ (
+ <span class="optional">optional</span>
+ <span class="enum">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>["regular", "incognito_session_only"]</span>
+ </span>
+ </span>
+ )
+ </div>
+
+ </em>
+ </dt>
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The request sent by the calling script.</dd>
+ <dd>Where to set the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3314,56 +2088,6 @@ For details, see
</dd>
</div>
- </div><div>
- <div>
- <dt>
- <var>sender</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="extension.html#type-MessageSender">MessageSender</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">
- 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>
-
- <!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
- <dl>
- <div>
- <div>
- </div>
</div>
</dl>
</dd>
@@ -3384,16 +2108,16 @@ For details, see
</dd>
</div>
- </div><div>
- <div>
+ </div><div>
+ <div>
<dt>
- <var>sendResponse</var>
+ <var>callback</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; ">
@@ -3412,10 +2136,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>Function to call when you have a response. The argument should be any JSON-ifiable object, or undefined if there is no response.</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>.
@@ -3452,48 +2178,72 @@ For details, see
</dd>
</div>
+ </div>
+ </dl>
+
+ <!-- RETURNS -->
+ <h4 style="display: none; ">Returns</h4>
+ <dl>
+ <div style="display: none; ">
+ <div>
</div>
- </dl>
- </div>
+ </div>
+ </dl>
- <!-- EXTRA PARAMETERS -->
- <div style="display: none; ">
- <h4>Extra parameters to addListener</h4>
+ <!-- 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>
+ <div style="display: none; ">
<div>
</div>
</div>
</dl>
- </div>
-
- <!-- LISTENER RETURN VALUE -->
- <h4 style="display: none; ">Listener returns</h4>
- <dl>
- <div style="display: none; ">
- <div>
- </div>
</div>
- </dl>
+ </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> <!-- /apiGroup -->
+ </div><div class="apiItem">
+ <a name="method-ContentSetting-get"></a> <!-- method-anchor -->
+ <h4>get</h4>
- <!-- TYPES -->
- <div class="apiGroup">
- <a name="types"></a>
- <h3 id="types">Types</h3>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>contentSetting.get</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
+ <var><span>details</span></var></span><span class="null"><span>, </span><span>function</span>
+ <var><span>callback</span></var></span>)</div>
- <!-- iterates over all types -->
- <div class="apiItem">
- <a name="type-MessageSender"></a>
- <h4>MessageSender</h4>
+ <div class="description">
+ <p class="todo" style="display: none; ">Undocumented.</p>
+ <p>Get the current content setting for a given pair of URLs.</p>
- <div>
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
<dt>
- <var style="display: none; ">paramName</var>
+ <var>details</var>
<em>
<!-- TYPE -->
@@ -3518,10 +2268,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>An object containing information about the script context that sent a message or request.</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>.
@@ -3538,24 +2290,24 @@ For details, see
<div>
<div>
<dt>
- <var>tab</var>
+ <var>embeddedUrl</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>
- <a href="tabs.html#type-Tab">Tab</a>
- </span>
<span style="display: none; ">
- <span>
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>paramType</span>
- <span></span>
+ <span>string</span>
+ <span style="display: none; "></span>
</span>
</span>
)
@@ -3566,7 +2318,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>This property will <b>only</b> be present when the connection was opened from a tab or content script.</dd>
+ <dd>The URL of the frame or object for which the content settings should be retrieved.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3606,7 +2358,7 @@ For details, see
</div><div>
<div>
<dt>
- <var>id</var>
+ <var>topLevelUrl</var>
<em>
<!-- TYPE -->
@@ -3634,7 +2386,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>The extension ID of the extension that opened the connection.</dd>
+ <dd>The URL of the top-level frame.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3671,51 +2423,27 @@ For details, see
</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 class="apiItem">
- <a name="type-Event"></a>
- <h4>Event</h4>
-
- <div>
+ </div><div>
+ <div>
<dt>
- <var style="display: none; ">paramName</var>
+ <var>resourceIdentifier</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 style="display: none; ">
+ <a href="experimental.contentSettings.html#type-ResourceIdentifier">ResourceIdentifier</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>object</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -3726,7 +2454,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>An object which allows the addition and removal of listeners for a Chrome event.</dd>
+ <dd>A more specific identifier of the type of content for which the settings should be retrieved.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3738,18 +2466,41 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd>
+ <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>addListener</var>
+ <var>incognito</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; ">
@@ -3759,7 +2510,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>boolean</span>
<span style="display: none; "></span>
</span>
</span>
@@ -3768,12 +2519,10 @@ For details, see
</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>Whether to check the content settings for an incognito session. (default false)</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -3810,10 +2559,30 @@ For details, see
</dd>
</div>
- </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>removeListener</var>
+ <var>callback</var>
<em>
<!-- TYPE -->
@@ -3880,10 +2649,38 @@ For details, see
</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>
+ 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>
+
+ <!-- Note: intentionally longer 80 columns -->
+ <pre>function(<span>object details</span>) <span class="subdued">{...}</span>;</pre>
+ <dl>
+ <div>
+ <div>
<dt>
- <var>hasListener</var>
+ <var>details</var>
<em>
<!-- TYPE -->
@@ -3899,7 +2696,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>object</span>
<span style="display: none; "></span>
</span>
</span>
@@ -3925,35 +2722,12 @@ For details, see
</dd>
<!-- OBJECT PROPERTIES -->
- <dd style="display: none; ">
+ <dd>
<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>hasListeners</var>
+ <var>setting</var>
<em>
<!-- TYPE -->
@@ -3969,7 +2743,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>any</span>
<span style="display: none; "></span>
</span>
</span>
@@ -3978,12 +2752,10 @@ For details, see
</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>The content setting. See the description of the individual ContentSetting objects for the possible values.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4040,14 +2812,41 @@ For details, see
</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="type-Port"></a>
- <h4>Port</h4>
+ <a name="method-ContentSetting-set"></a> <!-- method-anchor -->
+ <h4>set</h4>
- <div>
+ <div class="summary"><span style="display: none; ">void</span>
+ <!-- Note: intentionally longer 80 columns -->
+ <span>contentSetting.set</span>(<span class="null"><span style="display: none; ">, </span><span>object</span>
+ <var><span>details</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>Apply a new content setting rule.</p>
+
+ <!-- PARAMETERS -->
+ <h4>Parameters</h4>
+ <dl>
+ <div>
+ <div>
<dt>
- <var style="display: none; ">paramName</var>
+ <var>details</var>
<em>
<!-- TYPE -->
@@ -4072,10 +2871,12 @@ For details, see
</em>
</dt>
- <dd class="todo" style="display: none; ">
+ <dd class="todo">
Undocumented.
</dd>
- <dd>An object which allows two way communication with other pages.</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>.
@@ -4092,7 +2893,7 @@ For details, see
<div>
<div>
<dt>
- <var>name</var>
+ <var>topLevelPattern</var>
<em>
<!-- TYPE -->
@@ -4101,15 +2902,15 @@ For details, see
<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.contentSettings.html#type-Pattern">Pattern</a>
+ </span>
+ <span style="display: none; ">
+ <span>
array of <span><span></span></span>
</span>
- <span>string</span>
- <span style="display: none; "></span>
+ <span>paramType</span>
+ <span></span>
</span>
</span>
)
@@ -4117,12 +2918,10 @@ For details, see
</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>The pattern for the top-level frame URL.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4162,7 +2961,7 @@ For details, see
</div><div>
<div>
<dt>
- <var>onDisconnect</var>
+ <var>embeddedPattern</var>
<em>
<!-- TYPE -->
@@ -4172,7 +2971,7 @@ For details, see
<span class="enum" style="display: none; ">enumerated</span>
<span id="typeTemplate">
<span>
- <a href="extension.html#type-Event">Event</a>
+ <a href="experimental.contentSettings.html#type-Pattern">Pattern</a>
</span>
<span style="display: none; ">
<span>
@@ -4187,12 +2986,10 @@ For details, see
</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>The pattern for the frame or object URL.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4232,17 +3029,17 @@ For details, see
</div><div>
<div>
<dt>
- <var>onMessage</var>
+ <var>resourceIdentifier</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>
- <a href="extension.html#type-Event">Event</a>
+ <a href="experimental.contentSettings.html#type-ResourceIdentifier">ResourceIdentifier</a>
</span>
<span style="display: none; ">
<span>
@@ -4257,12 +3054,10 @@ For details, see
</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>The resource identifier for the content type.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4302,7 +3097,7 @@ For details, see
</div><div>
<div>
<dt>
- <var>postMessage</var>
+ <var>setting</var>
<em>
<!-- TYPE -->
@@ -4318,7 +3113,7 @@ For details, see
<span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>function</span>
+ <span>any</span>
<span style="display: none; "></span>
</span>
</span>
@@ -4327,12 +3122,10 @@ For details, see
</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>The setting applied by this rule. See the description of the individual ContentSetting objects for the possible values.</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4372,24 +3165,24 @@ For details, see
</div><div>
<div>
<dt>
- <var>sender</var>
+ <var>scope</var>
<em>
<!-- TYPE -->
<div style="display:inline">
(
<span class="optional">optional</span>
- <span class="enum" style="display: none; ">enumerated</span>
+ <span class="enum">enumerated</span>
<span id="typeTemplate">
- <span>
- <a href="extension.html#type-MessageSender">MessageSender</a>
- </span>
<span style="display: none; ">
- <span>
+ <a> Type</a>
+ </span>
+ <span>
+ <span style="display: none; ">
array of <span><span></span></span>
</span>
- <span>paramType</span>
- <span></span>
+ <span>string</span>
+ <span>["regular", "incognito_session_only"]</span>
</span>
</span>
)
@@ -4400,7 +3193,7 @@ For details, see
<dd class="todo" style="display: none; ">
Undocumented.
</dd>
- <dd>This property will <b>only</b> be present on ports passed to onConnect/onConnectExternal listeners.</dd>
+ <dd>Where to clear the setting (default: regular). One of<br><var>regular</var>: setting for regular profile (which is inherited by the incognito profile if not overridden elsewhere),<br><var>incognito_session_only</var>: setting for incognito profile that can only be set during an incognito session and is deleted when the incognito session ends (overrides regular settings).</dd>
<dd style="display: none; ">
This parameter was added in version
<b><span></span></b>.
@@ -4457,6 +3250,137 @@ For details, see
</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">
+ 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>
+
+ <!-- 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>
+
+ <!-- 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 -->
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/extension.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698