diff options
| author | caseq@google.com <caseq@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-09-09 12:57:55 +0000 |
|---|---|---|
| committer | caseq@google.com <caseq@google.com@0039d316-1c4b-4281-b951-d872f2087c98> | 2011-09-09 12:57:55 +0000 |
| commit | 84a997e1d76ef36efa761b8a193d0def4c8dcfe9 (patch) | |
| tree | 7082f268ba36a9e783ebdca2d1a237ac109ec14c /chrome/common | |
| parent | b28bf00834d2b8ee30d1fb3c7f0ddf38388dc3f5 (diff) | |
| download | chromium_src-84a997e1d76ef36efa761b8a193d0def4c8dcfe9.zip chromium_src-84a997e1d76ef36efa761b8a193d0def4c8dcfe9.tar.gz chromium_src-84a997e1d76ef36efa761b8a193d0def4c8dcfe9.tar.bz2 | |
Rename chrome.experimental.devtools.resources to ...devtools.network
BUG=none
TEST=none
Review URL: http://codereview.chromium.org/7828082
git-svn-id: svn://svn.chromium.org/chrome/trunk/src@100395 0039d316-1c4b-4281-b951-d872f2087c98
Diffstat (limited to 'chrome/common')
14 files changed, 1373 insertions, 828 deletions
diff --git a/chrome/common/extensions/api/devtools_api.json b/chrome/common/extensions/api/devtools_api.json index fc9a09c..39d952f 100644 --- a/chrome/common/extensions/api/devtools_api.json +++ b/chrome/common/extensions/api/devtools_api.json @@ -236,17 +236,17 @@ ] }, { - "namespace": "experimental.devtools.resources", + "namespace": "experimental.devtools.network", "types": [ { - "id": "Resource", + "id": "Request", "type": "object", - "description": "Represents a resource (document, script, image etc). See HAR Specification for reference.", + "description": "Represents a network request for a document resource (script, image etc). See HAR Specification for reference.", "functions": [ { "name": "getContent", "type": "function", - "description": "Returns resource content.", + "description": "Returns content of the response body.", "parameters": [ { "name": "callback", @@ -256,7 +256,7 @@ { "name": "content", "type": "string", - "description": "Resource content (potentially encoded)." + "description": "Content of the response body (potentially encoded)." }, { "name": "encoding", @@ -274,7 +274,7 @@ { "name": "getHAR", "type": "function", - "description": "Returns HAR archive that contains all known resource objects.", + "description": "Returns HAR archive that contains all known network requests.", "parameters": [ { "name": "callback", @@ -284,7 +284,7 @@ { "name": "har", "type": "object", - "description": "A HAR archieve. See HAR specification for details." + "description": "A HAR archive. See HAR specification for details." } ] } @@ -293,11 +293,11 @@ ], "events": [ { - "name": "onFinished", + "name": "onRequestFinished", "type": "function", - "description": "Fired when a resource request is finished and all resource data are available.", + "description": "Fired when a network request is finished and all request data are available.", "parameters": [ - { "name": "resource", "$ref": "Resource", "description": "Description of a newly finished resource in the form of a HAR entry. See HAR specification for details." } + { "name": "request", "$ref": "Request", "description": "Description of a network request in the form of a HAR entry. See HAR specification for details." } ] }, { diff --git a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp.zip b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp.zip Binary files differindex 67fcd46..e53c72b 100644 --- a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp.zip +++ b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp.zip diff --git a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/background.html b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/background.html index 4e382a6..4e382a6 100644 --- a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/background.html +++ b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/background.html diff --git a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.html b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.html index c05c2ed..c05c2ed 100644 --- a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.html +++ b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.html diff --git a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.js index 8fb2a92..40ab5c6 100644 --- a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js +++ b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.js @@ -163,19 +163,19 @@ ChromeFirePHP._checkProtoVersion = function(proto_header) { return true;
};
-chrome.experimental.devtools.resources.addRequestHeaders({
+chrome.experimental.devtools.network.addRequestHeaders({
"X-FirePHP-Version": "0.0.6"
});
-chrome.experimental.devtools.resources.getHAR(function(result) {
+chrome.experimental.devtools.network.getHAR(function(result) {
var entries = result.entries;
if (!entries.length) {
Console.warn("ChromeFirePHP suggests that you reload the page to track" +
- " FirePHP messages for all the resources");
+ " FirePHP messages for all the requests");
}
for (var i = 0; i < entries.length; ++i)
ChromeFirePHP.handleFirePhp_headers(entries[i]);
- chrome.experimental.devtools.resources.onFinished.addListener(
+ chrome.experimental.devtools.network.onRequestFinished.addListener(
ChromeFirePHP.handleFirePhpHeaders.bind(ChromeFirePHP));
});
diff --git a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/manifest.json b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/manifest.json index f81a074..f81a074 100644 --- a/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/manifest.json +++ b/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/manifest.json diff --git a/chrome/common/extensions/docs/experimental.devtools.html b/chrome/common/extensions/docs/experimental.devtools.html index 0444e94..61fd12e 100644 --- a/chrome/common/extensions/docs/experimental.devtools.html +++ b/chrome/common/extensions/docs/experimental.devtools.html @@ -324,8 +324,8 @@ Chrome Developer Tools: <li> <a href="experimental.devtools.audits.html">experimental.devtools.audits</a></li><li> <a href="experimental.devtools.inspectedWindow.html">experimental.devtools.inspectedWindow</a></li><li> - <a href="experimental.devtools.panels.html">experimental.devtools.panels</a></li><li> - <a href="experimental.devtools.resources.html">experimental.devtools.resources</a></li> + <a href="experimental.devtools.network.html">experimental.devtools.network</a></li><li> + <a href="experimental.devtools.panels.html">experimental.devtools.panels</a></li> </ul> <p class="warning"> diff --git a/chrome/common/extensions/docs/experimental.devtools.network.html b/chrome/common/extensions/docs/experimental.devtools.network.html new file mode 100644 index 0000000..e26b173 --- /dev/null +++ b/chrome/common/extensions/docs/experimental.devtools.network.html @@ -0,0 +1,1226 @@ +<!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="js/api_page_generator.js"></script> + <script type="text/javascript" src="js/bootstrap.js"></script> + <script type="text/javascript" src="js/sidebar.js"></script> + <title>chrome.experimental.devtools.network +API - Google Chrome Extensions - Google Code</title></head> + <body> <div id="gc-container" class="labs"> + <div id="devModeWarning"> + You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. + </div> + <!-- 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" --> + <div style="display:none"> + + <!-- VALUE --> + <div id="valueTemplate"> + <dt> + <var>paramName</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional">optional</span> + <span class="enum">enumerated</span> + <span id="typeTemplate"> + <span> + <a> Type</a> + </span> + <span> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + <span></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo"> + Undocumented. + </dd> + <dd> + Description of this parameter from the json schema. + </dd> + <dd> + 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> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd> + <div></div> + </dd> + + </div> <!-- /VALUE --> + + <div id="functionParametersTemplate"> + <h5>Parameters</h5> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + </div> <!-- /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="http://www.google.com/jsapi"></script> + <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> + <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> + <script type="text/javascript" src="http://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> + </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="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="idle.html">Idle</a></li> + <li><a href="i18n.html">Internationalization</a></li> + <li><a href="messaging.html">Message Passing</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.experimental.devtools.network +API</h1> + </div> + <!-- TABLE OF CONTENTS --> + <div id="toc"> + <h2>Contents</h2> + <ol> + <li> + <a href="#H2-0">Notes</a> + <ol> + <li style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li><li> + <a href="#overview-examples">Examples</a> + <ol> + <li style="display: none; "> + <a>h3Name</a> + </li> + </ol> + </li> + <li> + <a href="#apiReference">API reference: chrome.experimental.devtools.network</a> + <ol> + <li style="display: none; "> + <a href="#properties">Properties</a> + <ol> + <li> + <a href="#property-anchor">propertyName</a> + </li> + </ol> + </li> + <li> + <a href="#global-methods">Methods</a> + <ol> + <li> + <a href="#method-getHAR">getHAR</a> + </li> + </ol> + </li> + <li> + <a href="#global-events">Events</a> + <ol> + <li> + <a href="#event-onNavigated">onNavigated</a> + </li><li> + <a href="#event-onRequestFinished">onRequestFinished</a> + </li> + </ol> + </li> + <li> + <a href="#types">Types</a> + <ol> + <li> + <a href="#type-Request">Request</a> + </li> + </ol> + </li> + </ol> + </li> + </ol> + </div> + <!-- /TABLE OF CONTENTS --> + + <!-- Standard content lead-in for experimental API pages --> + <p id="classSummary"> + For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. + </p> + + <!-- STATIC CONTENT PLACEHOLDER --> + <div id="static"><!-- BEGIN AUTHORED CONTENT --> +<div id="pageData-name" class="pageData">chrome.experimental.devtools.network +API</div> +<p id="classSummary"> +Use the <code>chrome.experimental.devtools.network</code> module to retrieve +the information about network requests displayed by DevTools' Network panel. +</p><p> +See <a href="experimental.devtools.html">DevTools APIs summary</a> for +general introduction to using Developer Tools APIs. +</p> + +<a name="H2-0"></a><h2>Notes</h2> + +<p> +Network requests information is represented in the HTTP Archive format +(<em>HAR</em>). The description of HAR is outside of scope of this document, +please refer to <a href="http://groups.google.com/group/http-archive-specification/web/har-1-2-spec"> +HAR v1.2 Specification</a>. +</p><p> +In terms of HAR, the +<code>chrome.experimental.devtools.network.getHAR()</code> method returns +entire <em>HAR log</em>, while +<code>chrome.experimental.devtools.network.onRequestFinished</code> event +provides <em>HAR entry</em> as an argument to the event callback. +</p> +<p>Note that request content is not provided as part of HAR for efficieny +reasons. You may call request's <code>getContent()</code> method to retrieve +content. +</p><p>Some requests may be missing in the array of entries returned by <code> +getHAR()</code> in case Developer Tools window was opened after the page was +loaded — reload the page to get all requests. In general, the list of +requests returned by <code>getHAR()</code> should match that displayed by +the Network panel. +</p><h2 id="overview-examples">Examples</h2> + +<p>The following code logs URLs of all images larger than 40KB as they are +loaded:</p> + +<pre>chrome.experimental.devtools.network.onRequestFinished.addListener( + function(request) { + if (request.response.bodySize > 40*1024) + experimental.chrome.devtools.log("Large image: " + request.request.url); +}); +</pre> + +<p> +You can find more examples that use this API in +<a href="samples.html#devtools.network">Samples</a>. +</p> + +<!-- END AUTHORED CONTENT --> +</div> + + <!-- API PAGE --> + <div class="apiPage"> + <a name="apiReference"></a> + <h2>API reference: chrome.experimental.devtools.network</h2> + + <!-- PROPERTIES --> + <div class="apiGroup" style="display: none; "> + <a name="properties"></a> + <h3 id="properties">Properties</h3> + + <div> + <a></a> + <h4>getLastError</h4> + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.extension</span><span>lastError</span> + </div> + <div> + </div> + </div> + + </div> <!-- /apiGroup --> + + <!-- METHODS --> + <div id="methodsTemplate" class="apiGroup"> + <a name="global-methods"></a> + <h3>Methods</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a name="method-getHAR"></a> <!-- method-anchor --> + <h4>getHAR</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>chrome.experimental.devtools.network.getHAR</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Returns HAR archive that contains all known network requests.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A function that is called upon request completion.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + The callback <em>parameter</em> should specify a function + that looks like this: + </p> + <p style="display: none; "> + If you specify the <em>callback</em> parameter, it should + specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>object har</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div> + <div> + <dt> + <var>har</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>A HAR archive. See HAR specification for details.</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> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> <!-- /apiGroup --> + + <!-- EVENTS --> + <div id="eventsTemplate" class="apiGroup"> + <a name="global-events"></a> + <h3>Events</h3> + <!-- iterates over all events --> + <div class="apiItem"> + <a name="event-onNavigated"></a> + <h4>onNavigated</h4> + + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span class="subdued">chrome.experimental.devtools.network.</span><span>onNavigated</span><span class="subdued">.addListener</span>(function(<span>string url</span>) <span class="subdued">{...}</span><span></span>); + </div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Fired when the inspected window navigates to a new page.</p> + + <!-- LISTENER PARAMETERS --> + <div> + <h4>Listener parameters</h4> + <dl> + <div> + <div> + <dt> + <var>url</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>URL of the new page.</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> + </div> + + <!-- EXTRA PARAMETERS --> + <div style="display: none; "> + <h4>Extra parameters to addListener</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + + <!-- LISTENER RETURN VALUE --> + <h4 style="display: none; ">Listener returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + </div> <!-- /description --> + </div><div class="apiItem"> + <a name="event-onRequestFinished"></a> + <h4>onRequestFinished</h4> + + <div class="summary"> + <!-- Note: intentionally longer 80 columns --> + <span class="subdued">chrome.experimental.devtools.network.</span><span>onRequestFinished</span><span class="subdued">.addListener</span>(function(<span>Request request</span>) <span class="subdued">{...}</span><span></span>); + </div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Fired when a network request is finished and all request data are available.</p> + + <!-- LISTENER PARAMETERS --> + <div> + <h4>Listener parameters</h4> + <dl> + <div> + <div> + <dt> + <var>request</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span> + <a href="experimental.devtools.network.html#type-Request">Request</a> + </span> + <span style="display: none; "> + <span> + array of <span><span></span></span> + </span> + <span>paramType</span> + <span></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Description of a network request in the form of a HAR entry. See HAR specification for details.</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> + </div> + + <!-- EXTRA PARAMETERS --> + <div style="display: none; "> + <h4>Extra parameters to addListener</h4> + <dl> + <div> + <div> + </div> + </div> + </dl> + </div> + + <!-- LISTENER RETURN VALUE --> + <h4 style="display: none; ">Listener returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + </div> <!-- /description --> + </div> <!-- /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-Request"></a> + <h4>Request</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>Represents a network request for a document resource (script, image etc). See HAR Specification for reference.</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> + <div class="apiGroup"> + <a name="global-Request-methods"></a> + <h3>Methods of Request</h3> + + <!-- iterates over all functions --> + <div class="apiItem"> + <a name="method-Request-getContent"></a> <!-- method-anchor --> + <h4>getContent</h4> + + <div class="summary"><span style="display: none; ">void</span> + <!-- Note: intentionally longer 80 columns --> + <span>request.getContent</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> + <var><span>callback</span></var></span>)</div> + + <div class="description"> + <p class="todo" style="display: none; ">Undocumented.</p> + <p>Returns content of the response body.</p> + + <!-- PARAMETERS --> + <h4>Parameters</h4> + <dl> + <div> + <div> + <dt> + <var>callback</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>function</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>A function that is called upon request completion.</dd> + <dd style="display: none; "> + This parameter was added in version + <b><span></span></b>. + You must omit this parameter in earlier versions, + and you may omit it in any version. If you require this + parameter, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </dd> + + <!-- OBJECT PROPERTIES --> + <dd style="display: none; "> + <dl> + <div> + <div> + </div> + </div> + </dl> + </dd> + + <!-- OBJECT METHODS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + </div> + </dl> + + <!-- RETURNS --> + <h4 style="display: none; ">Returns</h4> + <dl> + <div style="display: none; "> + <div> + </div> + </div> + </dl> + + <!-- CALLBACK --> + <div> + <div> + <h4>Callback function</h4> + <p> + The callback <em>parameter</em> should specify a function + that looks like this: + </p> + <p style="display: none; "> + If you specify the <em>callback</em> parameter, it should + specify a function that looks like this: + </p> + + <!-- Note: intentionally longer 80 columns --> + <pre>function(<span>string content, string encoding</span>) <span class="subdued">{...}</span>;</pre> + <dl> + <div> + <div> + <dt> + <var>content</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Content of the response body (potentially encoded).</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>encoding</var> + <em> + + <!-- TYPE --> + <div style="display:inline"> + ( + <span class="optional" style="display: none; ">optional</span> + <span class="enum" style="display: none; ">enumerated</span> + <span id="typeTemplate"> + <span style="display: none; "> + <a> Type</a> + </span> + <span> + <span style="display: none; "> + array of <span><span></span></span> + </span> + <span>string</span> + <span style="display: none; "></span> + </span> + </span> + ) + </div> + + </em> + </dt> + <dd class="todo" style="display: none; "> + Undocumented. + </dd> + <dd>Empty if content is not encoded, encoding name otherwise. Currently, only base64 supported.</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> + </div> + </div> + + <!-- MIN_VERSION --> + <p style="display: none; "> + This function was added in version <b><span></span></b>. + If you require this function, the manifest key + <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> + can ensure that your extension won't be run in an earlier browser version. + </p> + </div> <!-- /description --> + + </div> <!-- /apiItem --> + + </div> + </dd> + + <!-- OBJECT EVENT FIELDS --> + <dd style="display: none; "> + <div></div> + </dd> + + <!-- FUNCTION PARAMETERS --> + <dd style="display: none; "> + <div></div> + </dd> + + </div> + + </div> <!-- /apiItem --> + + </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="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> +<script src="http://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> diff --git a/chrome/common/extensions/docs/experimental.devtools.resources.html b/chrome/common/extensions/docs/experimental.devtools.resources.html index ba82a10..ba56f3f 100644 --- a/chrome/common/extensions/docs/experimental.devtools.resources.html +++ b/chrome/common/extensions/docs/experimental.devtools.resources.html @@ -16,7 +16,8 @@ <script type="text/javascript" src="js/api_page_generator.js"></script> <script type="text/javascript" src="js/bootstrap.js"></script> <script type="text/javascript" src="js/sidebar.js"></script> - <title>chrome.experimental.devtools.resources - Google Chrome Extensions - Google Code</title></head> + <title>chrome.experimental.devtools.resources +API - Google Chrome Extensions - Google Code</title></head> <body> <div id="gc-container" class="labs"> <div id="devModeWarning"> You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. @@ -251,38 +252,25 @@ <div class="g-unit" id="gc-pagecontent"> <div id="pageTitle"> - <h1 class="page_title">chrome.experimental.devtools.resources</h1> + <h1 class="page_title">chrome.experimental.devtools.resources +API</h1> </div> <!-- TABLE OF CONTENTS --> - <div id="toc"> + <div id="toc" style="display: none; "> <h2>Contents</h2> <ol> <li> - <a href="#H2-0">Notes</a> + <a>h2Name</a> <ol> - <li style="display: none; "> - <a>h3Name</a> - </li> - </ol> - </li><li> - <a href="#overview-examples">Examples</a> - <ol> - <li style="display: none; "> - <a>h3Name</a> - </li> - </ol> - </li><li> - <a href="#examples">Examples</a> - <ol> - <li style="display: none; "> + <li> <a>h3Name</a> </li> </ol> </li> <li> - <a href="#apiReference">API reference: chrome.experimental.devtools.resources</a> + <a href="#apiReference">API reference</a> <ol> - <li style="display: none; "> + <li> <a href="#properties">Properties</a> <ol> <li> @@ -291,20 +279,18 @@ </ol> </li> <li> - <a href="#global-methods">Methods</a> + <a>Methods</a> <ol> <li> - <a href="#method-getHAR">getHAR</a> + <a href="#method-anchor">methodName</a> </li> </ol> </li> <li> - <a href="#global-events">Events</a> + <a>Events</a> <ol> <li> - <a href="#event-onFinished">onFinished</a> - </li><li> - <a href="#event-onNavigated">onNavigated</a> + <a href="#event-anchor">eventName</a> </li> </ol> </li> @@ -312,7 +298,7 @@ <a href="#types">Types</a> <ol> <li> - <a href="#type-Resource">Resource</a> + <a href="#id-anchor">id</a> </li> </ol> </li> @@ -329,64 +315,22 @@ <!-- STATIC CONTENT PLACEHOLDER --> <div id="static"><!-- BEGIN AUTHORED CONTENT --> -<p id="classSummary"> -Use the <code>chrome.experimental.devtools.resources</code> module to retrieve -the information about network resources displayed by DevTools' Network panel. -</p><p> -See <a href="experimental.devtools.html">DevTools APIs summary</a> for -general introduction to using Developer Tools APIs. -</p> - -<a name="H2-0"></a><h2>Notes</h2> - -<p> -Network resource information is represented in HTTP Archive format -(<em>HAR</em>). The description of HAR is outside of scope of this document, -please refer to <a href="http://groups.google.com/group/http-archive-specification/web/har-1-2-spec"> -HAR v1.2 Specification</a>. -</p><p> -In terms of HAR, the -<code>chrome.experimental.devtools.resources.getHAR()</code> method returns -entire <em>HAR log</em>, while -<code>chrome.experimental.devtools.resources.onFinish</code> event provides -<em>HAR entry</em> as an argument to the event callback. -</p> -<p>Note that resource content is not provided as part of HAR for efficieny -reasons. You may call resource's <code>getContent()</code> method to retrieve -content. -</p><p>Some resources may be missing in the array of entries returned by <code> -getHAR()</code> in case Developer Tools window was opened after the page was -loaded — reload the page to get all resources. In general, the list of -resources returned by <code>getHAR()</code> should match that displayed by -the Network panel. -</p><h2 id="overview-examples">Examples</h2> - -<p>The following code logs URLs of all images larger than 40KB as they are -loaded:</p> - -<pre>chrome.experimental.devtools.resources.onFinished.addListener(function(resource) { - if (resource.response.bodySize > 40*1024) - experimental.chrome.devtools.log("Large image: " + resource.request.url); -}); -</pre> - -<h2 id="examples">Examples</h2> - +<div id="pageData-name" class="pageData">chrome.experimental.devtools.resources +API</div> <p> -You can find examples that use this API in -<a href="samples.html#devtools.resources">Samples</a>. +The <code>experimental.devtools.resources</code> module is deprecated, use +<a href="experimental.devtools.network.html"><code>experimental.devtools.network</code></a> instead. </p> - <!-- END AUTHORED CONTENT --> </div> <!-- API PAGE --> - <div class="apiPage"> + <div class="apiPage" style="display: none; "> <a name="apiReference"></a> - <h2>API reference: chrome.experimental.devtools.resources</h2> + <h2>API reference: chrome.apiname </h2> <!-- PROPERTIES --> - <div class="apiGroup" style="display: none; "> + <div class="apiGroup"> <a name="properties"></a> <h3 id="properties">Properties</h3> @@ -405,101 +349,38 @@ You can find examples that use this API in <!-- METHODS --> <div id="methodsTemplate" class="apiGroup"> - <a name="global-methods"></a> + <a></a> <h3>Methods</h3> <!-- iterates over all functions --> <div class="apiItem"> - <a name="method-getHAR"></a> <!-- method-anchor --> - <h4>getHAR</h4> + <a></a> <!-- method-anchor --> + <h4>method name</h4> - <div class="summary"><span style="display: none; ">void</span> + <div class="summary"><span>void</span> <!-- Note: intentionally longer 80 columns --> - <span>chrome.experimental.devtools.resources.getHAR</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> - <var><span>callback</span></var></span>)</div> + <span>chrome.module.methodName</span>(<span><span>, </span><span></span> + <var><span></span></var></span>)</div> <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> - <p>Returns HAR archive that contains all known resource objects.</p> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the function goes here. + </p> <!-- PARAMETERS --> <h4>Parameters</h4> <dl> <div> <div> - <dt> - <var>callback</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span style="display: none; "> - <a> Type</a> - </span> - <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> - <span>function</span> - <span style="display: none; "></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>A function that is called upon request completion.</dd> - <dd style="display: none; "> - This parameter was added in version - <b><span></span></b>. - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> - can ensure that your extension won't be run in an earlier browser version. - </dd> - - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - - </div> + </div> </div> </dl> <!-- RETURNS --> - <h4 style="display: none; ">Returns</h4> + <h4>Returns</h4> <dl> - <div style="display: none; "> + <div> <div> </div> </div> @@ -513,89 +394,24 @@ You can find examples that use this API in The callback <em>parameter</em> should specify a function that looks like this: </p> - <p style="display: none; "> + <p> If you specify the <em>callback</em> parameter, it should specify a function that looks like this: </p> <!-- Note: intentionally longer 80 columns --> - <pre>function(<span>object har</span>) <span class="subdued">{...}</span>;</pre> + <pre>function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>;</pre> <dl> <div> <div> - <dt> - <var>har</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>A HAR archieve. See HAR specification for details.</dd> - <dd style="display: none; "> - This parameter was added in version - <b><span></span></b>. - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> - can ensure that your extension won't be run in an earlier browser version. - </dd> - - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - - </div> + </div> </div> </dl> </div> </div> <!-- MIN_VERSION --> - <p style="display: none; "> + <p> This function was added in version <b><span></span></b>. If you require this function, the manifest key <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> @@ -609,21 +425,23 @@ You can find examples that use this API in <!-- EVENTS --> <div id="eventsTemplate" class="apiGroup"> - <a name="global-events"></a> + <a></a> <h3>Events</h3> <!-- iterates over all events --> <div class="apiItem"> - <a name="event-onFinished"></a> - <h4>onFinished</h4> + <a></a> + <h4>event name</h4> <div class="summary"> <!-- Note: intentionally longer 80 columns --> - <span class="subdued">chrome.experimental.devtools.resources.</span><span>onFinished</span><span class="subdued">.addListener</span>(function(<span>Resource resource</span>) <span class="subdued">{...}</span><span></span>); + <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span><span>, Type opt_param1, Type opt_param2</span>); </div> <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> - <p>Fired when a resource request is finished and all resource data are available.</p> + <p class="todo">Undocumented.</p> + <p> + A description from the json schema def of the event goes here. + </p> <!-- LISTENER PARAMETERS --> <div> @@ -631,188 +449,13 @@ You can find examples that use this API in <dl> <div> <div> - <dt> - <var>resource</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span> - <a href="experimental.devtools.resources.html#type-Resource">Resource</a> - </span> - <span style="display: none; "> - <span> - array of <span><span></span></span> - </span> - <span>paramType</span> - <span></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>Description of a newly finished resource in the form of a HAR entry. See HAR specification for details.</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> - </div> - - <!-- EXTRA PARAMETERS --> - <div style="display: none; "> - <h4>Extra parameters to addListener</h4> - <dl> - <div> - <div> </div> </div> </dl> </div> - <!-- LISTENER RETURN VALUE --> - <h4 style="display: none; ">Listener returns</h4> - <dl> - <div style="display: none; "> - <div> - </div> - </div> - </dl> - - </div> <!-- /description --> - </div><div class="apiItem"> - <a name="event-onNavigated"></a> - <h4>onNavigated</h4> - - <div class="summary"> - <!-- Note: intentionally longer 80 columns --> - <span class="subdued">chrome.experimental.devtools.resources.</span><span>onNavigated</span><span class="subdued">.addListener</span>(function(<span>string url</span>) <span class="subdued">{...}</span><span></span>); - </div> - - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> - <p>Fired when the inspected window navigates to a new page.</p> - - <!-- LISTENER PARAMETERS --> - <div> - <h4>Listener parameters</h4> - <dl> - <div> - <div> - <dt> - <var>url</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span style="display: none; "> - <a> Type</a> - </span> - <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> - <span>string</span> - <span style="display: none; "></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>URL of the new page.</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> - </div> - <!-- EXTRA PARAMETERS --> - <div style="display: none; "> + <div> <h4>Extra parameters to addListener</h4> <dl> <div> @@ -823,9 +466,9 @@ You can find examples that use this API in </div> <!-- LISTENER RETURN VALUE --> - <h4 style="display: none; ">Listener returns</h4> + <h4>Listener returns</h4> <dl> - <div style="display: none; "> + <div> <div> </div> </div> @@ -843,345 +486,11 @@ You can find examples that use this API in <!-- iterates over all types --> <div class="apiItem"> - <a name="type-Resource"></a> - <h4>Resource</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>Represents a resource (document, script, image etc). See HAR Specification for reference.</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> - <div class="apiGroup"> - <a name="global-Resource-methods"></a> - <h3>Methods of Resource</h3> - - <!-- iterates over all functions --> - <div class="apiItem"> - <a name="method-Resource-getContent"></a> <!-- method-anchor --> - <h4>getContent</h4> - - <div class="summary"><span style="display: none; ">void</span> - <!-- Note: intentionally longer 80 columns --> - <span>resource.getContent</span>(<span class="null"><span style="display: none; ">, </span><span>function</span> - <var><span>callback</span></var></span>)</div> - - <div class="description"> - <p class="todo" style="display: none; ">Undocumented.</p> - <p>Returns resource content.</p> - - <!-- PARAMETERS --> - <h4>Parameters</h4> - <dl> - <div> - <div> - <dt> - <var>callback</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span style="display: none; "> - <a> Type</a> - </span> - <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> - <span>function</span> - <span style="display: none; "></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>A function that is called upon request completion.</dd> - <dd style="display: none; "> - This parameter was added in version - <b><span></span></b>. - You must omit this parameter in earlier versions, - and you may omit it in any version. If you require this - parameter, the manifest key - <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> - can ensure that your extension won't be run in an earlier browser version. - </dd> - - <!-- OBJECT PROPERTIES --> - <dd style="display: none; "> - <dl> - <div> - <div> - </div> - </div> - </dl> - </dd> - - <!-- OBJECT METHODS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - - </div> - </div> - </dl> - - <!-- RETURNS --> - <h4 style="display: none; ">Returns</h4> - <dl> - <div style="display: none; "> - <div> - </div> - </div> - </dl> - - <!-- CALLBACK --> - <div> - <div> - <h4>Callback function</h4> - <p> - The callback <em>parameter</em> should specify a function - that looks like this: - </p> - <p style="display: none; "> - If you specify the <em>callback</em> parameter, it should - specify a function that looks like this: - </p> - - <!-- Note: intentionally longer 80 columns --> - <pre>function(<span>string content, string encoding</span>) <span class="subdued">{...}</span>;</pre> - <dl> - <div> - <div> - <dt> - <var>content</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span style="display: none; "> - <a> Type</a> - </span> - <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> - <span>string</span> - <span style="display: none; "></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>Resource content (potentially encoded).</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>encoding</var> - <em> - - <!-- TYPE --> - <div style="display:inline"> - ( - <span class="optional" style="display: none; ">optional</span> - <span class="enum" style="display: none; ">enumerated</span> - <span id="typeTemplate"> - <span style="display: none; "> - <a> Type</a> - </span> - <span> - <span style="display: none; "> - array of <span><span></span></span> - </span> - <span>string</span> - <span style="display: none; "></span> - </span> - </span> - ) - </div> - - </em> - </dt> - <dd class="todo" style="display: none; "> - Undocumented. - </dd> - <dd>Empty if content is not encoded, encoding name otherwise. Currently, only base64 supported.</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> + <a></a> + <h4>type name</h4> - <!-- 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> - </div> - </div> - - <!-- MIN_VERSION --> - <p style="display: none; "> - This function was added in version <b><span></span></b>. - If you require this function, the manifest key - <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> - can ensure that your extension won't be run in an earlier browser version. - </p> - </div> <!-- /description --> - - </div> <!-- /apiItem --> - - </div> - </dd> - - <!-- OBJECT EVENT FIELDS --> - <dd style="display: none; "> - <div></div> - </dd> - - <!-- FUNCTION PARAMETERS --> - <dd style="display: none; "> - <div></div> - </dd> - - </div> </div> <!-- /apiItem --> diff --git a/chrome/common/extensions/docs/experimental.html b/chrome/common/extensions/docs/experimental.html index 886d22e..0a4a71c 100644 --- a/chrome/common/extensions/docs/experimental.html +++ b/chrome/common/extensions/docs/experimental.html @@ -366,8 +366,8 @@ on the following experimental APIs: <a href="experimental.debugger.html">experimental.debugger</a></li><li> <a href="experimental.devtools.audits.html">experimental.devtools.audits</a></li><li> <a href="experimental.devtools.inspectedWindow.html">experimental.devtools.inspectedWindow</a></li><li> + <a href="experimental.devtools.network.html">experimental.devtools.network</a></li><li> <a href="experimental.devtools.panels.html">experimental.devtools.panels</a></li><li> - <a href="experimental.devtools.resources.html">experimental.devtools.resources</a></li><li> <a href="experimental.infobars.html">experimental.infobars</a></li><li> <a href="experimental.permissions.html">experimental.permissions</a></li><li> <a href="experimental.privacy.html">experimental.privacy</a></li><li> diff --git a/chrome/common/extensions/docs/samples.html b/chrome/common/extensions/docs/samples.html index 7cb2de3..f71dfc2 100644 --- a/chrome/common/extensions/docs/samples.html +++ b/chrome/common/extensions/docs/samples.html @@ -337,7 +337,7 @@ "0bf0930a32829dfb77170535ecb27adc2de3998a": "ENABLE/DISABLE REFERRERS API EXAMPLE EXTENSION SAMPLE EXTENSION WHICH DEMONSTRATES HOW TO ACCESS A PREFERENCE. BROWSER_ACTION CONTENTSETTINGS EXPERIMENTAL POPUP CHROME.EXTENSION.ISALLOWEDINCOGNITOACCESS", "763a08e9b06595d785568a8d392b95a2f3700258": "EVENT TRACKING WITH GOOGLE ANALYTICS A SAMPLE EXTENSION WHICH USES GOOGLE ANALYTICS TO TRACK USAGE. BACKGROUND_PAGE BROWSER_ACTION POPUP", "e3df888a89e35bdeb9c8bc8d03be5e1851b97c68": "EXTENSION DOCS SEARCH SEARCH THE CHROME EXTENSIONS DOCUMENTATION. TO USE, TYPE CRDOC PLUS A SEARCH TERM INTO THE OMNIBOX. BACKGROUND_PAGE TABS CHROME.OMNIBOX.ONINPUTCHANGED CHROME.OMNIBOX.ONINPUTENTERED CHROME.TABS.CREATE CHROME.TABS.GET CHROME.TABS.ONREMOVED CHROME.TABS.UPDATE", - "81c9aeb77827013f15a8fdff0cf6e07332816614": "FIREPHP FOR CHROME EXTENDS THE DEVELOPER TOOLS, ADDING SUPPORT FOR PARSING FIREPHP MESSAGES FROM SERVER BACKGROUND_PAGE DEVTOOLS_PAGE EXPERIMENTAL TABS CHROME.EXPERIMENTAL.DEVTOOLS.RESOURCES.GETHAR CHROME.EXPERIMENTAL.DEVTOOLS.RESOURCES.ONFINISHED CHROME.EXTENSION.ONREQUEST CHROME.EXTENSION.SENDREQUEST CHROME.TABS.EXECUTESCRIPT", + "4efa12eaaa442b6b7c880e7a38ceeb0cff7e8b77": "FIREPHP FOR CHROME EXTENDS THE DEVELOPER TOOLS, ADDING SUPPORT FOR PARSING FIREPHP MESSAGES FROM SERVER BACKGROUND_PAGE DEVTOOLS_PAGE EXPERIMENTAL TABS CHROME.EXPERIMENTAL.DEVTOOLS.NETWORK.GETHAR CHROME.EXPERIMENTAL.DEVTOOLS.NETWORK.ONREQUESTFINISHED CHROME.EXTENSION.ONREQUEST CHROME.EXTENSION.SENDREQUEST CHROME.TABS.EXECUTESCRIPT", "8b0dd31216235941bdd8eb33fda915ef5cf79a82": "GOOGLE CALENDAR CHECKER (BY GOOGLE) QUICKLY SEE THE TIME UNTIL YOUR NEXT MEETING FROM ANY OF YOUR CALENDARS. CLICK ON THE BUTTON TO BE TAKEN TO YOUR CALENDAR. BACKGROUND_PAGE BROWSER_ACTION OPTIONS_PAGE TABS CHROME.BROWSERACTION.ONCLICKED CHROME.BROWSERACTION.SETBADGEBACKGROUNDCOLOR CHROME.BROWSERACTION.SETBADGETEXT CHROME.BROWSERACTION.SETICON CHROME.BROWSERACTION.SETTITLE CHROME.EXTENSION.GETBACKGROUNDPAGE CHROME.EXTENSION.ONREQUEST CHROME.EXTENSION.SENDREQUEST CHROME.I18N.GETMESSAGE CHROME.TABS.CREATE CHROME.TABS.GET CHROME.TABS.GETALLINWINDOW CHROME.TABS.ONUPDATED CHROME.TABS.UPDATE", "4e35caa9742fb82dbd628892d23a781614f6eff6": "GOOGLE DOCUMENT LIST VIEWER DEMONSTRATES HOW TO USE OAUTH TO CONNECT THE GOOGLE DOCUMENTS LIST DATA API. BACKGROUND_PAGE BROWSER_ACTION OPTIONS_PAGE POPUP TABS CHROME.BROWSERACTION.SETBADGETEXT CHROME.EXTENSION.GETBACKGROUNDPAGE CHROME.EXTENSION.GETURL CHROME.TABS.CREATE CHROME.TABS.GET CHROME.TABS.GETSELECTED CHROME.TABS.ONUPDATED CHROME.TABS.REMOVE", "bb57f7a0132cbeb36ad7e7bb0ab75c21704234ca": "GOOGLE MAIL CHECKER DISPLAYS THE NUMBER OF UNREAD MESSAGES IN YOUR GOOGLE MAIL INBOX. YOU CAN ALSO CLICK THE BUTTON TO OPEN YOUR INBOX. BACKGROUND_PAGE BROWSER_ACTION OPTIONS_PAGE TABS CHROME.BROWSERACTION.ONCLICKED CHROME.BROWSERACTION.SETBADGEBACKGROUNDCOLOR CHROME.BROWSERACTION.SETBADGETEXT CHROME.BROWSERACTION.SETICON CHROME.EXTENSION.GETBACKGROUNDPAGE CHROME.I18N.GETMESSAGE CHROME.TABS.CREATE CHROME.TABS.GET CHROME.TABS.GETALLINWINDOW CHROME.TABS.ONUPDATED CHROME.TABS.UPDATE", @@ -1503,11 +1503,11 @@ <a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/omnibox/extension-docs/">Browse source</a> - <a href="examples/api/omnibox/extension-docs.zip">Download source</a> </div> -</div><div class="sample" id="81c9aeb77827013f15a8fdff0cf6e07332816614"> +</div><div class="sample" id="4efa12eaaa442b6b7c880e7a38ceeb0cff7e8b77"> <img class="icon" style="display: none; "> <img class="icon" src="images/sample-default-icon.png"> <h2 class="name"> - <a href="#81c9aeb77827013f15a8fdff0cf6e07332816614">FirePHP for Chrome</a> + <a href="#4efa12eaaa442b6b7c880e7a38ceeb0cff7e8b77">FirePHP for Chrome</a> </h2> <p class="metadata features">Uses <span> @@ -1528,9 +1528,9 @@ <div class="apicalls"><strong>Calls:</strong> <ul> <li> - <code><a href="experimental.devtools.resources.html#method-getHAR">chrome.experimental.devtools.resources.getHAR</a></code> + <code><a href="experimental.devtools.network.html#method-getHAR">chrome.experimental.devtools.network.getHAR</a></code> </li><li> - <code><a href="experimental.devtools.resources.html#event-onFinished">chrome.experimental.devtools.resources.onFinished</a></code> + <code><a href="experimental.devtools.network.html#event-onRequestFinished">chrome.experimental.devtools.network.onRequestFinished</a></code> </li><li> <code><a href="extension.html#event-onRequest">chrome.extension.onRequest</a></code> </li><li> @@ -1543,19 +1543,19 @@ <div class="sourcefiles"><strong>Source files:</strong> <ul> <li> - <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/background.html?content-type=text/plain">background.html</a></code> + <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/background.html?content-type=text/plain">background.html</a></code> </li><li> - <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.html?content-type=text/plain">devtools.html</a></code> + <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.html?content-type=text/plain">devtools.html</a></code> </li><li> - <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/devtools.js?content-type=text/plain">devtools.js</a></code> + <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/devtools.js?content-type=text/plain">devtools.js</a></code> </li><li> - <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/manifest.json?content-type=text/plain">manifest.json</a></code> + <code><a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/manifest.json?content-type=text/plain">manifest.json</a></code> </li> </ul> </div> <div> - <a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/resources/chrome-firephp/">Browse source</a> - - <a href="examples/api/devtools/resources/chrome-firephp.zip">Download source</a> + <a target="_blank" href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extensions/docs/examples/api/devtools/network/chrome-firephp/">Browse source</a> + - <a href="examples/api/devtools/network/chrome-firephp.zip">Download source</a> </div> </div><div class="sample" id="8b0dd31216235941bdd8eb33fda915ef5cf79a82"> <img class="icon" src="examples/extensions/calendar/images/icon-128.gif"> diff --git a/chrome/common/extensions/docs/samples.json b/chrome/common/extensions/docs/samples.json index 34833c9..128226c 100644 --- a/chrome/common/extensions/docs/samples.json +++ b/chrome/common/extensions/docs/samples.json @@ -55,10 +55,10 @@ "chrome.experimental.devtools.audits.addCategory": "experimental.devtools.audits.html#method-addCategory", "chrome.experimental.devtools.inspectedWindow.eval": "experimental.devtools.inspectedWindow.html#method-eval", "chrome.experimental.devtools.inspectedWindow.reload": "experimental.devtools.inspectedWindow.html#method-reload", + "chrome.experimental.devtools.network.getHAR": "experimental.devtools.network.html#method-getHAR", + "chrome.experimental.devtools.network.onNavigated": "experimental.devtools.network.html#event-onNavigated", + "chrome.experimental.devtools.network.onRequestFinished": "experimental.devtools.network.html#event-onRequestFinished", "chrome.experimental.devtools.panels.create": "experimental.devtools.panels.html#method-create", - "chrome.experimental.devtools.resources.getHAR": "experimental.devtools.resources.html#method-getHAR", - "chrome.experimental.devtools.resources.onFinished": "experimental.devtools.resources.html#event-onFinished", - "chrome.experimental.devtools.resources.onNavigated": "experimental.devtools.resources.html#event-onNavigated", "chrome.experimental.infobars.show": "experimental.infobars.html#method-show", "chrome.experimental.permissions.contains": "experimental.permissions.html#method-contains", "chrome.experimental.permissions.getAll": "experimental.permissions.html#method-getAll", @@ -820,8 +820,8 @@ }, { "api_calls": [ - "chrome.experimental.devtools.resources.getHAR", - "chrome.experimental.devtools.resources.onFinished", + "chrome.experimental.devtools.network.getHAR", + "chrome.experimental.devtools.network.onRequestFinished", "chrome.extension.onRequest", "chrome.extension.sendRequest", "chrome.tabs.executeScript" @@ -834,22 +834,22 @@ "tabs" ], "icon": null, - "id": "81c9aeb77827013f15a8fdff0cf6e07332816614", + "id": "4efa12eaaa442b6b7c880e7a38ceeb0cff7e8b77", "name": "FirePHP for Chrome", - "path": "examples\/api\/devtools\/resources\/chrome-firephp\/", + "path": "examples\/api\/devtools\/network\/chrome-firephp\/", "protocols": [ "http:\/\/", "https:\/\/" ], - "search_string": "FIREPHP FOR CHROME EXTENDS THE DEVELOPER TOOLS, ADDING SUPPORT FOR PARSING FIREPHP MESSAGES FROM SERVER BACKGROUND_PAGE DEVTOOLS_PAGE EXPERIMENTAL TABS CHROME.EXPERIMENTAL.DEVTOOLS.RESOURCES.GETHAR CHROME.EXPERIMENTAL.DEVTOOLS.RESOURCES.ONFINISHED CHROME.EXTENSION.ONREQUEST CHROME.EXTENSION.SENDREQUEST CHROME.TABS.EXECUTESCRIPT", + "search_string": "FIREPHP FOR CHROME EXTENDS THE DEVELOPER TOOLS, ADDING SUPPORT FOR PARSING FIREPHP MESSAGES FROM SERVER BACKGROUND_PAGE DEVTOOLS_PAGE EXPERIMENTAL TABS CHROME.EXPERIMENTAL.DEVTOOLS.NETWORK.GETHAR CHROME.EXPERIMENTAL.DEVTOOLS.NETWORK.ONREQUESTFINISHED CHROME.EXTENSION.ONREQUEST CHROME.EXTENSION.SENDREQUEST CHROME.TABS.EXECUTESCRIPT", "source_files": [ "background.html", "devtools.html", "devtools.js", "manifest.json" ], - "source_hash": "46b426df9ae054648e56756d19e15094f63a0776", - "zip_path": "examples\/api\/devtools\/resources\/chrome-firephp.zip" + "source_hash": "b607f6ca8f1ccf4343766b480ae21bb220dd949c", + "zip_path": "examples\/api\/devtools\/network\/chrome-firephp.zip" }, { "api_calls": [ diff --git a/chrome/common/extensions/docs/static/experimental.devtools.network.html b/chrome/common/extensions/docs/static/experimental.devtools.network.html new file mode 100644 index 0000000..0bf0b9a --- /dev/null +++ b/chrome/common/extensions/docs/static/experimental.devtools.network.html @@ -0,0 +1,53 @@ +<!-- BEGIN AUTHORED CONTENT --> +<div id="pageData-name" class="pageData">chrome.experimental.devtools.network +API</div> +<p id="classSummary"> +Use the <code>chrome.experimental.devtools.network</code> module to retrieve +the information about network requests displayed by DevTools' Network panel. +</p><p> +See <a href="experimental.devtools.html">DevTools APIs summary</a> for +general introduction to using Developer Tools APIs</a>. +</p> + +<h2>Notes</h2> + +<p> +Network requests information is represented in the HTTP Archive format +(<em>HAR</em>). The description of HAR is outside of scope of this document, +please refer to <a href= +"http://groups.google.com/group/http-archive-specification/web/har-1-2-spec"> +HAR v1.2 Specification</a>. +</p><p> +In terms of HAR, the +<code>chrome.experimental.devtools.network.getHAR()</code> method returns +entire <em>HAR log</em>, while +<code>chrome.experimental.devtools.network.onRequestFinished</code> event +provides <em>HAR entry</em> as an argument to the event callback. +</p> +<p>Note that request content is not provided as part of HAR for efficieny +reasons. You may call request's <code>getContent()</code> method to retrieve +content. +<p>Some requests may be missing in the array of entries returned by <code> +getHAR()</code> in case Developer Tools window was opened after the page was +loaded — reload the page to get all requests. In general, the list of +requests returned by <code>getHAR()</code> should match that displayed by +the Network panel. +<h2 id="overview-examples">Examples</h2> + +<p>The following code logs URLs of all images larger than 40KB as they are +loaded:</p> + +<pre> +chrome.experimental.devtools.network.onRequestFinished.addListener( + function(request) { + if (request.response.bodySize > 40*1024) + experimental.chrome.devtools.log("Large image: " + request.request.url); +}); +</pre> + +<p> +You can find more examples that use this API in +<a href="samples.html#devtools.network">Samples</a>. +</p> + +<!-- END AUTHORED CONTENT --> diff --git a/chrome/common/extensions/docs/static/experimental.devtools.resources.html b/chrome/common/extensions/docs/static/experimental.devtools.resources.html index 6609549..928910a 100644 --- a/chrome/common/extensions/docs/static/experimental.devtools.resources.html +++ b/chrome/common/extensions/docs/static/experimental.devtools.resources.html @@ -1,52 +1,9 @@ <!-- BEGIN AUTHORED CONTENT --> -<p id="classSummary"> -Use the <code>chrome.experimental.devtools.resources</code> module to retrieve -the information about network resources displayed by DevTools' Network panel. -</p><p> -See <a href="experimental.devtools.html">DevTools APIs summary</a> for -general introduction to using Developer Tools APIs</a>. -</p> - -<h2>Notes</h2> - -<p> -Network resource information is represented in HTTP Archive format -(<em>HAR</em>). The description of HAR is outside of scope of this document, -please refer to <a href= -"http://groups.google.com/group/http-archive-specification/web/har-1-2-spec"> -HAR v1.2 Specification</a>. -</p><p> -In terms of HAR, the -<code>chrome.experimental.devtools.resources.getHAR()</code> method returns -entire <em>HAR log</em>, while -<code>chrome.experimental.devtools.resources.onFinish</code> event provides -<em>HAR entry</em> as an argument to the event callback. -</p> -<p>Note that resource content is not provided as part of HAR for efficieny -reasons. You may call resource's <code>getContent()</code> method to retrieve -content. -<p>Some resources may be missing in the array of entries returned by <code> -getHAR()</code> in case Developer Tools window was opened after the page was -loaded — reload the page to get all resources. In general, the list of -resources returned by <code>getHAR()</code> should match that displayed by -the Network panel. -<h2 id="overview-examples">Examples</h2> - -<p>The following code logs URLs of all images larger than 40KB as they are -loaded:</p> - -<pre> -chrome.experimental.devtools.resources.onFinished.addListener(function(resource) { - if (resource.response.bodySize > 40*1024) - experimental.chrome.devtools.log("Large image: " + resource.request.url); -}); -</pre> - -<h2 id="examples">Examples</h2> - +<div id="pageData-name" class="pageData">chrome.experimental.devtools.resources +API</div> <p> -You can find examples that use this API in -<a href="samples.html#devtools.resources">Samples</a>. +The <code>experimental.devtools.resources</code> module is deprecated, use +<a href="experimental.devtools.network.html" +><code>experimental.devtools.network</code></a> instead. </p> - <!-- END AUTHORED CONTENT --> |