| Index: chrome/common/extensions/docs/experimental.downloads.html
|
| diff --git a/chrome/common/extensions/docs/experimental.webRequest.html b/chrome/common/extensions/docs/experimental.downloads.html
|
| similarity index 78%
|
| copy from chrome/common/extensions/docs/experimental.webRequest.html
|
| copy to chrome/common/extensions/docs/experimental.downloads.html
|
| index f3ebc79944f6c0d8d8cc0096393d9581e9b535e1..9d3353ef0b78f75326a5ae0bd0b382974a491747 100644
|
| --- a/chrome/common/extensions/docs/experimental.webRequest.html
|
| +++ b/chrome/common/extensions/docs/experimental.downloads.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>WebRequest API - Google Chrome Extensions - Google Code</title></head>
|
| + <title>chrome.experimental.downloads - 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,58 +251,72 @@
|
|
|
| <div class="g-unit" id="gc-pagecontent">
|
| <div id="pageTitle">
|
| - <h1 class="page_title">WebRequest API</h1>
|
| + <h1 class="page_title">chrome.experimental.downloads</h1>
|
| </div>
|
| <!-- TABLE OF CONTENTS -->
|
| <div id="toc">
|
| <h2>Contents</h2>
|
| <ol>
|
| - <li>
|
| - <a href="#H2-0">A note about timestamps</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.experimental.webRequest</a>
|
| + <a href="#apiReference">API reference: chrome.experimental.downloads</a>
|
| <ol>
|
| - <li style="display: none; ">
|
| + <li>
|
| <a href="#properties">Properties</a>
|
| <ol>
|
| <li>
|
| - <a href="#property-anchor">propertyName</a>
|
| + <a href="#property-STATE_IN_PROGRESS">STATE_IN_PROGRESS</a>
|
| + </li><li>
|
| + <a href="#property-STATE_INTERRUPTED">STATE_INTERRUPTED</a>
|
| + </li><li>
|
| + <a href="#property-STATE_COMPLETE">STATE_COMPLETE</a>
|
| + </li><li>
|
| + <a href="#property-DANGER_SAFE">DANGER_SAFE</a>
|
| + </li><li>
|
| + <a href="#property-DANGER_FILE">DANGER_FILE</a>
|
| + </li><li>
|
| + <a href="#property-DANGER_URL">DANGER_URL</a>
|
| </li>
|
| </ol>
|
| </li>
|
| <li>
|
| <a href="#global-methods">Methods</a>
|
| <ol>
|
| - <li style="display: none; ">
|
| - <a href="#method-anchor">methodName</a>
|
| - </li><li style="display: none; ">
|
| - <a href="#method-anchor">methodName</a>
|
| - </li>
|
| - </ol>
|
| - </li>
|
| - <li>
|
| - <a href="#global-events">Events</a>
|
| - <ol>
|
| <li>
|
| - <a href="#event-onBeforeRedirect">onBeforeRedirect</a>
|
| + <a href="#method-acceptDanger">acceptDanger</a>
|
| </li><li>
|
| - <a href="#event-onBeforeRequest">onBeforeRequest</a>
|
| + <a href="#method-cancel">cancel</a>
|
| </li><li>
|
| - <a href="#event-onBeforeSendHeaders">onBeforeSendHeaders</a>
|
| + <a href="#method-download">download</a>
|
| </li><li>
|
| - <a href="#event-onCompleted">onCompleted</a>
|
| + <a href="#method-drag">drag</a>
|
| </li><li>
|
| - <a href="#event-onErrorOccurred">onErrorOccurred</a>
|
| + <a href="#method-erase">erase</a>
|
| </li><li>
|
| - <a href="#event-onRequestSent">onRequestSent</a>
|
| + <a href="#method-pause">pause</a>
|
| </li><li>
|
| - <a href="#event-onResponseStarted">onResponseStarted</a>
|
| + <a href="#method-resume">resume</a>
|
| + </li><li>
|
| + <a href="#method-search">search</a>
|
| + </li><li>
|
| + <a href="#method-setDestination">setDestination</a>
|
| + </li><li>
|
| + <a href="#method-show">show</a>
|
| + </li>
|
| + </ol>
|
| + </li>
|
| + <li style="display: none; ">
|
| + <a>Events</a>
|
| + <ol>
|
| + <li>
|
| + <a href="#event-anchor">eventName</a>
|
| </li>
|
| </ol>
|
| </li>
|
| @@ -310,11 +324,13 @@
|
| <a href="#types">Types</a>
|
| <ol>
|
| <li>
|
| - <a href="#type-RequestFilter">RequestFilter</a>
|
| + <a href="#type-DownloadItem">DownloadItem</a>
|
| + </li><li>
|
| + <a href="#type-DownloadOptions">DownloadOptions</a>
|
| </li><li>
|
| - <a href="#type-HttpHeaders">HttpHeaders</a>
|
| + <a href="#type-DownloadQuery">DownloadQuery</a>
|
| </li><li>
|
| - <a href="#type-BlockingResponse">BlockingResponse</a>
|
| + <a href="#type-DownloadResponse">DownloadResponse</a>
|
| </li>
|
| </ol>
|
| </li>
|
| @@ -325,233 +341,40 @@
|
| <!-- /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"><div id="pageData-name" class="pageData">WebRequest API</div>
|
| -
|
| -<!-- BEGIN AUTHORED CONTENT -->
|
| -<p id="classSummary">
|
| -Use the <code>chrome.experimental.webRequest</code> module to intercept, block,
|
| -or modify requests in-flight. This module is still very much experimental. For
|
| -information on how to use experimental APIs, see the
|
| -<a href="experimental.html">chrome.experimental.* APIs</a> page.
|
| -</p>
|
| -
|
| -<a name="H2-0"></a><h2>A note about timestamps</h2>
|
| -<p>
|
| -It's important to note that some technical oddities in the OS's handling
|
| -of distinct Chrome processes can cause the clock to be skewed between the
|
| -browser itself and extension processes. That means that WebRequest's events'
|
| -<code>timeStamp</code> property is only guaranteed to be <i>internally</i>
|
| -consistent. Comparing one event to another event will give you the correct
|
| -offset between them, but comparing them to the current time inside the
|
| -extension (via <code>(new Date()).getTime()</code>, for instance) might give
|
| -unexpected results.
|
| -</p>
|
| -<!-- END AUTHORED CONTENT -->
|
| -</div>
|
| + <div id="static"></div>
|
|
|
| <!-- API PAGE -->
|
| <div class="apiPage">
|
| <a name="apiReference"></a>
|
| - <h2>API reference: chrome.experimental.webRequest</h2>
|
| + <h2>API reference: chrome.experimental.downloads</h2>
|
|
|
| <!-- PROPERTIES -->
|
| - <div class="apiGroup" style="display: none; ">
|
| + <div class="apiGroup">
|
| <a name="properties"></a>
|
| <h3 id="properties">Properties</h3>
|
|
|
| <div>
|
| - <a></a>
|
| - <h4>getLastError</h4>
|
| + <a name="property-STATE_IN_PROGRESS"></a>
|
| + <h4>STATE_IN_PROGRESS</h4>
|
| <div class="summary">
|
| <!-- Note: intentionally longer 80 columns -->
|
| - <span>chrome.extension</span><span>lastError</span>
|
| + <span>chrome.experimental.downloads.</span><span>STATE_IN_PROGRESS</span>
|
| </div>
|
| <div>
|
| - </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" 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> <!-- /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-onBeforeRedirect"></a>
|
| - <h4>onBeforeRedirect</h4>
|
| -
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onBeforeRedirect</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| - </div>
|
| -
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when a server initiated redirect is about to occur.</p>
|
| -
|
| - <!-- LISTENER PARAMETERS -->
|
| - <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>STATE_IN_PROGRESS</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -560,8 +383,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -569,12 +392,10 @@ unexpected results.
|
|
|
| </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 download is currently receiving data from the server.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -586,19 +407,48 @@ unexpected results.
|
| </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-STATE_INTERRUPTED"></a>
|
| + <h4>STATE_INTERRUPTED</h4>
|
| + <div class="summary">
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.</span><span>STATE_INTERRUPTED</span>
|
| + </div>
|
| + <div>
|
| <dt>
|
| - <var>requestId</var>
|
| + <var>STATE_INTERRUPTED</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -608,7 +458,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -619,7 +469,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the request.</dd>
|
| + <dd>An error broke the connection with the file host.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -656,17 +506,23 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <a name="property-STATE_COMPLETE"></a>
|
| + <h4>STATE_COMPLETE</h4>
|
| + <div class="summary">
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.</span><span>STATE_COMPLETE</span>
|
| + </div>
|
| + <div>
|
| <dt>
|
| - <var>url</var>
|
| + <var>STATE_COMPLETE</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -676,7 +532,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -687,7 +543,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The URL of the current request.</dd>
|
| + <dd>The download has completed.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -724,17 +580,23 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <a name="property-DANGER_SAFE"></a>
|
| + <h4>DANGER_SAFE</h4>
|
| + <div class="summary">
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.</span><span>DANGER_SAFE</span>
|
| + </div>
|
| + <div>
|
| <dt>
|
| - <var>statusCode</var>
|
| + <var>DANGER_SAFE</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -743,8 +605,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -755,7 +617,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Standard HTTP status code returned by the server.</dd>
|
| + <dd>The file has been determined to present no known danger to the user's computer.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -792,17 +654,23 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <a name="property-DANGER_FILE"></a>
|
| + <h4>DANGER_FILE</h4>
|
| + <div class="summary">
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.</span><span>DANGER_FILE</span>
|
| + </div>
|
| + <div>
|
| <dt>
|
| - <var>redirectUrl</var>
|
| + <var>DANGER_FILE</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -812,7 +680,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -823,7 +691,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The new URL.</dd>
|
| + <dd>The download's filename is suspicious.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -860,17 +728,23 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <a name="property-DANGER_URL"></a>
|
| + <h4>DANGER_URL</h4>
|
| + <div class="summary">
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.</span><span>DANGER_URL</span>
|
| + </div>
|
| + <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>DANGER_URL</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -879,8 +753,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -891,7 +765,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the browser was about to make the redirect, in milliseconds since the epoch.</dd>
|
| + <dd>The download's URL is suspicious.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -928,20 +802,477 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| - <dt>
|
| - <var>responseHeaders</var>
|
| - <em>
|
| + </div>
|
|
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + </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-acceptDanger"></a> <!-- method-anchor -->
|
| + <h4>acceptDanger</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.acceptDanger</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Accept a dangerous download</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| + <dt>
|
| + <var>id</var>
|
| + <em>
|
| +
|
| + <!-- TYPE -->
|
| + <div style="display:inline">
|
| + (
|
| + <span class="optional" style="display: none; ">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>integer</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>
|
| +
|
| + <!-- 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><div class="apiItem">
|
| + <a name="method-cancel"></a> <!-- method-anchor -->
|
| + <h4>cancel</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.cancel</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Cancel a download</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| + <dt>
|
| + <var>id</var>
|
| + <em>
|
| +
|
| + <!-- TYPE -->
|
| + <div style="display:inline">
|
| + (
|
| + <span class="optional" style="display: none; ">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>integer</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>
|
| +
|
| + <!-- 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><div class="apiItem">
|
| + <a name="method-download"></a> <!-- method-anchor -->
|
| + <h4>download</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.download</span>(<span class="null"><span style="display: none; ">, </span><span>DownloadOptions</span>
|
| + <var><span>undefined</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>Download a URL.</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</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">enumerated</span>
|
| + <span id="typeTemplate">
|
| + <span>
|
| + <a href="experimental.downloads.html#type-DownloadOptions">DownloadOptions</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>
|
| +
|
| + <!-- 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>callback</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>function</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>
|
| +
|
| + <!-- 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>DownloadResponse undefined</span>) <span class="subdued">{...}</span>;</pre>
|
| + <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">enumerated</span>
|
| <span id="typeTemplate">
|
| <span>
|
| - <a href="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</a>
|
| + <a href="experimental.downloads.html#type-DownloadResponse">DownloadResponse</a>
|
| </span>
|
| <span style="display: none; ">
|
| <span>
|
| @@ -956,10 +1287,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The HTTP response headers that were received along with this redirect.</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>.
|
| @@ -996,17 +1329,47 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </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-drag"></a> <!-- method-anchor -->
|
| + <h4>drag</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.drag</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Drag the file to another application</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| <dt>
|
| - <var>statusLine</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -1015,8 +1378,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1024,10 +1387,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>HTTP status line of the 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>.
|
| @@ -1064,48 +1429,82 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </dd>
|
| -
|
| - <!-- OBJECT METHODS -->
|
| - <dd style="display: none; ">
|
| - <div></div>
|
| - </dd>
|
| + </div>
|
| + </dl>
|
|
|
| - <!-- OBJECT EVENT FIELDS -->
|
| - <dd style="display: none; ">
|
| - <div></div>
|
| - </dd>
|
| + <!-- RETURNS -->
|
| + <h4 style="display: none; ">Returns</h4>
|
| + <dl>
|
| + <div style="display: none; ">
|
| + <div>
|
| + </div>
|
| + </div>
|
| + </dl>
|
|
|
| - <!-- FUNCTION PARAMETERS -->
|
| - <dd style="display: none; ">
|
| - <div></div>
|
| - </dd>
|
| + <!-- 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>
|
|
|
| - </div>
|
| + <!-- 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>
|
|
|
| - <!-- EXTRA PARAMETERS -->
|
| - <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| + <!-- 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-erase"></a> <!-- method-anchor -->
|
| + <h4>erase</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.erase</span>(<span class="null"><span style="display: none; ">, </span><span>DownloadQuery</span>
|
| + <var><span>undefined</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>Erase DownloadItems from history</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var style="display: none; ">paramName</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span>
|
| - <a href="experimental.webRequest.html#type-RequestFilter">RequestFilter</a>
|
| + <a href="experimental.downloads.html#type-DownloadQuery">DownloadQuery</a>
|
| </span>
|
| <span style="display: none; ">
|
| <span>
|
| @@ -1120,10 +1519,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</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>.
|
| @@ -1160,38 +1561,27 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>extraInfoSpec</var>
|
| + <var>callback</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 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>string</span>
|
| - <span>["statusLine", "responseHeaders"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>function</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1199,10 +1589,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</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>.
|
| @@ -1239,12 +1631,11 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| + </div>
|
| + </dl>
|
|
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <h4 style="display: none; ">Listener returns</h4>
|
| + <!-- RETURNS -->
|
| + <h4 style="display: none; ">Returns</h4>
|
| <dl>
|
| <div style="display: none; ">
|
| <div>
|
| @@ -1252,45 +1643,43 @@ unexpected results.
|
| </div>
|
| </dl>
|
|
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onBeforeRequest"></a>
|
| - <h4>onBeforeRequest</h4>
|
| -
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onBeforeRequest</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| - </div>
|
| -
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when a request is about to occur.</p>
|
| -
|
| - <!-- LISTENER PARAMETERS -->
|
| + <!-- CALLBACK -->
|
| <div>
|
| - <h4>Listener parameters</h4>
|
| + <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>null</span>) <span class="subdued">{...}</span>;</pre>
|
| <dl>
|
| <div>
|
| <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>ids</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</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>
|
| + array of <span style="display: none; "><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span style="display: none; ">paramType</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1315,87 +1704,72 @@ unexpected results.
|
| </dd>
|
|
|
| <!-- OBJECT PROPERTIES -->
|
| - <dd>
|
| + <dd style="display: none; ">
|
| <dl>
|
| <div>
|
| <div>
|
| - <dt>
|
| - <var>requestId</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>
|
| + </div>
|
| + </dl>
|
| + </dd>
|
|
|
| - </em>
|
| - </dt>
|
| - <dd class="todo" style="display: none; ">
|
| - Undocumented.
|
| + <!-- OBJECT METHODS -->
|
| + <dd style="display: none; ">
|
| + <div></div>
|
| </dd>
|
| - <dd>The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.</dd>
|
| +
|
| + <!-- OBJECT EVENT FIELDS -->
|
| <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.
|
| + <div></div>
|
| </dd>
|
|
|
| - <!-- OBJECT PROPERTIES -->
|
| + <!-- FUNCTION PARAMETERS -->
|
| <dd style="display: none; ">
|
| - <dl>
|
| - <div>
|
| - <div>
|
| - </div>
|
| - </div>
|
| - </dl>
|
| + <div></div>
|
| </dd>
|
|
|
| - <!-- OBJECT METHODS -->
|
| - <dd style="display: none; ">
|
| - <div></div>
|
| - </dd>
|
| + </div>
|
| + </div>
|
| + </dl>
|
| + </div>
|
| + </div>
|
| +
|
| + <!-- MIN_VERSION -->
|
| + <p style="display: none; ">
|
| + This function was added in version <b><span></span></b>.
|
| + If you require this function, the manifest key
|
| + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a>
|
| + can ensure that your extension won't be run in an earlier browser version.
|
| + </p>
|
| + </div> <!-- /description -->
|
| +
|
| + </div><div class="apiItem">
|
| + <a name="method-pause"></a> <!-- method-anchor -->
|
| + <h4>pause</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.experimental.downloads.pause</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</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>Pause the download</p>
|
|
|
| - </div>
|
| - </div><div>
|
| - <div>
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| <dt>
|
| - <var>url</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -1404,8 +1778,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1455,17 +1829,78 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <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><div class="apiItem">
|
| + <a name="method-resume"></a> <!-- method-anchor -->
|
| + <h4>resume</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.resume</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Resume a paused download</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| <dt>
|
| - <var>method</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -1474,8 +1909,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1483,10 +1918,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>Standard HTTP method.</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>.
|
| @@ -1523,27 +1960,89 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <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><div class="apiItem">
|
| + <a name="method-search"></a> <!-- method-anchor -->
|
| + <h4>search</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.search</span>(<span class="null"><span style="display: none; ">, </span><span>DownloadQuery</span>
|
| + <var><span>undefined</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>Find DownloadItems</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| <dt>
|
| - <var>tabId</var>
|
| + <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 class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span style="display: none; ">
|
| - <a> Type</a>
|
| - </span>
|
| <span>
|
| - <span style="display: none; ">
|
| + <a href="experimental.downloads.html#type-DownloadQuery">DownloadQuery</a>
|
| + </span>
|
| + <span style="display: none; ">
|
| + <span>
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span>paramType</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1551,10 +2050,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the tab in which the request takes place. Set to null if the request isn't related to a tab.</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>.
|
| @@ -1591,16 +2092,16 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>type</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">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| @@ -1610,8 +2111,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"]</span>
|
| + <span>function</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1619,10 +2120,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>How the requested resource will be used.</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>.
|
| @@ -1659,27 +2162,55 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| + </div>
|
| + </dl>
|
| +
|
| + <!-- RETURNS -->
|
| + <h4 style="display: none; ">Returns</h4>
|
| + <dl>
|
| + <div style="display: none; ">
|
| + <div>
|
| + </div>
|
| + </div>
|
| + </dl>
|
| +
|
| + <!-- CALLBACK -->
|
| <div>
|
| + <div>
|
| + <h4>Callback function</h4>
|
| + <p style="display: none; ">
|
| + The callback <em>parameter</em> should specify a function
|
| + that looks like this:
|
| + </p>
|
| + <p>
|
| + If you specify the <em>callback</em> parameter, it should
|
| + specify a function that looks like this:
|
| + </p>
|
| +
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <pre>function(<span>null</span>) <span class="subdued">{...}</span>;</pre>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>items</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</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>
|
| + array of <span style="display: none; "><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span style="display: none; ">paramType</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1687,10 +2218,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the browser was about to make the request, in milliseconds since the epoch.</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>.
|
| @@ -1727,54 +2260,57 @@ unexpected results.
|
| </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>
|
| + </div>
|
| </div>
|
|
|
| - <!-- EXTRA PARAMETERS -->
|
| - <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| + <!-- 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-setDestination"></a> <!-- method-anchor -->
|
| + <h4>setDestination</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.setDestination</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span><span class="null"><span>, </span><span>string</span>
|
| + <var><span>path</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Move a downloaded file</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| + <dl>
|
| + <div>
|
| <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>integer</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -1783,10 +2319,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</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>.
|
| @@ -1823,38 +2361,27 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>extraInfoSpec</var>
|
| + <var>path</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">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>string</span>
|
| - <span>["blocking"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -1862,10 +2389,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</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>.
|
| @@ -1902,33 +2431,87 @@ unexpected results.
|
| </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>
|
|
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <h4>Listener returns</h4>
|
| + <!-- 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-show"></a> <!-- method-anchor -->
|
| + <h4>show</h4>
|
| +
|
| + <div class="summary"><span style="display: none; ">void</span>
|
| + <!-- Note: intentionally longer 80 columns -->
|
| + <span>chrome.experimental.downloads.show</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span>
|
| + <var><span>id</span></var></span>)</div>
|
| +
|
| + <div class="description">
|
| + <p class="todo" style="display: none; ">Undocumented.</p>
|
| + <p>Show in folder</p>
|
| +
|
| + <!-- PARAMETERS -->
|
| + <h4>Parameters</h4>
|
| <dl>
|
| <div>
|
| <div>
|
| <dt>
|
| - <var style="display: none; ">paramName</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-BlockingResponse">BlockingResponse</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>integer</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -1937,10 +2520,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</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>.
|
| @@ -1980,19 +2565,71 @@ unexpected results.
|
| </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><div class="apiItem">
|
| - <a name="event-onBeforeSendHeaders"></a>
|
| - <h4>onBeforeSendHeaders</h4>
|
| +
|
| + </div> <!-- /apiItem -->
|
| +
|
| + </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.experimental.webRequest.</span><span>onBeforeSendHeaders</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| + <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>Fires before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent. </p>
|
| + <p class="todo">Undocumented.</p>
|
| + <p>
|
| + A description from the json schema def of the event goes here.
|
| + </p>
|
|
|
| <!-- LISTENER PARAMETERS -->
|
| <div>
|
| @@ -2000,15 +2637,56 @@ unexpected results.
|
| <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-DownloadItem"></a>
|
| + <h4>DownloadItem</h4>
|
| +
|
| + <div>
|
| <dt>
|
| - <var>details</var>
|
| + <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 class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2018,7 +2696,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2026,12 +2704,10 @@ unexpected results.
|
|
|
| </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 state of a downloading file.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2048,14 +2724,14 @@ unexpected results.
|
| <div>
|
| <div>
|
| <dt>
|
| - <var>requestId</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2064,8 +2740,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2076,7 +2752,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the request. Request IDs are unique within a browser session. As a result, they could be used to relate different events of the same request.</dd>
|
| + <dd>A persistent identifier</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2123,7 +2799,7 @@ unexpected results.
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2133,7 +2809,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2141,12 +2817,10 @@ unexpected results.
|
|
|
| </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>absolute URL</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2186,14 +2860,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>filename</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2202,8 +2876,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2214,7 +2888,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the browser was about to send headers, in milliseconds since the epoch.</dd>
|
| + <dd>absolute local path</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2254,23 +2928,23 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>requestHeaders</var>
|
| + <var>danger</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</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>string</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -2282,7 +2956,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The HTTP request headers that are going to be sent out with this request.</dd>
|
| + <dd>Safety</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2293,32 +2967,12 @@ unexpected results.
|
| 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 -->
|
| + <!-- OBJECT PROPERTIES -->
|
| <dd style="display: none; ">
|
| - <div></div>
|
| - </dd>
|
| -
|
| - </div>
|
| + <dl>
|
| + <div>
|
| + <div>
|
| + </div>
|
| </div>
|
| </dl>
|
| </dd>
|
| @@ -2339,34 +2993,26 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| -
|
| - <!-- EXTRA PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var>dangerAccepted</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>boolean</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -2378,7 +3024,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
|
| + <dd>true if the user has accepted the download's danger.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2415,38 +3061,27 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>extraInfoSpec</var>
|
| + <var>mime</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">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>string</span>
|
| - <span>["requestLine", "requestHeaders", "blocking"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2457,7 +3092,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</dd>
|
| + <dd>The file's MIME type.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2494,33 +3129,26 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| -
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <h4>Listener returns</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var style="display: none; ">paramName</var>
|
| + <var>startTime</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-BlockingResponse">BlockingResponse</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>integer</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -2532,7 +3160,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</dd>
|
| + <dd>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2569,38 +3197,17 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| -
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onCompleted"></a>
|
| - <h4>onCompleted</h4>
|
| -
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onCompleted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| - </div>
|
| -
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when a request is completed.</p>
|
| -
|
| - <!-- LISTENER PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>endTime</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2609,8 +3216,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2618,12 +3225,10 @@ unexpected results.
|
|
|
| </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>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2635,19 +3240,42 @@ unexpected results.
|
| </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>requestId</var>
|
| + <var>state</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2657,7 +3285,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2665,10 +3293,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the 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>.
|
| @@ -2708,14 +3338,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>url</var>
|
| + <var>paused</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2724,8 +3354,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>boolean</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2736,7 +3366,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The URL of the current request.</dd>
|
| + <dd>true if the download has stopped reading data</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2776,14 +3406,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>statusCode</var>
|
| + <var>error</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2793,7 +3423,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2804,7 +3434,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Standard HTTP status code returned by the server.</dd>
|
| + <dd>net error code if state is interrupted</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2844,14 +3474,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>bytesReceived</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2860,8 +3490,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -2872,7 +3502,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the response was received completely, in milliseconds since the epoch.</dd>
|
| + <dd>pre-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2912,23 +3542,23 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>responseHeaders</var>
|
| + <var>totalBytes</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</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>integer</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -2940,7 +3570,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The HTTP response headers that were received along with this response.</dd>
|
| + <dd>pre-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -2980,14 +3610,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>statusLine</var>
|
| + <var>fileSize</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -2996,8 +3626,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3008,7 +3638,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>HTTP status line of the response</dd>
|
| + <dd>post-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3065,34 +3695,30 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
|
|
| - <!-- EXTRA PARAMETERS -->
|
| - <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| + </div><div class="apiItem">
|
| + <a name="type-DownloadOptions"></a>
|
| + <h4>DownloadOptions</h4>
|
| +
|
| + <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var style="display: none; ">paramName</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>object</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -3101,10 +3727,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</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>.
|
| @@ -3116,63 +3744,29 @@ unexpected results.
|
| </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>extraInfoSpec</var>
|
| + <var>url</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional" style="display: none; ">optional</span>
|
| + <span class="enum">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>string</span>
|
| - <span>["statusLine", "responseHeaders"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3183,7 +3777,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</dd>
|
| + <dd>The URL to download.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3220,48 +3814,17 @@ unexpected results.
|
| </dd>
|
|
|
| </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-onErrorOccurred"></a>
|
| - <h4>onErrorOccurred</h4>
|
| -
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onErrorOccurred</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter</span>));
|
| - </div>
|
| -
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when an error occurs.</p>
|
| -
|
| - <!-- LISTENER PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>filename</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3270,8 +3833,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3279,12 +3842,10 @@ unexpected results.
|
|
|
| </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>relative local path</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3296,19 +3857,42 @@ unexpected results.
|
| </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>requestId</var>
|
| + <var>saveAs</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3317,8 +3901,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>boolean</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3329,7 +3913,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the request.</dd>
|
| + <dd>Show the Save File As dialog.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3369,14 +3953,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>url</var>
|
| + <var>method</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3386,7 +3970,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3397,7 +3981,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The URL of the current request.</dd>
|
| + <dd>GET or POST</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3437,14 +4021,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>error</var>
|
| + <var>headers</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3453,8 +4037,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>object</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3465,7 +4049,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The error description. This string is <em>not</em> guaranteed to remain backwards compatible between releases. You must not parse and act based upon its content.</dd>
|
| + <dd>request headers</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3477,9 +4061,9 @@ unexpected results.
|
| </dd>
|
|
|
| <!-- OBJECT PROPERTIES -->
|
| - <dd style="display: none; ">
|
| + <dd>
|
| <dl>
|
| - <div>
|
| + <div style="display: none; ">
|
| <div>
|
| </div>
|
| </div>
|
| @@ -3505,14 +4089,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>body</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3521,8 +4105,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3533,7 +4117,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the error occurred, in milliseconds since the epoch.</dd>
|
| + <dd>post body</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3590,34 +4174,77 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| +
|
| + </div><div class="apiItem">
|
| + <a name="type-DownloadQuery"></a>
|
| + <h4>DownloadQuery</h4>
|
| +
|
| + <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">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></span>
|
| + </span>
|
| + </span>
|
| + )
|
| </div>
|
|
|
| - <!-- EXTRA PARAMETERS -->
|
| + </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>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var>query</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="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>string</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -3629,7 +4256,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
|
| + <dd>boolean search terms</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3666,48 +4293,85 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div>
|
| - </dl>
|
| - </div>
|
| + </div><div>
|
| + <div>
|
| + <dt>
|
| + <var>startedBefore</var>
|
| + <em>
|
|
|
| - <!-- LISTENER RETURN VALUE -->
|
| - <h4 style="display: none; ">Listener returns</h4>
|
| - <dl>
|
| - <div style="display: none; ">
|
| - <div>
|
| - </div>
|
| - </div>
|
| - </dl>
|
| + <!-- 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>integer</span>
|
| + <span></span>
|
| + </span>
|
| + </span>
|
| + )
|
| + </div>
|
|
|
| - </div> <!-- /description -->
|
| - </div><div class="apiItem">
|
| - <a name="event-onRequestSent"></a>
|
| - <h4>onRequestSent</h4>
|
| + </em>
|
| + </dt>
|
| + <dd class="todo" style="display: none; ">
|
| + Undocumented.
|
| + </dd>
|
| + <dd>ms since epoch</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>
|
|
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onRequestSent</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| + <!-- OBJECT PROPERTIES -->
|
| + <dd style="display: none; ">
|
| + <dl>
|
| + <div>
|
| + <div>
|
| + </div>
|
| </div>
|
| + </dl>
|
| + </dd>
|
|
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when a request is sent to the server.</p>
|
| + <!-- OBJECT METHODS -->
|
| + <dd style="display: none; ">
|
| + <div></div>
|
| + </dd>
|
|
|
| - <!-- LISTENER PARAMETERS -->
|
| + <!-- OBJECT EVENT FIELDS -->
|
| + <dd style="display: none; ">
|
| + <div></div>
|
| + </dd>
|
| +
|
| + <!-- FUNCTION PARAMETERS -->
|
| + <dd style="display: none; ">
|
| + <div></div>
|
| + </dd>
|
| +
|
| + </div>
|
| + </div><div>
|
| <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>startedAfter</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3716,8 +4380,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3725,12 +4389,10 @@ unexpected results.
|
|
|
| </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>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3742,19 +4404,42 @@ unexpected results.
|
| </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>requestId</var>
|
| + <var>endedBefore</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3763,8 +4448,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3775,7 +4460,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the request.</dd>
|
| + <dd>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3815,14 +4500,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>url</var>
|
| + <var>endedAfter</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3831,8 +4516,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3840,12 +4525,10 @@ unexpected results.
|
|
|
| </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>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -3885,14 +4568,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>ip</var>
|
| + <var>totalBytesGreater</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3901,8 +4584,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3910,10 +4593,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The server IP address that is actually connected to. Note that it may be a literal IPv6 address.</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>.
|
| @@ -3953,14 +4638,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>totalBytesLess</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -3969,8 +4654,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -3978,10 +4663,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the browser finished sending the request, in milliseconds since the epoch.</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>.
|
| @@ -4021,23 +4708,23 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>requestHeaders</var>
|
| + <var>filenameRegex</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="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</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>string</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -4046,10 +4733,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>The HTTP request headers that have been sent out with this 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>.
|
| @@ -4086,54 +4775,26 @@ unexpected results.
|
| </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>
|
| - </div>
|
| -
|
| - <!-- EXTRA PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var>urlRegex</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="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>string</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -4142,10 +4803,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</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>.
|
| @@ -4182,38 +4845,27 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>extraInfoSpec</var>
|
| + <var>limit</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 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>string</span>
|
| - <span>["requestLine", "requestHeaders"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4221,10 +4873,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</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>.
|
| @@ -4261,48 +4915,17 @@ unexpected results.
|
| </dd>
|
|
|
| </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-onResponseStarted"></a>
|
| - <h4>onResponseStarted</h4>
|
| -
|
| - <div class="summary">
|
| - <!-- Note: intentionally longer 80 columns -->
|
| - <span class="subdued">chrome.experimental.webRequest.</span><span>onResponseStarted</span><span class="subdued">.addListener</span>(function(<span>object details</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>));
|
| - </div>
|
| -
|
| - <div class="description">
|
| - <p class="todo" style="display: none; ">Undocumented.</p>
|
| - <p>Fires when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.</p>
|
| -
|
| - <!-- LISTENER PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Listener parameters</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>details</var>
|
| + <var>orderBy</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4311,8 +4934,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4337,19 +4960,42 @@ unexpected results.
|
| </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>requestId</var>
|
| + <var>id</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4358,8 +5004,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4370,7 +5016,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The ID of the request.</dd>
|
| + <dd>A persistent identifier</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4416,8 +5062,8 @@ unexpected results.
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4427,7 +5073,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4435,12 +5081,10 @@ unexpected results.
|
|
|
| </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>absolute URL</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4480,14 +5124,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>statusCode</var>
|
| + <var>filename</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4496,8 +5140,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4508,7 +5152,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Standard HTTP status code returned by the server.</dd>
|
| + <dd>absolute local path</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4548,14 +5192,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>timeStamp</var>
|
| + <var>danger</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4564,8 +5208,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>number</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4576,7 +5220,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The time when the status line and response headers were received, in milliseconds since the epoch.</dd>
|
| + <dd>Safety</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4616,23 +5260,23 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>responseHeaders</var>
|
| + <var>dangerAccepted</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="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</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>boolean</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -4644,7 +5288,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>The HTTP response headers that were received along with this response.</dd>
|
| + <dd>true if the user has accepted the download's danger.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4684,14 +5328,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>statusLine</var>
|
| + <var>mime</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 style="display: none; ">
|
| <a> Type</a>
|
| @@ -4701,7 +5345,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4712,7 +5356,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>HTTP status line of the response</dd>
|
| + <dd>The file's MIME type.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4749,54 +5393,26 @@ unexpected results.
|
| </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>
|
| - </div>
|
| -
|
| - <!-- EXTRA PARAMETERS -->
|
| + </div><div>
|
| <div>
|
| - <h4>Extra parameters to addListener</h4>
|
| - <dl>
|
| - <div>
|
| - <div>
|
| <dt>
|
| - <var>filter</var>
|
| + <var>startTime</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="experimental.webRequest.html#type-RequestFilter">RequestFilter</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>integer</span>
|
| <span></span>
|
| </span>
|
| </span>
|
| @@ -4808,7 +5424,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
|
| + <dd>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4845,24 +5461,18 @@ unexpected results.
|
| </dd>
|
|
|
| </div>
|
| - </div><div>
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var>extraInfoSpec</var>
|
| + <var>endTime</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>
|
| - array of <span><span>
|
| + (
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| + <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| </span>
|
| @@ -4870,13 +5480,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span>["statusLine", "responseHeaders"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4887,7 +5492,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Array of extra information that should be passed to the listener function.</dd>
|
| + <dd>ms since epoch</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -4924,44 +5529,17 @@ unexpected results.
|
| </dd>
|
|
|
| </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> <!-- /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-RequestFilter"></a>
|
| - <h4>RequestFilter</h4>
|
| -
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var style="display: none; ">paramName</var>
|
| + <var>state</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -4970,8 +5548,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span>string</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -4979,10 +5557,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>An object describing filters to apply to webRequest events.</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>.
|
| @@ -4994,40 +5574,52 @@ unexpected results.
|
| </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>urls</var>
|
| + <var>paused</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 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>string</span>
|
| - <span style="display: none; "></span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>boolean</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5038,7 +5630,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.</dd>
|
| + <dd>true if the download has stopped reading data</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5078,35 +5670,24 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>types</var>
|
| + <var>error</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 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>string</span>
|
| - <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"]</span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5117,7 +5698,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>A list of request types. Requests that cannot match any of the types will be filtered out.</dd>
|
| + <dd>net error code if state is interrupted</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5157,14 +5738,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>tabId</var>
|
| + <var>bytesReceived</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 style="display: none; ">
|
| <a> Type</a>
|
| @@ -5174,7 +5755,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5182,12 +5763,10 @@ unexpected results.
|
|
|
| </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>pre-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5227,14 +5806,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>windowId</var>
|
| + <var>totalBytes</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 style="display: none; ">
|
| <a> Type</a>
|
| @@ -5244,7 +5823,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>integer</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5252,12 +5831,10 @@ unexpected results.
|
|
|
| </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>pre-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5294,62 +5871,27 @@ unexpected results.
|
| </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-HttpHeaders"></a>
|
| - <h4>HttpHeaders</h4>
|
| -
|
| - <div>
|
| + </div><div>
|
| + <div>
|
| <dt>
|
| - <var style="display: none; ">paramName</var>
|
| + <var>fileSize</var>
|
| <em>
|
|
|
| <!-- TYPE -->
|
| <div style="display:inline">
|
| (
|
| - <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="optional">optional</span>
|
| + <span class="enum">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>object</span>
|
| - <span style="display: none; "></span>
|
| - </span>
|
| - </span></span>
|
| - </span>
|
| - <span style="display: none; ">paramType</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5360,7 +5902,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>An array of HTTP headers, in the form of name/value pairs.</dd>
|
| + <dd>post-decompression</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5397,10 +5939,30 @@ unexpected results.
|
| </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-BlockingResponse"></a>
|
| - <h4>BlockingResponse</h4>
|
| + <a name="type-DownloadResponse"></a>
|
| + <h4>DownloadResponse</h4>
|
|
|
| <div>
|
| <dt>
|
| @@ -5411,7 +5973,7 @@ unexpected results.
|
| <div style="display:inline">
|
| (
|
| <span class="optional" style="display: none; ">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| + <span class="enum">enumerated</span>
|
| <span id="typeTemplate">
|
| <span style="display: none; ">
|
| <a> Type</a>
|
| @@ -5421,7 +5983,7 @@ unexpected results.
|
| array of <span><span></span></span>
|
| </span>
|
| <span>object</span>
|
| - <span style="display: none; "></span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5432,7 +5994,7 @@ unexpected results.
|
| <dd class="todo" style="display: none; ">
|
| Undocumented.
|
| </dd>
|
| - <dd>Return value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.</dd>
|
| + <dd>Result of download()</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
| @@ -5449,14 +6011,14 @@ unexpected results.
|
| <div>
|
| <div>
|
| <dt>
|
| - <var>cancel</var>
|
| + <var>id</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 style="display: none; ">
|
| <a> Type</a>
|
| @@ -5465,8 +6027,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>boolean</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5474,10 +6036,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent.</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>.
|
| @@ -5517,14 +6081,14 @@ unexpected results.
|
| </div><div>
|
| <div>
|
| <dt>
|
| - <var>redirectUrl</var>
|
| + <var>error</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 style="display: none; ">
|
| <a> Type</a>
|
| @@ -5533,8 +6097,8 @@ unexpected results.
|
| <span style="display: none; ">
|
| array of <span><span></span></span>
|
| </span>
|
| - <span>string</span>
|
| - <span style="display: none; "></span>
|
| + <span>integer</span>
|
| + <span></span>
|
| </span>
|
| </span>
|
| )
|
| @@ -5542,78 +6106,12 @@ unexpected results.
|
|
|
| </em>
|
| </dt>
|
| - <dd class="todo" style="display: none; ">
|
| + <dd class="todo">
|
| Undocumented.
|
| </dd>
|
| - <dd>Only used as a response to the onBeforeRequest event. If set, the original request is prevented from being sent and is instead redirected to the given URL.</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>requestHeaders</var>
|
| - <em>
|
| -
|
| - <!-- TYPE -->
|
| - <div style="display:inline">
|
| - (
|
| - <span class="optional">optional</span>
|
| - <span class="enum" style="display: none; ">enumerated</span>
|
| - <span id="typeTemplate">
|
| - <span>
|
| - <a href="experimental.webRequest.html#type-HttpHeaders">HttpHeaders</a>
|
| - </span>
|
| - <span style="display: none; ">
|
| - <span>
|
| - array of <span><span></span></span>
|
| - </span>
|
| - <span>paramType</span>
|
| - <span></span>
|
| - </span>
|
| - </span>
|
| - )
|
| - </div>
|
| -
|
| - </em>
|
| - </dt>
|
| - <dd class="todo" style="display: none; ">
|
| - Undocumented.
|
| + Description of this parameter from the json schema.
|
| </dd>
|
| - <dd>Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead.</dd>
|
| <dd style="display: none; ">
|
| This parameter was added in version
|
| <b><span></span></b>.
|
|
|