chrome/common/extensions/docs/declarativeWebRequest.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/declarativeWebRequest.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

Index: chrome/common/extensions/docs/declarativeWebRequest.html

diff --git a/chrome/common/extensions/docs/declarativeWebRequest.html b/chrome/common/extensions/docs/declarativeWebRequest.html

deleted file mode 100644

index c04bdede38907ab5c7c114a83760f34eb7b657a6..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/declarativeWebRequest.html

+++ /dev/null

@@ -1,1273 +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.declarativeWebRequest module, which is part of the Google Chrome extension APIs."><title>chrome.declarativeWebRequest - 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">

-

- <!-- 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" -->

-

- <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>

-

- <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&t13n_langs=en"></script>

- <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&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>

- <div class="g-section g-tpl-170">

-

- <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">chrome.declarativeWebRequest</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#notes">Notes</a>

- <ol>

- </ol>

- </li><li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#rules">Rules</a>

- <ol>

- </ol>

- </li><li>

- <a href="#TODO">Todo</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.declarativeWebRequest</a>

- <ol>

- <li>

- <a href="#global-events">Events</a>

- <ol>

- <li>

- <a href="#event-onRequest">onRequest</a>

- </li>

- </ol>

- </li>

- <li>

- <a href="#types">Types</a>

- <ol>

- <li>

- <a href="#type-declarativeWebRequest.RedirectByRegEx">declarativeWebRequest.RedirectByRegEx</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-RequestMatcher">RequestMatcher</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-RedirectRequest">RedirectRequest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.RedirectToTransparentImage">declarativeWebRequest.RedirectToTransparentImage</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.RedirectToEmptyDocument">declarativeWebRequest.RedirectToEmptyDocument</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-CancelRequest">CancelRequest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.SetRequestHeader">declarativeWebRequest.SetRequestHeader</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.RemoveRequestHeader">declarativeWebRequest.RemoveRequestHeader</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.AddResponseHeader">declarativeWebRequest.AddResponseHeader</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.RemoveResponseHeader">declarativeWebRequest.RemoveResponseHeader</a>

- <ol>

- </ol>

- </li><li>

- <a href="#type-declarativeWebRequest.IgnoreRules">declarativeWebRequest.IgnoreRules</a>

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

- <p class="warning">

- <!-- Standard content lead-in for APIs that are not yet available on

- the stable channel. -->

- <em>Warning:</em> This API is still under development. It is only

- available for Chrome users on the

- <span>

- <strong>dev</strong>

- <a href="http://www.chromium.org/getting-involved/dev-channel">early

- release channel</a>.</span>

- <a href="TODO">Learn more</a>.

- </p>

-

- <div id="static">

-<h2 id="notes">Notes</h2>

-<p>

-Use the <code>chrome.declarativeWebRequest</code> module to intercept, block, or

-modify requests in-flight. It is significantly faster than the <a href="webRequest.html"><code>chrome.webRequest</code> API</a> because you can

-register rules that are evaluated in the browser rather than the

-JavaScript engine which reduces roundtrip latencies and allows for very high

-efficiency.

-</p>

-<h2 id="manifest">Manifest</h2>

-<p>

-You must declare the "declarative" and the "declarativeWebRequest" permission in

-the <a href="manifest.html">extension manifest</a> to use this API,

-along with <a href="manifest.html#permissions">host permissions</a> for any

-hosts whose network requests you want to access.

-</p>

-<pre>{

- "name": "My extension",

- ...

-<b> "permissions": [

- "declarative",

- "declarativeWebRequest",

- "*://*.google.com"

- ]</b>,

- ...

-}</pre>

-<h2 id="rules">Rules</h2>

-<p>

-The Declarative Web Request API follows the concepts of the <a href="events.html#declarative">Declarative API</a>. You can register rules to

-the <code>chrome.declarativeWebRequest.onRequest</code> event object.

-</p>

-<p>

-The Declarative Web Request API supports a single type of match criteria, the

-<code>RequestMatcher</code>. The <code>RequestMatcher</code> matches network

-requests if and only if all listed criteria are met. The following

-<code>RequestMatcher</code> would match a network request when the user enters

-"http://www.example.com" in the URL bar:

-</p>

-<pre>var matcher = new chrome.declarativeWebRequest.RequestMatcher({

- url: { hostSuffix: 'example.com', schemes: ['http'] },

- resourceType: 'main_frame'

- });

-</pre>

-<p>

-Requests to "https://www.example.com" would be rejected by the

-<code>RequestMatcher</code> due to the scheme. Also all requests for an embedded

-iframe would be rejected due to the <code>resourceType</code>.

-</p>

-<p class="note">

-<strong>Note:</strong> All conditions and actions are created via a constructor

-as shown in the example above.

-</p><p>

-In order to cancel all requests to "example.com", you can define a rule as

-follows:

-</p>

-<pre>var rule = {

- conditions: [

- new chrome.declarativeWebRequest.RequestMatcher({

- url: { hostSuffix: 'example.com' } })

- ],

- actions: [

- new chrome.declarativeWebRequest.CancelRequest()

- ]};

-</pre>

-<p>

-In order to cancel all requests to "example.com" and "foobar.com", you can add a

-second condition, as each condition is sufficient to trigger all specified

-actions:

-</p>

-<pre>var rule2 = {

- conditions: [

- new chrome.declarativeWebRequest.RequestMatcher({

- url: { hostSuffix: 'example.com' } }),

- new chrome.declarativeWebRequest.RequestMatcher({

- url: { hostSuffix: 'foobar.com' } })

- ],

- actions: [

- new chrome.declarativeWebRequest.CancelRequest()

- ]};

-</pre>

-<p>

-Register rules as follows:

-</p>

-<pre>chrome.declarativeWebRequest.onRequest.addRules([rule2]);

-</pre>

-<p class="note">

-<strong>Note:</strong> You should always register or unregister rules in bulk rather than

-individually because each of these operations recreates internal data

-structures. This re-creation is computationally expensive but facilitates a

-very fast URL matching algorithm for hundreds of thousands of URLs.

-</p>

-<h2 id="TODO">Todo</h2>

-<ul>

- <li>Explain precedences, once we can ignore rules based on their priority

- (e.g. how can I cancel all requests except for a specific whitelist?)

- </li><li>Explain when conditions can be evaluated, when actions can be executed,

- and when rules can be executed (e.g. you cannot cancel a request when you

- have received the response already)

-</li></ul>

-

-</div>

-

- <div class="apiPage">

- <a name="apiReference"></a>

- <h2>API reference: chrome.declarativeWebRequest</h2>

-

-

-

-

-

- <div id="eventsTemplate" class="apiGroup">

- <a name="global-events"></a>

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onRequest"></a>

- <h4>onRequest</h4>

-

- <div class="summary">

- <span class="subdued">chrome.declarativeWebRequest.</span><span>onRequest</span><span class="subdued">.addRules</span>(...);

- </div>

- <div class="description">

- <p>See <a href="events.html#method-Event-addRules"><code>chrome.events.Event.addRules()</code></a>.

- </p>

-

- <div>

- <h4>Supported conditions</h4>

- <dl>

- <div>

- <dt>

- <a>declarativeWebRequest.RequestMatcher</a>

- </dt>

- </div>

- </dl>

- </div>

-

- <div>

- <h4>Supported actions</h4>

- <dl>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.AddResponseHeader">declarativeWebRequest.AddResponseHeader</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a>declarativeWebRequest.CancelRequest</a>

- </dt>

- </div>

- </div><div>

- <div>

- <dt>

- <a>declarativeWebRequest.RedirectRequest</a>

- </dt>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.RedirectToTransparentImage">declarativeWebRequest.RedirectToTransparentImage</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.RedirectToEmptyDocument">declarativeWebRequest.RedirectToEmptyDocument</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.RedirectByRegEx">declarativeWebRequest.RedirectByRegEx</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.SetRequestHeader">declarativeWebRequest.SetRequestHeader</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.RemoveRequestHeader">declarativeWebRequest.RemoveRequestHeader</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.RemoveResponseHeader">declarativeWebRequest.RemoveResponseHeader</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </div><div>

- <div>

- <dt>

- <a href="declarativeWebRequest.html#type-declarativeWebRequest.IgnoreRules">declarativeWebRequest.IgnoreRules</a>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

- </div>

- </dl>

- </div>

- </div>

- </div>

- </div>

-

- <div class="apiGroup">

- <a name="types"></a>

- <h3 id="types">Types</h3>

-

- <div class="apiItem">

- <a name="type-declarativeWebRequest.RedirectByRegEx"></a>

- <h4>declarativeWebRequest.RedirectByRegEx</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Redirects a request by applying a regular expression on the URL. The regular expressions use the <a href="http://code.google.com/p/re2/wiki/Syntax">RE2 syntax</a>.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>from</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>A match pattern that may contain capture groups. Capture groups are referenced in the Perl syntax ($1, $2, ...) instead of the RE2 syntax (\1, \2, ...) in order to be closer to JavaScript Regular Expressions.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>to</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Destination pattern.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-RequestMatcher"></a>

- <h4>RequestMatcher</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Matches network events by various criteria.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>url</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <a>events.UrlFilter</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Matches if the condition of the UrlFilter are fulfilled for the URL of the request.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>resourceType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <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>

- )

- </div>

- </em>

- </dt>

- <dd>Matches if the request type of a request is contained in the list. Requests that cannot match any of the types will be filtered out.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>instanceType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["declarativeWebRequest.RequestMatcher"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-RedirectRequest"></a>

- <h4>RedirectRequest</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Declarative event action that redirects a network request.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>instanceType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["declarativeWebRequest.RedirectRequest"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>redirectUrl</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Destination to where the request is redirected.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.RedirectToTransparentImage"></a>

- <h4>declarativeWebRequest.RedirectToTransparentImage</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Declarative event action that redirects a network request to a transparent image.</dd>

-

- <dd>

- <dl>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.RedirectToEmptyDocument"></a>

- <h4>declarativeWebRequest.RedirectToEmptyDocument</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Declarative event action that redirects a network request to an empty document.</dd>

-

- <dd>

- <dl>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-CancelRequest"></a>

- <h4>CancelRequest</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Declarative event action that cancels a network request.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>instanceType</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="enum">enumerated</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- <span>["declarativeWebRequest.CancelRequest"]</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd class="todo">

- Undocumented.

- </dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.SetRequestHeader"></a>

- <h4>declarativeWebRequest.SetRequestHeader</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Sets the request header of the specified name to the specified value. If a header with the specified name did not exist before, a new one is created. Header name comparison is always case-insensitive. Each request header name occurs only once in each request.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>name</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP request header name.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>value</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP request header value.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.RemoveRequestHeader"></a>

- <h4>declarativeWebRequest.RemoveRequestHeader</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Removes the request header of the specified name. Do not use SetRequestHeader and RemoveRequestHeader with the same header name on the same request. Each request header name occurs only once in each request.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>name</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP request header name (case-insensitive).</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.AddResponseHeader"></a>

- <h4>declarativeWebRequest.AddResponseHeader</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Adds the response header to the response of this web request. As multiple response headers may share the same name, you need to first remove and then add a new response header in order to replace one.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>name</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP response header name.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>value</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP response header value.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.RemoveResponseHeader"></a>

- <h4>declarativeWebRequest.RemoveResponseHeader</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Removes all response headers of the specified names and values.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>name</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP request header name (case-insensitive).</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>value</var>

- <em>

-

- <div style="display:inline">

- (

- <span class="optional">optional</span>

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>HTTP request header value (case-insensitive).</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div class="apiItem">

- <a name="type-declarativeWebRequest.IgnoreRules"></a>

- <h4>declarativeWebRequest.IgnoreRules</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Masks all rules that match the specified criteria.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>lowerPriorityThan</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>If set, rules with a lower priority than the specified value are ignored. This boundary is not persited, it affects only rules and their actions of the same network request stage. TODO(battre): Explain network request stages.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- </div>

- <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>

- </p>

-

-<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>

-

- </div>

- </div>

- </div>

-</body></html>

« no previous file with comments | « chrome/common/extensions/docs/debugger.html ('k') | chrome/common/extensions/docs/devguide.html » ('j') | no next file with comments »