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

Unified Diff: chrome/common/extensions/docs/webRequest.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/common/extensions/docs/webNavigation.html ('k') | chrome/common/extensions/docs/webstore.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/docs/webRequest.html
diff --git a/chrome/common/extensions/docs/webRequest.html b/chrome/common/extensions/docs/webRequest.html
deleted file mode 100644
index 98d408024614116b2b892ba401deca6d5f5086a1..0000000000000000000000000000000000000000
--- a/chrome/common/extensions/docs/webRequest.html
+++ /dev/null
@@ -1,4661 +0,0 @@
-<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:
- 1) The <head> information in this page is significant, should be uniform
- across api docs and should be edited only with knowledge of the
- templating mechanism.
- 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a
- browser, it will be re-generated from the template, json schema and
- authored overview content.
- 4) The <body>.innerHTML is also generated by an offline step so that this
- page may easily be indexed by search engines.
---><html xmlns="http://www.w3.org/1999/xhtml"><head>
- <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
- <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">
- <link href="css/print.css" rel="stylesheet" type="text/css" media="print">
- <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">
- </script>
- <script type="text/javascript" src="../../../../third_party/json_minify/minify-sans-regexp.js">
- </script>
- <script type="text/javascript" src="js/api_page_generator.js"></script>
- <script type="text/javascript" src="js/bootstrap.js"></script>
- <script type="text/javascript" src="js/sidebar.js"></script>
- <meta name="description" content="Documentation for the chrome.webRequest module, which is part of the Google Chrome extension APIs."><title>Web Requests - Google Chrome Extensions - Google Code</title></head>
- <body> <div id="devModeWarning" class="displayModeWarning">
- You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.
- </div>
- <div id="branchWarning" class="displayModeWarning">
- <span>WARNING: This is the <span id="branchName">BETA</span> documentation.
- It may not work with the stable release of Chrome.</span>
- <select id="branchChooser">
- <option>Choose a different version...
- </option><option value="">Stable
- </option><option value="beta">Beta
- </option><option value="dev">Dev
- </option><option value="trunk">Trunk
- </option></select>
- </div>
- <div id="unofficialWarning" class="displayModeWarning">
- <span>WARNING: This is unofficial documentation. It may not work with the
- current release of Chrome.</span>
- <button id="goToOfficialDocs">Go to the official docs</button>
- </div>
- <div id="gc-container" class="labs">
- <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION -->
- <!-- In particular, sub-templates that recurse, must be used by allowing
- jstemplate to make a copy of the template in this section which
- are not operated on by way of the jsskip="true" -->
- <!-- /SUBTEMPLATES -->
- <a id="top"></a>
- <div id="skipto">
- <a href="#gc-pagecontent">Skip to page content</a>
- <a href="#gc-toc">Skip to main navigation</a>
- </div>
- <!-- API HEADER -->
- <table id="header" width="100%" cellspacing="0" border="0">
- <tbody><tr>
- <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>
- <td valign="middle" width="100%" style="padding-left:0.6em;">
- <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">
- <div id="gsc-search-box">
- <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">
- <input type="hidden" name="ie" value="UTF-8">
- <input type="text" name="q" value="" size="55">
- <input class="gsc-search-button" type="submit" name="sa" value="Search">
- <br>
- <span class="greytext">e.g. "page action" or "tabs"</span>
- </div>
- </form>
- <script type="text/javascript" src="https://www.google.com/jsapi"></script>
- <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>
- <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&amp;t13n_langs=en"></script>
- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&amp;lang=en"></script>
- </td>
- </tr>
- </tbody></table>
- <div id="codesiteContent" class="">
- <a id="gc-topnav-anchor"></a>
- <div id="gc-topnav">
- <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>
- <ul id="home" class="gc-topnav-tabs">
- <li id="home_link">
- <a href="index.html" title="Google Chrome Extensions home page">Home</a>
- </li>
- <li id="docs_link">
- <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>
- </li>
- <li id="faq_link">
- <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>
- </li>
- <li id="samples_link">
- <a href="samples.html" title="Sample extensions (with source code)">Samples</a>
- </li>
- <li id="group_link">
- <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>
- </li>
- <li id="so_link">
- <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>
- </li>
- </ul>
- </div> <!-- end gc-topnav -->
- <div class="g-section g-tpl-170">
- <!-- SIDENAV -->
- <div class="g-unit g-first" id="gc-toc">
- <ul>
- <li><a href="getstarted.html">Getting Started</a></li>
- <li><a href="overview.html">Overview</a></li>
- <li><a href="whats_new.html">What's New?</a></li>
- <li><h2><a href="devguide.html">Developer's Guide</a></h2>
- <ul>
- <li>Browser UI
- <ul>
- <li><a href="browserAction.html">Browser Actions</a></li>
- <li><a href="contextMenus.html">Context Menus</a></li>
- <li><a href="notifications.html">Desktop Notifications</a></li>
- <li><a href="omnibox.html">Omnibox</a></li>
- <li><a href="options.html">Options Pages</a></li>
- <li><a href="override.html">Override Pages</a></li>
- <li><a href="pageAction.html">Page Actions</a></li>
- </ul>
- </li>
- <li>Browser Interaction
- <ul>
- <li><a href="bookmarks.html">Bookmarks</a></li>
- <li><a href="cookies.html">Cookies</a></li>
- <li><a href="devtools.html">Developer Tools</a></li>
- <li><a href="events.html">Events</a></li>
- <li><a href="history.html">History</a></li>
- <li><a href="management.html">Management</a></li>
- <li><a href="tabs.html">Tabs</a></li>
- <li><a href="windows.html">Windows</a></li>
- </ul>
- </li>
- <li>Implementation
- <ul>
- <li><a href="a11y.html">Accessibility</a></li>
- <li><a href="background_pages.html">Background Pages</a></li>
- <li><a href="content_scripts.html">Content Scripts</a></li>
- <li><a href="xhr.html">Cross-Origin XHR</a></li>
- <li><a href="i18n.html">Internationalization</a></li>
- <li><a href="messaging.html">Message Passing</a></li>
- <li><a href="permissions.html">Optional Permissions</a></li>
- <li><a href="npapi.html">NPAPI Plugins</a></li>
- </ul>
- </li>
- <li>Finishing
- <ul>
- <li><a href="hosting.html">Hosting</a></li>
- <li><a href="external_extensions.html">Other Deployment Options</a></li>
- </ul>
- </li>
- </ul>
- </li>
- <li><h2><a href="apps.html">Packaged Apps</a></h2></li>
- <li><h2><a href="tutorials.html">Tutorials</a></h2>
- <ul>
- <li><a href="tut_debugging.html">Debugging</a></li>
- <li><a href="tut_analytics.html">Google Analytics</a></li>
- <li><a href="tut_oauth.html">OAuth</a></li>
- </ul>
- </li>
- <li><h2>Reference</h2>
- <ul>
- <li>Formats
- <ul>
- <li><a href="manifest.html">Manifest Files</a></li>
- <li><a href="match_patterns.html">Match Patterns</a></li>
- </ul>
- </li>
- <li><a href="permission_warnings.html">Permission Warnings</a></li>
- <li><a href="api_index.html">chrome.* APIs</a></li>
- <li><a href="api_other.html">Other APIs</a></li>
- </ul>
- </li>
- <li><h2><a href="samples.html">Samples</a></h2></li>
- <div class="line"> </div>
- <li><h2>More</h2>
- <ul>
- <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>
- <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>
- <li><a href="themes.html">Themes</a></li>
- </ul>
- </li>
- </ul>
- </div>
- <script>
- initToggles();
- </script>
- <div class="g-unit" id="gc-pagecontent">
- <div id="pageTitle">
- <h1 class="page_title">Web Requests</h1>
- </div>
- <!-- TABLE OF CONTENTS -->
- <div id="toc">
- <h2>Contents</h2>
- <ol>
- <li>
- <a href="#manifest">Manifest</a>
- <ol>
- </ol>
- </li><li>
- <a href="#life_cycle">Life cycle of requests</a>
- <ol>
- </ol>
- </li><li>
- <a href="#concepts">Concepts</a>
- <ol>
- <li>
- <a href="#Request IDs">Request IDs</a>
- </li><li>
- <a href="#subscription">Registering event listeners</a>
- </li>
- </ol>
- </li><li>
- <a href="#implementation">Implementation details</a>
- <ol>
- </ol>
- </li><li>
- <a href="#examples">Examples</a>
- <ol>
- </ol>
- </li>
- <li>
- <a href="#apiReference">API reference: chrome.webRequest</a>
- <ol>
- <li>
- <a href="#global-methods">Methods</a>
- <ol>
- <li>
- <a href="#method-handlerBehaviorChanged">handlerBehaviorChanged</a>
- </li>
- </ol>
- </li>
- <li>
- <a href="#global-events">Events</a>
- <ol>
- <li>
- <a href="#event-onAuthRequired">onAuthRequired</a>
- </li><li>
- <a href="#event-onBeforeRedirect">onBeforeRedirect</a>
- </li><li>
- <a href="#event-onBeforeRequest">onBeforeRequest</a>
- </li><li>
- <a href="#event-onBeforeSendHeaders">onBeforeSendHeaders</a>
- </li><li>
- <a href="#event-onCompleted">onCompleted</a>
- </li><li>
- <a href="#event-onErrorOccurred">onErrorOccurred</a>
- </li><li>
- <a href="#event-onHeadersReceived">onHeadersReceived</a>
- </li><li>
- <a href="#event-onResponseStarted">onResponseStarted</a>
- </li><li>
- <a href="#event-onSendHeaders">onSendHeaders</a>
- </li>
- </ol>
- </li>
- <li>
- <a href="#types">Types</a>
- <ol>
- <li>
- <a href="#type-RequestFilter">RequestFilter</a>
- <ol>
- </ol>
- </li><li>
- <a href="#type-HttpHeaders">HttpHeaders</a>
- <ol>
- </ol>
- </li><li>
- <a href="#type-BlockingResponse">BlockingResponse</a>
- <ol>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
- </li>
- </ol>
- </div>
- <!-- /TABLE OF CONTENTS -->
- <!-- Standard content lead-in for experimental API pages -->
- <!-- STATIC CONTENT PLACEHOLDER -->
- <div id="static"><div id="pageData-name" class="pageData">Web Requests</div>
-<!-- BEGIN AUTHORED CONTENT -->
-<p id="classSummary">
-Use the <code>chrome.webRequest</code> module to intercept, block,
-or modify requests in-flight and to observe and analyze traffic.
-</p>
-<h2 id="manifest">Manifest</h2>
-<p>You must declare the "webRequest" permission in the <a href="manifest.html">extension manifest</a> to use the web request
-API, along with <a href="manifest.html#permissions">host permissions</a>
-for any hosts whose network requests you want to access. If you want to
-use the web request API in a blocking fashion, you need to request
-the "webRequestBlocking" permission in addition.
-For example:</p>
-<pre>{
- "name": "My extension",
- ...
- <b>"permissions": [
- "webRequest",
- "*://*.google.com"
- ]</b>,
- ...
-}</pre>
-<p class="note">
-<b>Node:</b> If you request the "webRequestBlocking" permission, web requests
-are delayed until the background page of your extension has been loaded. This
-allows you to register event listeners before any web requests are processed.
-In order to avoid deadlocks, you must not start synchronous XmlHttpRequests or
-include scripts from the internet via <code>&lt;script src="..."&gt;</code> tags
-in your background page.
-</p>
-<h2 id="life_cycle">Life cycle of requests</h2>
-<p>
-The web request API defines a set of events that follow the life cycle of a web
-request. You can use these events to observe and analyze traffic. Certain
-synchronous events will allow you to intercept, block, or modify a request.
-</p>
-<p>
-The event life cycle for successful requests is illustrated here, followed by
-event definitions:<br>
-<img src="images/webrequestapi.png" width="385" height="503" alt="Life cycle of a web request from the perspective of the webrequest API" style="margin-left: auto; margin-right: auto; display: block">
-</p>
-<p>
-</p><dl>
- <dt><code>onBeforeRequest</code> (optionally synchronous)</dt>
- <dd>Fires when a request is about to occur. This event is sent before any TCP
- connection is made and can be used to cancel or redirect requests.</dd>
- <dt><code>onBeforeSendHeaders</code> (optionally synchronous)</dt>
- <dd>Fires when a request is about to occur and the initial headers have been
- prepared. The event is intended to allow extensions to add, modify, and delete
- request headers <a href="#life_cycle_footnote">(*)</a>. The
- <code>onBeforeSendHeaders</code> event is passed to all subscribers, so
- different subscribers may attempt to modify the request; see the <a href="#implementation">Implementation details</a> section for how this is
- handled. This event can be used to cancel the request.</dd>
- <dt><code>onSendHeaders</code></dt>
- <dd>Fires after all extensions have had a chance to modify the request
- headers, and presents the final <a href="#life_cycle_footnote">(*)</a>
- version. The event is triggered before the headers are sent to the network.
- This event is informational and handled asynchronously. It does not allow
- modifying or cancelling the request.</dd>
- <dt><code>onHeadersReceived</code> (optionally synchronous)</dt>
- <dd>Fires each time that an HTTP(S) response header is received. Due
- to redirects and authentication requests this can happen multiple times per
- request. This event is intended to allow extensions to add, modify, and delete
- response headers, such as incoming Set-Cookie headers.</dd>
- <dt><code>onAuthRequired</code> (optionally synchronous)</dt>
- <dd>Fires when a request requires authentication of the user. This event can
- be handled synchronously to provide authentication credentials. Note that
- extensions may provide invalid credentials. Take care not to enter an infinite
- loop by repeatedly providing invalid credentials.</dd>
- <dt><code>onBeforeRedirect</code></dt>
- <dd>Fires when a redirect is about to be executed. A redirection can be
- triggered by an HTTP response code or by an extension. This event is
- informational and handled asynchronously. It does not allow you to modify or
- cancel the request. </dd>
- <dt><code>onResponseStarted</code></dt>
- <dd>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. This event is informational and handled asynchronously. It does not
- allow modifying or cancelling the request.</dd>
- <dt><code>onCompleted</code></dt>
- <dd>Fires when a request has been processed successfully.</dd>
- <dt><code>onErrorOccurred</code></dt>
- <dd>Fires when a request could not be processed successfully.</dd>
-</dl>
-The web request API guarantees that for each request either
-<code>onCompleted</code> or <code>onErrorOccurred</code> is fired as the final
-event with one exception: If a request is redirected to a <code>data://</code>
-URL, <code>onBeforeRedirect</code> is the last reported event.
-<p></p>
-<p id="life_cycle_footnote">(*) Note that the web request API presents an
-abstraction of the network stack to the extension. Internally, one URL request
-can be split into several HTTP requests (for example to fetch individual byte
-ranges from a large file) or can be handled by the network stack without
-communicating with the network. For this reason, the API does not provide the
-final HTTP headers that are sent to the network. For example, all headers that
-are related to caching are invisible to the extension.</p>
-<p>The following headers are currently <b>not provided</b> to the
-<code>onBeforeSendHeaders</code> event. This list is not guaranteed to be
-complete nor stable.
-</p><ul>
- <li>Authorization</li>
- <li>Cache-Control</li>
- <li>Connection</li>
- <li>Content-Length</li>
- <li>Host</li>
- <li>If-Modified-Since</li>
- <li>If-None-Match</li>
- <li>If-Range</li>
- <li>Partial-Data</li>
- <li>Pragma</li>
- <li>Proxy-Authorization</li>
- <li>Proxy-Connection</li>
- <li>Transfer-Encoding</li>
-</ul>
-<p></p>
-<p>
-The webRequest API only exposes requests that the extension has
-permission to see, given its
-<a href="manifest.html#permissions">host permissions</a>.
-Moreover, only the following schemes are accessible:
-<code>http://</code>,
-<code>https://</code>,
-<code>ftp://</code>,
-<code>file://</code>, or
-<code>chrome-extension://</code>.
-In addition, even certain requests with URLs using one of the above schemes
-are hidden, e.g.,
-<code>chrome-extension://other_extension_id</code> where
-<code>other_extension_id</code> is not the ID of the extension to handle
-the request,
-<code>https://www.google.com/chrome</code>,
-and others (this list is not complete).
-</p>
-<h2 id="concepts">Concepts</h2>
-<p>As the following sections explain, events in the web request API use request
-IDs, and you can optionally specify filters and extra information when you
-register event listeners.</p>
-<h3 id="Request IDs">Request IDs</h3>
-<p>Each request is identified by a request ID. This ID is unique within a
-browser session and the context of an extension. It remains constant during the
-the life cycle of a request and can be used to match events for the same
-request. Note that several HTTP requests are mapped to one web request in case
-of HTTP redirection or HTTP authentication.</p>
-<h3 id="subscription">Registering event listeners</h3>
-<p>To register an event listener for a web request, you use a variation on the
-<a href="events.html">usual <code>addListener()</code> function</a>.
-In addition to specifying a callback function,
-you have to specify a filter argument and you may specify an optional extra info
-argument.</p>
-<p>The three arguments to the web request API's <code>addListener()</code> have
-the following definitions:</p>
-<pre>var callback = function(details) {...};
-var filter = {...};
-var opt_extraInfoSpec = [...];
-</pre>
-<p>Here's an example of listening for the <code>onBeforeRequest</code>
-event:</p>
-<pre>chrome.webRequest.onBeforeRequest.addListener(
- callback, filter, opt_extraInfoSpec);
-</pre>
-<p>Each <code>addListener()</code> call takes a mandatory callback function as
-the first parameter. This callback function is passed a dictionary containing
-information about the current URL request. The information in this dictionary
-depends on the specific event type as well as the content of
-<code>opt_extraInfoSpec</code>.</p>
-<p>If the optional <code>opt_extraInfoSpec</code> array contains the string
-<code>'blocking'</code> (only allowed for specific events), the callback
-function is handled synchronously. That means that the request is blocked until
-the callback function returns. In this case, the callback can return a <a href="#type-BlockingResponse">BlockingResponse</a> that determines the further
-life cycle of the request. Depending on the context, this response allows
-cancelling or redirecting a request (<code>onBeforeRequest</code>), cancelling a
-request or modifying headers (<code>onBeforeSendHeaders</code>,
-<code>onHeadersReceived</code>), or providing authentication credentials
-(<code>onAuthRequired</code>).</p>
-<p>The <a href="#type-RequestFilter">RequestFilter</a>
-<code>filter</code> allows limiting the requests for which events are
-triggered in various dimensions:
-</p><dl>
- <dt>URLs</dt>
- <dd><a href="match_patterns.html">URL patterns</a> such as
- <code>*://www.google.com/foo*bar</code>.</dd>
- <dt>Types</dt>
- <dd>Request types such as <code>main_frame</code> (a document that is loaded
- for a top-level frame), <code>sub_frame</code> (a document that is loaded for
- an embedded frame), and <code>image</code> (an image on a web site).
- See <a href="#type-RequestFilter">RequestFilter</a>.</dd>
- <dt>Tab ID</dt>
- <dd>The identifier for one tab.</dd>
- <dt>Window ID</dt>
- <dd>The identifier for a window.</dd>
-<p></p>
-<p>Depending on the event type, you can specify strings in
-<code>opt_extraInfoSpec</code> to ask for additional information about the
-request. This is used to provide detailed information on request's data only
-if explicitly requested.</p>
-<h2 id="implementation">Implementation details</h2>
-<p>Several implementation details can be important to understand when developing
-an extension that uses the web request API:</p>
-<h3>Conflict resolution</h3>
-<p>In the current implementation of the web request API, a request is considered
-as cancelled if at least one extension instructs to cancel the request. If
-an extension cancels a request, all extensions are notified by an
-<code>onErrorOccurred</code> event. Only one extension is allowed to redirect a
-request or modify a header at a time. If more than one extension attempts to
-modify the request, the most recently installed extension wins and all others
-are ignored. An extension is not notified if its instruction to modify or
-redirect has been ignored.</p>
-<h3>Caching</h3>
-<p>
-Chrome employs two caches — an on-disk cache and a very fast in-memory
-cache. The lifetime of an in-memory cache is attached to the lifetime of a
-render process, which roughly corresponds to a tab. Requests that are answered
-from the in-memory cache are invisible to the web request API. If a request
-handler changes its behavior (for example, the behavior according to which
-requests are blocked), a simple page refresh might not respect this changed
-behavior. To make sure the behavior change goes through, call
-<code>handlerBehaviorChanged()</code> to flush the in-memory cache. But don't do
-it often; flushing the cache is a very expensive operation. You don't need to
-call <code>handlerBehaviorChanged()</code> after registering or unregistering an
-event listener.</p>
-<h3>Timestamps</h3>
-<p>
-The <code>timestamp</code> property of web request events 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>
-<h2 id="examples">Examples</h2>
-<p>The following example illustrates how to block all requests to
-<code>www.evil.com</code>:</p>
-<pre>chrome.webRequest.onBeforeRequest.addListener(
- function(details) {
- return {cancel: details.url.indexOf("://www.evil.com/") != -1};
- },
- {urls: ["&lt;all_urls&gt;"]},
- ["blocking"]);
-</pre>
-<p>As this function uses a blocking event handler, it requires the "webRequest"
-as well as the "webRequestBlocking" permission in the manifest file.</p>
-<p>The following example achieves the same goal in a more efficient way because
-requests that are not targeted to <code>www.evil.com</code> do not need to be
-passed to the extension:</p>
-<pre>chrome.webRequest.onBeforeRequest.addListener(
- function(details) { return {cancel: true}; },
- {urls: ["*://www.evil.com/*"]},
- ["blocking"]);
-</pre>
-<p>The following example illustrates how to delete the User-Agent header from
-all requests:</p>
-<pre>chrome.webRequest.onBeforeSendHeaders.addListener(
- function(details) {
- for (var i = 0; i &lt; details.requestHeaders.length; ++i) {
- if (details.requestHeaders[i].name === 'User-Agent') {
- details.requestHeaders.splice(i, 1);
- break;
- }
- }
- return {requestHeaders: details.requestHeaders};
- },
- {urls: ["&lt;all_urls&gt;"]},
- ["blocking", "requestHeaders"]);
-</pre>
-<p> For more example code, see the <a href="samples.html#webrequest">web request
-samples</a>.</p>
-<!-- END AUTHORED CONTENT -->
-</dl></div>
- <!-- API PAGE -->
- <div class="apiPage">
- <a name="apiReference"></a>
- <h2>API reference: chrome.webRequest</h2>
- <!-- PROPERTIES -->
- <!-- /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-handlerBehaviorChanged"></a> <!-- method-anchor -->
- <h4>handlerBehaviorChanged</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span>chrome.webRequest.handlerBehaviorChanged</span>(<span class="optional"><span>function</span>
- <var><span>callback</span></var></span>)</div>
- <div class="description">
- <p>Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.</p>
- <!-- PARAMETERS -->
- <h4>Parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- <!-- RETURNS -->
- <dl>
- </dl>
- <!-- CALLBACK -->
- <div>
- <div>
- <h4>Callback function</h4>
- <p>
- If you specify the <em>callback</em> parameter, it should
- specify a function that looks like this:
- </p>
- <!-- Note: intentionally longer 80 columns -->
- <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>
- <dl>
- </dl>
- </div>
- </div>
- <!-- MIN_VERSION -->
- </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-onAuthRequired"></a>
- <h4>onAuthRequired</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.webRequest.</span><span>onAuthRequired</span><span class="subdued">.addListener</span>(function(<span>object details, function callback</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>);
- </div>
- <div class="description">
- <p>Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>scheme</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The authentication scheme, e.g. Basic or Digest.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>realm</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The authentication realm provided by the server, if there is one.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>challenger</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The server requesting authentication.</dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>host</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>port</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>isProxy</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>True for Proxy-Authenticate, false for WWW-Authenticate.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP response headers that were received along with this response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusLine</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>HTTP status line of the response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>callback</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>function</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["responseHeaders", "blocking", "asyncBlocking"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <h4>Listener returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-BlockingResponse">BlockingResponse</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onBeforeRedirect"></a>
- <h4>onBeforeRedirect</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.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>Fired when a server-initiated redirect is about to occur.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>ip</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>fromCache</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Indicates if this response was fetched from disk cache.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusCode</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP status code returned by the server.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>redirectUrl</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The new URL.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP response headers that were received along with this redirect.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusLine</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>HTTP status line of the response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["responseHeaders"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /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.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>Fired when a request is about to occur.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["blocking"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <h4>Listener returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-BlockingResponse">BlockingResponse</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onBeforeSendHeaders"></a>
- <h4>onBeforeSendHeaders</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.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>);
- </div>
- <div class="description">
- <p>Fired 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>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>requestHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP request headers that are going to be sent out with this request.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["requestHeaders", "blocking"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <h4>Listener returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-BlockingResponse">BlockingResponse</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div> <!-- /description -->
- <!-- /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.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>Fired when a request is completed.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>ip</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>fromCache</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Indicates if this response was fetched from disk cache.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusCode</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP status code returned by the server.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP response headers that were received along with this response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusLine</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>HTTP status line of the response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["responseHeaders"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /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.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>Fired when an error occurs.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>ip</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>fromCache</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Indicates if this response was fetched from disk cache.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>error</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onHeadersReceived"></a>
- <h4>onHeadersReceived</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.webRequest.</span><span>onHeadersReceived</span><span class="subdued">.addListener</span>(function(<span>object deails</span>) <span class="subdued">{...}</span><span>, RequestFilter filter, array of string extraInfoSpec</span>);
- </div>
- <div class="description">
- <p>Fired when HTTP response headers of a request have been received.</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>deails</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusLine</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>HTTP status line of the response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP response headers that have been received with this response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["blocking", "responseHeaders"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <h4>Listener returns</h4>
- <dl>
- <div>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-BlockingResponse">BlockingResponse</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>If "blocking" is specified in the "extraInfoSpec" parameter, the event listener should return an object of this type.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div> <!-- /description -->
- <!-- /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.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>Fired 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>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>ip</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The server IP address that the request was actually sent to. Note that it may be a literal IPv6 address.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>fromCache</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Indicates if this response was fetched from disk cache.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusCode</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP status code returned by the server.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP response headers that were received along with this response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>statusLine</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>HTTP status line of the response.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["responseHeaders"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /description -->
- </div><div class="apiItem">
- <a name="event-onSendHeaders"></a>
- <h4>onSendHeaders</h4>
- <div class="summary">
- <!-- Note: intentionally longer 80 columns -->
- <span class="subdued">chrome.webRequest.</span><span>onSendHeaders</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>Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).</p>
- <!-- LISTENER PARAMETERS -->
- <div>
- <h4>Listener parameters</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>details</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>requestId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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 PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>url</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>method</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Standard HTTP method.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>frameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The value 0 indicates that the request happens in the main frame; a positive value indicates the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded (<code>type</code> is <code>main_frame</code> or <code>sub_frame</code>), <code>frameId</code> indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>parentFrameId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>ID of frame that wraps the frame which sent the request. Set to -1 if no parent frame exists.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>type</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="enum">enumerated</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>How the requested resource will be used.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>timeStamp</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>number</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The time when this signal is triggered, in milliseconds since the epoch.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>requestHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>The HTTP request headers that have been sent out with this request.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- EXTRA PARAMETERS -->
- <div>
- <h4>Extra parameters to addListener</h4>
- <dl>
- <div>
- <div>
- <dt>
- <var>filter</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-RequestFilter">RequestFilter</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A set of filters that restricts the events that will be sent to this listener.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>extraInfoSpec</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["requestHeaders"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Array of extra information that should be passed to the listener function.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </div>
- <!-- LISTENER RETURN VALUE -->
- <dl>
- </dl>
- </div> <!-- /description -->
- <!-- /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>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>An object describing filters to apply to webRequest events.</dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>urls</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>types</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>string</span>
- <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "xmlhttprequest", "other"]</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>A list of request types. Requests that cannot match any of the types will be filtered out.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>tabId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>windowId</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>integer</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div class="apiItem">
- <a name="type-HttpHeaders"></a>
- <h4>HttpHeaders</h4>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>object</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>An array of HTTP headers. Each header is represented as a dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>.</dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>name</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Name of the HTTP header.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>value</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Value of the HTTP header if it can be represented by UTF-8.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>binaryValue</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>
- array of <span><span>
- <span>
- <span>integer</span>
- </span>
- </span></span>
- </span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Value of the HTTP header if it cannot be represented by UTF-8, stored as individual byte values (0..255).</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div class="apiItem">
- <a name="type-BlockingResponse"></a>
- <h4>BlockingResponse</h4>
- <div>
- <dt>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Returns value for event handlers that have the 'blocking' extraInfoSpec applied. Allows the event handler to modify network requests.</dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>cancel</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>boolean</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>If true, the request is cancelled. Used in onBeforeRequest, this prevents the request from being sent.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>redirectUrl</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <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>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>requestHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Only used as a response to the onBeforeSendHeaders event. If set, the request is made with these request headers instead.</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>responseHeaders</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <a href="webRequest.html#type-HttpHeaders">HttpHeaders</a>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Only used as a response to the onHeadersReceived event. If set, the server is assumed to have responded with these response headers instead. Only return <code>responseHeaders</code> if you really want to modify the headers in order to limit the number of conflicts (only one extension may modify <code>responseHeaders</code> for each request).</dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>authCredentials</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span class="optional">optional</span>
- <span id="typeTemplate">
- <span>
- <span>object</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd>Only used as a response to the onAuthRequired event. If set, the request is made using the supplied credentials.</dd>
- <!-- OBJECT PROPERTIES -->
- <dd>
- <dl>
- <div>
- <div>
- <dt>
- <var>username</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div><div>
- <div>
- <dt>
- <var>password</var>
- <em>
- <!-- TYPE -->
- <div style="display:inline">
- (
- <span id="typeTemplate">
- <span>
- <span>string</span>
- </span>
- </span>
- )
- </div>
- </em>
- </dt>
- <dd class="todo">
- Undocumented.
- </dd>
- <!-- OBJECT PROPERTIES -->
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div>
- </dl>
- </dd>
- <!-- OBJECT METHODS -->
- <!-- OBJECT EVENT FIELDS -->
- <!-- FUNCTION PARAMETERS -->
- </div>
- </div> <!-- /apiItem -->
- </div> <!-- /apiGroup -->
- </div> <!-- /apiPage -->
- </div> <!-- /gc-pagecontent -->
- </div> <!-- /g-section -->
- </div> <!-- /codesiteContent -->
- <div id="gc-footer" --="">
- <div class="text">
- <p>
- Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>,
- the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons
- Attribution 3.0 License</a>, and code samples are licensed under the
- <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.
- </p>
- <p>
- ©2011 Google
- </p>
-<!-- begin analytics -->
-<script src="https://www.google-analytics.com/urchin.js" type="text/javascript"></script>
-<script src="https://www.google-analytics.com/ga.js" type="text/javascript"></script>
-<script type="text/javascript">
- // chrome doc tracking
- try {
- var engdocs = _gat._getTracker("YT-10763712-2");
- engdocs._trackPageview();
- } catch(err) {}
- // code.google.com site-wide tracking
- try {
- _uacct="UA-18071-1";
- _uanchor=1;
- _uff=0;
- urchinTracker();
- }
- catch(e) {/* urchinTracker not available. */}
-</script>
-<!-- end analytics -->
- </div>
- </div> <!-- /gc-footer -->
- </div> <!-- /gc-container -->
-</body></html>
« no previous file with comments | « chrome/common/extensions/docs/webNavigation.html ('k') | chrome/common/extensions/docs/webstore.html » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698