| OLD | NEW |
| (Empty) |
| 1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | |
| 2 1) The <head> information in this page is significant, should be uniform | |
| 3 across api docs and should be edited only with knowledge of the | |
| 4 templating mechanism. | |
| 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | |
| 6 browser, it will be re-generated from the template, json schema and | |
| 7 authored overview content. | |
| 8 4) The <body>.innerHTML is also generated by an offline step so that this | |
| 9 page may easily be indexed by search engines. | |
| 10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | |
| 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
| 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> | |
| 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> | |
| 14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js"> | |
| 15 </script> | |
| 16 <script type="text/javascript" src="../../../../third_party/json_minify/mini
fy-sans-regexp.js"> | |
| 17 </script> | |
| 18 <script type="text/javascript" src="js/api_page_generator.js"></script> | |
| 19 <script type="text/javascript" src="js/bootstrap.js"></script> | |
| 20 <script type="text/javascript" src="js/sidebar.js"></script> | |
| 21 <meta name="description" content="Documentation for the chrome.devtools.networ
k module, which is part of the Google Chrome extension APIs."><title>chrome.dev
tools.network | |
| 22 API - Google Chrome Extensions - Google Code</title></head> | |
| 23 <body> <div id="devModeWarning" class="displayModeWarning"> | |
| 24 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. | |
| 25 </div> | |
| 26 <div id="branchWarning" class="displayModeWarning"> | |
| 27 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. | |
| 28 It may not work with the stable release of Chrome.</span> | |
| 29 <select id="branchChooser"> | |
| 30 <option>Choose a different version... | |
| 31 </option><option value="">Stable | |
| 32 </option><option value="beta">Beta | |
| 33 </option><option value="dev">Dev | |
| 34 </option><option value="trunk">Trunk | |
| 35 </option></select> | |
| 36 </div> | |
| 37 <div id="unofficialWarning" class="displayModeWarning"> | |
| 38 <span>WARNING: This is unofficial documentation. It may not work with the | |
| 39 current release of Chrome.</span> | |
| 40 <button id="goToOfficialDocs">Go to the official docs</button> | |
| 41 </div> | |
| 42 <div id="gc-container" class="labs"> | |
| 43 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> | |
| 44 <!-- In particular, sub-templates that recurse, must be used by allowing | |
| 45 jstemplate to make a copy of the template in this section which | |
| 46 are not operated on by way of the jsskip="true" --> | |
| 47 <!-- /SUBTEMPLATES --> | |
| 48 <a id="top"></a> | |
| 49 <div id="skipto"> | |
| 50 <a href="#gc-pagecontent">Skip to page content</a> | |
| 51 <a href="#gc-toc">Skip to main navigation</a> | |
| 52 </div> | |
| 53 <!-- API HEADER --> | |
| 54 <table id="header" width="100%" cellspacing="0" border="0"> | |
| 55 <tbody><tr> | |
| 56 <td valign="middle"><a href="http://code.google.com/"><img src="images/c
ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:
0; margin:0;"></a></td> | |
| 57 <td valign="middle" width="100%" style="padding-left:0.6em;"> | |
| 58 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> | |
| 59 <div id="gsc-search-box"> | |
| 60 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> | |
| 61 <input type="hidden" name="ie" value="UTF-8"> | |
| 62 <input type="text" name="q" value="" size="55"> | |
| 63 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> | |
| 64 <br> | |
| 65 <span class="greytext">e.g. "page action" or "tabs"</span> | |
| 66 </div> | |
| 67 </form> | |
| 68 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> | |
| 69 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> | |
| 70 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> | |
| 71 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> | |
| 72 </td> | |
| 73 </tr> | |
| 74 </tbody></table> | |
| 75 <div id="codesiteContent" class=""> | |
| 76 <a id="gc-topnav-anchor"></a> | |
| 77 <div id="gc-topnav"> | |
| 78 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> | |
| 79 <ul id="home" class="gc-topnav-tabs"> | |
| 80 <li id="home_link"> | |
| 81 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> | |
| 82 </li> | |
| 83 <li id="docs_link"> | |
| 84 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> | |
| 85 </li> | |
| 86 <li id="faq_link"> | |
| 87 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> | |
| 88 </li> | |
| 89 <li id="samples_link"> | |
| 90 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> | |
| 91 </li> | |
| 92 <li id="group_link"> | |
| 93 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> | |
| 94 </li> | |
| 95 <li id="so_link"> | |
| 96 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> | |
| 97 </li> | |
| 98 </ul> | |
| 99 </div> <!-- end gc-topnav --> | |
| 100 <div class="g-section g-tpl-170"> | |
| 101 <!-- SIDENAV --> | |
| 102 <div class="g-unit g-first" id="gc-toc"> | |
| 103 <ul> | |
| 104 <li><a href="getstarted.html">Getting Started</a></li> | |
| 105 <li><a href="overview.html">Overview</a></li> | |
| 106 <li><a href="whats_new.html">What's New?</a></li> | |
| 107 <li><h2><a href="devguide.html">Developer's Guide</a></h2> | |
| 108 <ul> | |
| 109 <li>Browser UI | |
| 110 <ul> | |
| 111 <li><a href="browserAction.html">Browser Actions</a></li> | |
| 112 <li><a href="contextMenus.html">Context Menus</a></li> | |
| 113 <li><a href="notifications.html">Desktop Notifications</a></li
> | |
| 114 <li><a href="omnibox.html">Omnibox</a></li> | |
| 115 <li><a href="options.html">Options Pages</a></li> | |
| 116 <li><a href="override.html">Override Pages</a></li> | |
| 117 <li><a href="pageAction.html">Page Actions</a></li> | |
| 118 </ul> | |
| 119 </li> | |
| 120 <li>Browser Interaction | |
| 121 <ul> | |
| 122 <li><a href="bookmarks.html">Bookmarks</a></li> | |
| 123 <li><a href="cookies.html">Cookies</a></li> | |
| 124 <li><a href="devtools.html">Developer Tools</a></li> | |
| 125 <li><a href="events.html">Events</a></li> | |
| 126 <li><a href="history.html">History</a></li> | |
| 127 <li><a href="management.html">Management</a></li> | |
| 128 <li><a href="tabs.html">Tabs</a></li> | |
| 129 <li><a href="windows.html">Windows</a></li> | |
| 130 </ul> | |
| 131 </li> | |
| 132 <li>Implementation | |
| 133 <ul> | |
| 134 <li><a href="a11y.html">Accessibility</a></li> | |
| 135 <li><a href="background_pages.html">Background Pages</a></li> | |
| 136 <li><a href="content_scripts.html">Content Scripts</a></li> | |
| 137 <li><a href="xhr.html">Cross-Origin XHR</a></li> | |
| 138 <li><a href="i18n.html">Internationalization</a></li> | |
| 139 <li><a href="messaging.html">Message Passing</a></li> | |
| 140 <li><a href="permissions.html">Optional Permissions</a></li> | |
| 141 <li><a href="npapi.html">NPAPI Plugins</a></li> | |
| 142 </ul> | |
| 143 </li> | |
| 144 <li>Finishing | |
| 145 <ul> | |
| 146 <li><a href="hosting.html">Hosting</a></li> | |
| 147 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> | |
| 148 </ul> | |
| 149 </li> | |
| 150 </ul> | |
| 151 </li> | |
| 152 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> | |
| 153 <li><h2><a href="tutorials.html">Tutorials</a></h2> | |
| 154 <ul> | |
| 155 <li><a href="tut_debugging.html">Debugging</a></li> | |
| 156 <li><a href="tut_analytics.html">Google Analytics</a></li> | |
| 157 <li><a href="tut_oauth.html">OAuth</a></li> | |
| 158 </ul> | |
| 159 </li> | |
| 160 <li><h2>Reference</h2> | |
| 161 <ul> | |
| 162 <li>Formats | |
| 163 <ul> | |
| 164 <li><a href="manifest.html">Manifest Files</a></li> | |
| 165 <li><a href="match_patterns.html">Match Patterns</a></li> | |
| 166 </ul> | |
| 167 </li> | |
| 168 <li><a href="permission_warnings.html">Permission Warnings</a></li
> | |
| 169 <li><a href="api_index.html">chrome.* APIs</a></li> | |
| 170 <li><a href="api_other.html">Other APIs</a></li> | |
| 171 </ul> | |
| 172 </li> | |
| 173 <li><h2><a href="samples.html">Samples</a></h2></li> | |
| 174 <div class="line"> </div> | |
| 175 <li><h2>More</h2> | |
| 176 <ul> | |
| 177 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> | |
| 178 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> | |
| 179 <li><a href="themes.html">Themes</a></li> | |
| 180 </ul> | |
| 181 </li> | |
| 182 </ul> | |
| 183 </div> | |
| 184 <script> | |
| 185 initToggles(); | |
| 186 </script> | |
| 187 <div class="g-unit" id="gc-pagecontent"> | |
| 188 <div id="pageTitle"> | |
| 189 <h1 class="page_title">chrome.devtools.network | |
| 190 API</h1> | |
| 191 </div> | |
| 192 <!-- TABLE OF CONTENTS --> | |
| 193 <div id="toc"> | |
| 194 <h2>Contents</h2> | |
| 195 <ol> | |
| 196 <li> | |
| 197 <a href="#H2-0">Overview</a> | |
| 198 <ol> | |
| 199 </ol> | |
| 200 </li><li> | |
| 201 <a href="#overview-examples">Examples</a> | |
| 202 <ol> | |
| 203 </ol> | |
| 204 </li> | |
| 205 <li> | |
| 206 <a href="#apiReference">API reference: chrome.devtools.network</
a> | |
| 207 <ol> | |
| 208 <li> | |
| 209 <a href="#global-methods">Methods</a> | |
| 210 <ol> | |
| 211 <li> | |
| 212 <a href="#method-getHAR">getHAR</a> | |
| 213 </li> | |
| 214 </ol> | |
| 215 </li> | |
| 216 <li> | |
| 217 <a href="#global-events">Events</a> | |
| 218 <ol> | |
| 219 <li> | |
| 220 <a href="#event-onNavigated">onNavigated</a> | |
| 221 </li><li> | |
| 222 <a href="#event-onRequestFinished">onRequestFinished</a> | |
| 223 </li> | |
| 224 </ol> | |
| 225 </li> | |
| 226 <li> | |
| 227 <a href="#types">Types</a> | |
| 228 <ol> | |
| 229 <li> | |
| 230 <a href="#type-Request">Request</a> | |
| 231 <ol> | |
| 232 <li> | |
| 233 <a href="#global-Request-methods">Methods</a> | |
| 234 <ol> | |
| 235 <li> | |
| 236 <a href="#method-Request-getContent">getContent</a> | |
| 237 </li> | |
| 238 </ol> | |
| 239 </li> | |
| 240 </ol> | |
| 241 </li> | |
| 242 </ol> | |
| 243 </li> | |
| 244 </ol> | |
| 245 </li> | |
| 246 </ol> | |
| 247 </div> | |
| 248 <!-- /TABLE OF CONTENTS --> | |
| 249 <!-- Standard content lead-in for experimental API pages --> | |
| 250 <!-- STATIC CONTENT PLACEHOLDER --> | |
| 251 <div id="static"><!-- BEGIN AUTHORED CONTENT --> | |
| 252 <div id="pageData-name" class="pageData">chrome.devtools.network | |
| 253 API</div> | |
| 254 <p id="classSummary"> | |
| 255 Use the <code>chrome.devtools.network</code> module to retrieve | |
| 256 the information about network requests displayed by the Developer Tools | |
| 257 in the Network panel. | |
| 258 </p><p> | |
| 259 See <a href="devtools.html">DevTools APIs summary</a> for | |
| 260 general introduction to using Developer Tools APIs. | |
| 261 </p> | |
| 262 <a name="H2-0"></a><h2>Overview</h2> | |
| 263 <p> | |
| 264 Network requests information is represented in the HTTP Archive format | |
| 265 (<em>HAR</em>). The description of HAR is outside of scope of this document, | |
| 266 please refer to <a href="http://www.softwareishard.com/blog/har-12-spec/"> | |
| 267 HAR v1.2 Specification</a>. | |
| 268 </p><p> | |
| 269 In terms of HAR, the | |
| 270 <code>chrome.devtools.network.getHAR()</code> method returns | |
| 271 entire <em>HAR log</em>, while | |
| 272 <code>chrome.devtools.network.onRequestFinished</code> event | |
| 273 provides <em>HAR entry</em> as an argument to the event callback. | |
| 274 </p> | |
| 275 <p>Note that request content is not provided as part of HAR for efficieny | |
| 276 reasons. You may call request's <code>getContent()</code> method to retrieve | |
| 277 content. | |
| 278 </p><p>If the Developer Tools window is opened after the page is loaded, | |
| 279 some requests may be missing | |
| 280 in the array of entries returned by <code>getHAR()</code>. | |
| 281 Reload the page to get all requests. | |
| 282 In general, the list of | |
| 283 requests returned by <code>getHAR()</code> should match that displayed in | |
| 284 the Network panel. | |
| 285 </p><h2 id="overview-examples">Examples</h2> | |
| 286 <p>The following code logs URLs of all images larger than 40KB as they are | |
| 287 loaded:</p> | |
| 288 <pre>chrome.devtools.network.onRequestFinished.addListener( | |
| 289 function(request) { | |
| 290 if (request.response.bodySize > 40*1024) | |
| 291 chrome.experimental.devtools.console.addMessage( | |
| 292 chrome.experimental.devtools.console.Severity.Warning, | |
| 293 "Large image: " + request.request.url); | |
| 294 }); | |
| 295 </pre> | |
| 296 <p> | |
| 297 You can find more examples that use this API in | |
| 298 <a href="samples.html#devtools.network">Samples</a>. | |
| 299 </p> | |
| 300 <!-- END AUTHORED CONTENT --> | |
| 301 </div> | |
| 302 <!-- API PAGE --> | |
| 303 <div class="apiPage"> | |
| 304 <a name="apiReference"></a> | |
| 305 <h2>API reference: chrome.devtools.network</h2> | |
| 306 <!-- PROPERTIES --> | |
| 307 <!-- /apiGroup --> | |
| 308 <!-- METHODS --> | |
| 309 <div id="methodsTemplate" class="apiGroup"> | |
| 310 <a name="global-methods"></a> | |
| 311 <h3>Methods</h3> | |
| 312 <!-- iterates over all functions --> | |
| 313 <div class="apiItem"> | |
| 314 <a name="method-getHAR"></a> <!-- method-anchor --> | |
| 315 <h4>getHAR</h4> | |
| 316 <div class="summary"> | |
| 317 <!-- Note: intentionally longer 80 columns --> | |
| 318 <span>chrome.devtools.network.getHAR</span>(<span class="null"
><span>function</span> | |
| 319 <var><span>callback</span></var></span>)</div> | |
| 320 <div class="description"> | |
| 321 <p>Returns HAR log that contains all known network requests.</p> | |
| 322 <!-- PARAMETERS --> | |
| 323 <h4>Parameters</h4> | |
| 324 <dl> | |
| 325 <div> | |
| 326 <div> | |
| 327 <dt> | |
| 328 <var>callback</var> | |
| 329 <em> | |
| 330 <!-- TYPE --> | |
| 331 <div style="display:inline"> | |
| 332 ( | |
| 333 <span id="typeTemplate"> | |
| 334 <span> | |
| 335 <span>function</span> | |
| 336 </span> | |
| 337 </span> | |
| 338 ) | |
| 339 </div> | |
| 340 </em> | |
| 341 </dt> | |
| 342 <dd>A function that receives the HAR log when the request completes.</
dd> | |
| 343 <!-- OBJECT PROPERTIES --> | |
| 344 <!-- OBJECT METHODS --> | |
| 345 <!-- OBJECT EVENT FIELDS --> | |
| 346 <!-- FUNCTION PARAMETERS --> | |
| 347 </div> | |
| 348 </div> | |
| 349 </dl> | |
| 350 <!-- RETURNS --> | |
| 351 <dl> | |
| 352 </dl> | |
| 353 <!-- CALLBACK --> | |
| 354 <div> | |
| 355 <div> | |
| 356 <h4>Callback function</h4> | |
| 357 <p> | |
| 358 The <em>callback</em> parameter should specify a function | |
| 359 that looks like this: | |
| 360 </p> | |
| 361 <!-- Note: intentionally longer 80 columns --> | |
| 362 <pre>function(<span>object harLog</span>) <span class="subdued
">{...}</span>;</pre> | |
| 363 <dl> | |
| 364 <div> | |
| 365 <div> | |
| 366 <dt> | |
| 367 <var>harLog</var> | |
| 368 <em> | |
| 369 <!-- TYPE --> | |
| 370 <div style="display:inline"> | |
| 371 ( | |
| 372 <span id="typeTemplate"> | |
| 373 <span> | |
| 374 <span>object</span> | |
| 375 </span> | |
| 376 </span> | |
| 377 ) | |
| 378 </div> | |
| 379 </em> | |
| 380 </dt> | |
| 381 <dd>A HAR log. See HAR specification for details.</dd> | |
| 382 <!-- OBJECT PROPERTIES --> | |
| 383 <!-- OBJECT METHODS --> | |
| 384 <!-- OBJECT EVENT FIELDS --> | |
| 385 <!-- FUNCTION PARAMETERS --> | |
| 386 </div> | |
| 387 </div> | |
| 388 </dl> | |
| 389 </div> | |
| 390 </div> | |
| 391 <!-- MIN_VERSION --> | |
| 392 </div> <!-- /description --> | |
| 393 </div> <!-- /apiItem --> | |
| 394 </div> <!-- /apiGroup --> | |
| 395 <!-- EVENTS --> | |
| 396 <div id="eventsTemplate" class="apiGroup"> | |
| 397 <a name="global-events"></a> | |
| 398 <h3>Events</h3> | |
| 399 <!-- iterates over all events --> | |
| 400 <div class="apiItem"> | |
| 401 <a name="event-onNavigated"></a> | |
| 402 <h4>onNavigated</h4> | |
| 403 <div class="summary"> | |
| 404 <!-- Note: intentionally longer 80 columns --> | |
| 405 <span class="subdued">chrome.devtools.network.</span><span>onNav
igated</span><span class="subdued">.addListener</span>(function(<span>string url
</span>) <span class="subdued">{...}</span><span></span>); | |
| 406 </div> | |
| 407 <div class="description"> | |
| 408 <p>Fired when the inspected window navigates to a new page.</p> | |
| 409 <!-- LISTENER PARAMETERS --> | |
| 410 <div> | |
| 411 <h4>Listener parameters</h4> | |
| 412 <dl> | |
| 413 <div> | |
| 414 <div> | |
| 415 <dt> | |
| 416 <var>url</var> | |
| 417 <em> | |
| 418 <!-- TYPE --> | |
| 419 <div style="display:inline"> | |
| 420 ( | |
| 421 <span id="typeTemplate"> | |
| 422 <span> | |
| 423 <span>string</span> | |
| 424 </span> | |
| 425 </span> | |
| 426 ) | |
| 427 </div> | |
| 428 </em> | |
| 429 </dt> | |
| 430 <dd>URL of the new page.</dd> | |
| 431 <!-- OBJECT PROPERTIES --> | |
| 432 <!-- OBJECT METHODS --> | |
| 433 <!-- OBJECT EVENT FIELDS --> | |
| 434 <!-- FUNCTION PARAMETERS --> | |
| 435 </div> | |
| 436 </div> | |
| 437 </dl> | |
| 438 </div> | |
| 439 <!-- EXTRA PARAMETERS --> | |
| 440 <!-- LISTENER RETURN VALUE --> | |
| 441 <dl> | |
| 442 </dl> | |
| 443 </div> <!-- /description --> | |
| 444 <!-- /description --> | |
| 445 </div><div class="apiItem"> | |
| 446 <a name="event-onRequestFinished"></a> | |
| 447 <h4>onRequestFinished</h4> | |
| 448 <div class="summary"> | |
| 449 <!-- Note: intentionally longer 80 columns --> | |
| 450 <span class="subdued">chrome.devtools.network.</span><span>onReq
uestFinished</span><span class="subdued">.addListener</span>(function(<span>Requ
est request</span>) <span class="subdued">{...}</span><span></span>); | |
| 451 </div> | |
| 452 <div class="description"> | |
| 453 <p>Fired when a network request is finished and all request data
are available.</p> | |
| 454 <!-- LISTENER PARAMETERS --> | |
| 455 <div> | |
| 456 <h4>Listener parameters</h4> | |
| 457 <dl> | |
| 458 <div> | |
| 459 <div> | |
| 460 <dt> | |
| 461 <var>request</var> | |
| 462 <em> | |
| 463 <!-- TYPE --> | |
| 464 <div style="display:inline"> | |
| 465 ( | |
| 466 <span id="typeTemplate"> | |
| 467 <span> | |
| 468 <a href="devtools.network.html#type-Request">Request</a> | |
| 469 </span> | |
| 470 </span> | |
| 471 ) | |
| 472 </div> | |
| 473 </em> | |
| 474 </dt> | |
| 475 <dd>Description of a network request in the form of a HAR entry. See H
AR specification for details.</dd> | |
| 476 <!-- OBJECT PROPERTIES --> | |
| 477 <!-- OBJECT METHODS --> | |
| 478 <!-- OBJECT EVENT FIELDS --> | |
| 479 <!-- FUNCTION PARAMETERS --> | |
| 480 </div> | |
| 481 </div> | |
| 482 </dl> | |
| 483 </div> | |
| 484 <!-- EXTRA PARAMETERS --> | |
| 485 <!-- LISTENER RETURN VALUE --> | |
| 486 <dl> | |
| 487 </dl> | |
| 488 </div> <!-- /description --> | |
| 489 <!-- /description --> | |
| 490 </div> <!-- /apiItem --> | |
| 491 </div> <!-- /apiGroup --> | |
| 492 <!-- TYPES --> | |
| 493 <div class="apiGroup"> | |
| 494 <a name="types"></a> | |
| 495 <h3 id="types">Types</h3> | |
| 496 <!-- iterates over all types --> | |
| 497 <div class="apiItem"> | |
| 498 <a name="type-Request"></a> | |
| 499 <h4>Request</h4> | |
| 500 <div> | |
| 501 <dt> | |
| 502 <em> | |
| 503 <!-- TYPE --> | |
| 504 <div style="display:inline"> | |
| 505 ( | |
| 506 <span id="typeTemplate"> | |
| 507 <span> | |
| 508 <span>object</span> | |
| 509 </span> | |
| 510 </span> | |
| 511 ) | |
| 512 </div> | |
| 513 </em> | |
| 514 </dt> | |
| 515 <dd>Represents a network request for a document resource (script, imag
e and so on). See HAR Specification for reference.</dd> | |
| 516 <!-- OBJECT PROPERTIES --> | |
| 517 <!-- OBJECT METHODS --> | |
| 518 <dd> | |
| 519 <div class="apiGroup"> | |
| 520 <a name="global-Request-methods"></a> | |
| 521 <h3>Methods of Request</h3> | |
| 522 <!-- iterates over all functions --> | |
| 523 <div class="apiItem"> | |
| 524 <a name="method-Request-getContent"></a> <!-- method-anchor --> | |
| 525 <h4>getContent</h4> | |
| 526 <div class="summary"> | |
| 527 <!-- Note: intentionally longer 80 columns --> | |
| 528 <span>request.getContent</span>(<span class="null"><span>funct
ion</span> | |
| 529 <var><span>callback</span></var></span>)</div> | |
| 530 <div class="description"> | |
| 531 <p>Returns content of the response body.</p> | |
| 532 <!-- PARAMETERS --> | |
| 533 <h4>Parameters</h4> | |
| 534 <dl> | |
| 535 <div> | |
| 536 <div> | |
| 537 <dt> | |
| 538 <var>callback</var> | |
| 539 <em> | |
| 540 <!-- TYPE --> | |
| 541 <div style="display:inline"> | |
| 542 ( | |
| 543 <span id="typeTemplate"> | |
| 544 <span> | |
| 545 <span>function</span> | |
| 546 </span> | |
| 547 </span> | |
| 548 ) | |
| 549 </div> | |
| 550 </em> | |
| 551 </dt> | |
| 552 <dd>A function that receives the response body when the request comple
tes.</dd> | |
| 553 <!-- OBJECT PROPERTIES --> | |
| 554 <!-- OBJECT METHODS --> | |
| 555 <!-- OBJECT EVENT FIELDS --> | |
| 556 <!-- FUNCTION PARAMETERS --> | |
| 557 </div> | |
| 558 </div> | |
| 559 </dl> | |
| 560 <!-- RETURNS --> | |
| 561 <dl> | |
| 562 </dl> | |
| 563 <!-- CALLBACK --> | |
| 564 <div> | |
| 565 <div> | |
| 566 <h4>Callback function</h4> | |
| 567 <p> | |
| 568 The <em>callback</em> parameter should specify a function | |
| 569 that looks like this: | |
| 570 </p> | |
| 571 <!-- Note: intentionally longer 80 columns --> | |
| 572 <pre>function(<span>string content, string encoding</span>) <s
pan class="subdued">{...}</span>;</pre> | |
| 573 <dl> | |
| 574 <div> | |
| 575 <div> | |
| 576 <dt> | |
| 577 <var>content</var> | |
| 578 <em> | |
| 579 <!-- TYPE --> | |
| 580 <div style="display:inline"> | |
| 581 ( | |
| 582 <span id="typeTemplate"> | |
| 583 <span> | |
| 584 <span>string</span> | |
| 585 </span> | |
| 586 </span> | |
| 587 ) | |
| 588 </div> | |
| 589 </em> | |
| 590 </dt> | |
| 591 <dd>Content of the response body (potentially encoded).</dd> | |
| 592 <!-- OBJECT PROPERTIES --> | |
| 593 <!-- OBJECT METHODS --> | |
| 594 <!-- OBJECT EVENT FIELDS --> | |
| 595 <!-- FUNCTION PARAMETERS --> | |
| 596 </div> | |
| 597 </div><div> | |
| 598 <div> | |
| 599 <dt> | |
| 600 <var>encoding</var> | |
| 601 <em> | |
| 602 <!-- TYPE --> | |
| 603 <div style="display:inline"> | |
| 604 ( | |
| 605 <span id="typeTemplate"> | |
| 606 <span> | |
| 607 <span>string</span> | |
| 608 </span> | |
| 609 </span> | |
| 610 ) | |
| 611 </div> | |
| 612 </em> | |
| 613 </dt> | |
| 614 <dd>Empty if content is not encoded, encoding name otherwise. Currentl
y, only base64 is supported.</dd> | |
| 615 <!-- OBJECT PROPERTIES --> | |
| 616 <!-- OBJECT METHODS --> | |
| 617 <!-- OBJECT EVENT FIELDS --> | |
| 618 <!-- FUNCTION PARAMETERS --> | |
| 619 </div> | |
| 620 </div> | |
| 621 </dl> | |
| 622 </div> | |
| 623 </div> | |
| 624 <!-- MIN_VERSION --> | |
| 625 </div> <!-- /description --> | |
| 626 </div> <!-- /apiItem --> | |
| 627 </div> | |
| 628 </dd> | |
| 629 <!-- OBJECT EVENT FIELDS --> | |
| 630 <!-- FUNCTION PARAMETERS --> | |
| 631 </div> | |
| 632 </div> <!-- /apiItem --> | |
| 633 </div> <!-- /apiGroup --> | |
| 634 </div> <!-- /apiPage --> | |
| 635 </div> <!-- /gc-pagecontent --> | |
| 636 </div> <!-- /g-section --> | |
| 637 </div> <!-- /codesiteContent --> | |
| 638 <div id="gc-footer" --=""> | |
| 639 <div class="text"> | |
| 640 <p> | |
| 641 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
| 642 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
| 643 Attribution 3.0 License</a>, and code samples are licensed under the | |
| 644 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
| 645 </p> | |
| 646 <p> | |
| 647 ©2011 Google | |
| 648 </p> | |
| 649 <!-- begin analytics --> | |
| 650 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> | |
| 651 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> | |
| 652 <script type="text/javascript"> | |
| 653 // chrome doc tracking | |
| 654 try { | |
| 655 var engdocs = _gat._getTracker("YT-10763712-2"); | |
| 656 engdocs._trackPageview(); | |
| 657 } catch(err) {} | |
| 658 // code.google.com site-wide tracking | |
| 659 try { | |
| 660 _uacct="UA-18071-1"; | |
| 661 _uanchor=1; | |
| 662 _uff=0; | |
| 663 urchinTracker(); | |
| 664 } | |
| 665 catch(e) {/* urchinTracker not available. */} | |
| 666 </script> | |
| 667 <!-- end analytics --> | |
| 668 </div> | |
| 669 </div> <!-- /gc-footer --> | |
| 670 </div> <!-- /gc-container --> | |
| 671 </body></html> | |
| OLD | NEW |