diff options
Diffstat (limited to 'chrome/common/extensions/docs/experimental.webRequest.html')
| -rw-r--r-- | chrome/common/extensions/docs/experimental.webRequest.html | 809 |
1 files changed, 757 insertions, 52 deletions
diff --git a/chrome/common/extensions/docs/experimental.webRequest.html b/chrome/common/extensions/docs/experimental.webRequest.html index 71769af..0e11c39 100644 --- a/chrome/common/extensions/docs/experimental.webRequest.html +++ b/chrome/common/extensions/docs/experimental.webRequest.html @@ -81,6 +81,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd> <div></div> @@ -266,16 +276,16 @@ </li> </ol> </li> - <li style="display: none; "> - <a href="#methods">Methods</a> + <li> + <a href="#global-methods">Methods</a> <ol> - <li> + <li style="display: none; "> <a href="#method-anchor">methodName</a> </li> </ol> </li> <li> - <a href="#events">Events</a> + <a href="#global-events">Events</a> <ol> <li> <a href="#event-onBeforeRedirect">onBeforeRedirect</a> @@ -292,11 +302,11 @@ </li> </ol> </li> - <li style="display: none; "> + <li> <a href="#types">Types</a> <ol> <li> - <a href="#id-anchor">id</a> + <a href="#type-RequestFilter">RequestFilter</a> </li> </ol> </li> @@ -338,12 +348,12 @@ </div> <!-- /apiGroup --> <!-- METHODS --> - <div class="apiGroup" id="methods" style="display: none; "> - <a name="methods"></a> + <div id="methodsTemplate" class="apiGroup"> + <a name="global-methods"></a> <h3>Methods</h3> <!-- iterates over all functions --> - <div class="apiItem"> + <div class="apiItem" style="display: none; "> <a></a> <!-- method-anchor --> <h4>method name</h4> @@ -414,10 +424,9 @@ </div> <!-- /apiGroup --> <!-- EVENTS --> - <div class="apiGroup"> - <a name="events"></a> - <h3 id="events">Events</h3> - + <div id="eventsTemplate" class="apiGroup"> + <a name="global-events"></a> + <h3>Events</h3> <!-- iterates over all events --> <div class="apiItem"> <a name="event-onBeforeRedirect"></a> @@ -433,10 +442,11 @@ <p>Fires when a server initiated redirect is about to occur.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -534,6 +544,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -592,6 +612,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -650,6 +680,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -708,6 +748,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -766,6 +816,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -776,15 +836,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div><div class="apiItem"> @@ -801,10 +871,11 @@ <p>Fires when a request is about to occur.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -902,6 +973,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -962,6 +1043,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1020,6 +1111,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1078,6 +1179,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1136,6 +1247,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1194,6 +1315,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1204,15 +1335,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div><div class="apiItem"> @@ -1229,10 +1370,11 @@ <p>Fires when a request is completed.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -1330,6 +1472,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1388,6 +1540,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1446,6 +1608,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1504,6 +1676,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1514,15 +1696,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div><div class="apiItem"> @@ -1539,10 +1731,11 @@ <p>Fires when an error occurs.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -1640,6 +1833,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1698,6 +1901,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1756,6 +1969,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1814,6 +2037,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -1824,15 +2057,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div><div class="apiItem"> @@ -1849,10 +2092,11 @@ <p>Fires when the status line and response headers are received after a request is sent to the server.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -1950,6 +2194,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2010,6 +2264,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2068,6 +2332,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2126,6 +2400,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2136,15 +2420,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div><div class="apiItem"> @@ -2161,10 +2455,11 @@ <p>Fires when a request is sent to the server.</p> <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> + <div> + <h4>Parameters</h4> + <dl> <div> + <div> <dt> <var>details</var> <em> @@ -2262,6 +2557,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2322,6 +2627,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2380,6 +2695,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2438,6 +2763,16 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> @@ -2448,15 +2783,25 @@ </dl> </dd> + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + <!-- FUNCTION PARAMETERS --> <dd style="display: none; "> <div></div> </dd> </div> - </div> - </dl> - + </div> + </dl> + </div> </div> <!-- /decription --> </div> <!-- /apiItem --> @@ -2464,17 +2809,377 @@ </div> <!-- /apiGroup --> <!-- TYPES --> - <div class="apiGroup" style="display: none; "> + <div class="apiGroup"> <a name="types"></a> <h3 id="types">Types</h3> <!-- iterates over all types --> <div class="apiItem"> - <a></a> - <h4>type name</h4> + <a name="type-RequestFilter"></a> + <h4>RequestFilter</h4> + + <div> + <dt> + <var style="display: none; ">paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>object</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>An object describing filters to apply to webRequest events.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd> + <dl> + <div> + <div> + <dt> + <var>urls</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span> + array of <span><span> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span></span> + </span> + <span style="display: none; ">paramType</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A list of URLs or URL patterns. Requests that cannot match any of the URLs will be filtered out.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>types</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span> + array of <span><span> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span>["main_frame", "sub_frame", "stylesheet", "script", "image", "object", "other"]</span> + </span> + </span></span> + </span> + <span style="display: none; ">paramType</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A list of request types. Requests that cannot match any of the types will be filtered out.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>tabId</var> + <em> + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> <div> + <div> + </div> </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div><div> + <div> + <dt> + <var>windowId</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>integer</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd style="display: none; "> + Description of this parameter from the json schema. + </dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> </div> <!-- /apiItem --> |