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="js/api_page_generator.js"></script> |
| 17 <script type="text/javascript" src="js/bootstrap.js"></script> |
| 18 <script type="text/javascript" src="js/sidebar.js"></script> |
| 19 <meta name="description" content="Documentation for the chrome.experimental.do
wnloads module, which is part of the Google Chrome extension APIs."><title>chro
me.experimental.downloads - Google Chrome Extensions - Google Code</title></head
> |
| 20 <body> <div id="devModeWarning" class="displayModeWarning"> |
| 21 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. |
| 22 </div> |
| 23 <div id="branchWarning" class="displayModeWarning"> |
| 24 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. |
| 25 It may not work with the stable release of Chrome.</span> |
| 26 <select id="branchChooser"> |
| 27 <option>Choose a different version... |
| 28 </option><option value="">Stable |
| 29 </option><option value="beta">Beta |
| 30 </option><option value="dev">Dev |
| 31 </option><option value="trunk">Trunk |
| 32 </option></select> |
| 33 </div> |
| 34 <div id="unofficialWarning" class="displayModeWarning"> |
| 35 <span>WARNING: This is unofficial documentation. It may not work with the |
| 36 current release of Chrome.</span> |
| 37 <button id="goToOfficialDocs">Go to the official docs</button> |
| 38 </div> |
| 39 <div id="gc-container" class="labs"> |
| 40 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> |
| 41 <!-- In particular, sub-templates that recurse, must be used by allowing |
| 42 jstemplate to make a copy of the template in this section which |
| 43 are not operated on by way of the jsskip="true" --> |
| 44 <!-- /SUBTEMPLATES --> |
| 45 <a id="top"></a> |
| 46 <div id="skipto"> |
| 47 <a href="#gc-pagecontent">Skip to page content</a> |
| 48 <a href="#gc-toc">Skip to main navigation</a> |
| 49 </div> |
| 50 <!-- API HEADER --> |
| 51 <table id="header" width="100%" cellspacing="0" border="0"> |
| 52 <tbody><tr> |
| 53 <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> |
| 54 <td valign="middle" width="100%" style="padding-left:0.6em;"> |
| 55 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> |
| 56 <div id="gsc-search-box"> |
| 57 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> |
| 58 <input type="hidden" name="ie" value="UTF-8"> |
| 59 <input type="text" name="q" value="" size="55"> |
| 60 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> |
| 61 <br> |
| 62 <span class="greytext">e.g. "page action" or "tabs"</span> |
| 63 </div> |
| 64 </form> |
| 65 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> |
| 66 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> |
| 67 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> |
| 68 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> |
| 69 </td> |
| 70 </tr> |
| 71 </tbody></table> |
| 72 <div id="codesiteContent" class=""> |
| 73 <a id="gc-topnav-anchor"></a> |
| 74 <div id="gc-topnav"> |
| 75 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> |
| 76 <ul id="home" class="gc-topnav-tabs"> |
| 77 <li id="home_link"> |
| 78 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> |
| 79 </li> |
| 80 <li id="docs_link"> |
| 81 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> |
| 82 </li> |
| 83 <li id="faq_link"> |
| 84 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> |
| 85 </li> |
| 86 <li id="samples_link"> |
| 87 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> |
| 88 </li> |
| 89 <li id="group_link"> |
| 90 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> |
| 91 </li> |
| 92 <li id="so_link"> |
| 93 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> |
| 94 </li> |
| 95 </ul> |
| 96 </div> <!-- end gc-topnav --> |
| 97 <div class="g-section g-tpl-170"> |
| 98 <!-- SIDENAV --> |
| 99 <div class="g-unit g-first" id="gc-toc"> |
| 100 <ul> |
| 101 <li><a href="getstarted.html">Getting Started</a></li> |
| 102 <li><a href="overview.html">Overview</a></li> |
| 103 <li><a href="whats_new.html">What's New?</a></li> |
| 104 <li><h2><a href="devguide.html">Developer's Guide</a></h2> |
| 105 <ul> |
| 106 <li>Browser UI |
| 107 <ul> |
| 108 <li><a href="browserAction.html">Browser Actions</a></li> |
| 109 <li><a href="contextMenus.html">Context Menus</a></li> |
| 110 <li><a href="notifications.html">Desktop Notifications</a></li
> |
| 111 <li><a href="omnibox.html">Omnibox</a></li> |
| 112 <li><a href="options.html">Options Pages</a></li> |
| 113 <li><a href="override.html">Override Pages</a></li> |
| 114 <li><a href="pageAction.html">Page Actions</a></li> |
| 115 </ul> |
| 116 </li> |
| 117 <li>Browser Interaction |
| 118 <ul> |
| 119 <li><a href="bookmarks.html">Bookmarks</a></li> |
| 120 <li><a href="cookies.html">Cookies</a></li> |
| 121 <li><a href="devtools.html">Developer Tools</a></li> |
| 122 <li><a href="events.html">Events</a></li> |
| 123 <li><a href="history.html">History</a></li> |
| 124 <li><a href="management.html">Management</a></li> |
| 125 <li><a href="tabs.html">Tabs</a></li> |
| 126 <li><a href="windows.html">Windows</a></li> |
| 127 </ul> |
| 128 </li> |
| 129 <li>Implementation |
| 130 <ul> |
| 131 <li><a href="a11y.html">Accessibility</a></li> |
| 132 <li><a href="background_pages.html">Background Pages</a></li> |
| 133 <li><a href="content_scripts.html">Content Scripts</a></li> |
| 134 <li><a href="xhr.html">Cross-Origin XHR</a></li> |
| 135 <li><a href="i18n.html">Internationalization</a></li> |
| 136 <li><a href="messaging.html">Message Passing</a></li> |
| 137 <li><a href="permissions.html">Optional Permissions</a></li> |
| 138 <li><a href="npapi.html">NPAPI Plugins</a></li> |
| 139 </ul> |
| 140 </li> |
| 141 <li>Finishing |
| 142 <ul> |
| 143 <li><a href="hosting.html">Hosting</a></li> |
| 144 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> |
| 145 </ul> |
| 146 </li> |
| 147 </ul> |
| 148 </li> |
| 149 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> |
| 150 <li><h2><a href="tutorials.html">Tutorials</a></h2> |
| 151 <ul> |
| 152 <li><a href="tut_debugging.html">Debugging</a></li> |
| 153 <li><a href="tut_analytics.html">Google Analytics</a></li> |
| 154 <li><a href="tut_oauth.html">OAuth</a></li> |
| 155 </ul> |
| 156 </li> |
| 157 <li><h2>Reference</h2> |
| 158 <ul> |
| 159 <li>Formats |
| 160 <ul> |
| 161 <li><a href="manifest.html">Manifest Files</a></li> |
| 162 <li><a href="match_patterns.html">Match Patterns</a></li> |
| 163 </ul> |
| 164 </li> |
| 165 <li><a href="permission_warnings.html">Permission Warnings</a></li
> |
| 166 <li><a href="api_index.html">chrome.* APIs</a></li> |
| 167 <li><a href="api_other.html">Other APIs</a></li> |
| 168 </ul> |
| 169 </li> |
| 170 <li><h2><a href="samples.html">Samples</a></h2></li> |
| 171 <div class="line"> </div> |
| 172 <li><h2>More</h2> |
| 173 <ul> |
| 174 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> |
| 175 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> |
| 176 <li><a href="themes.html">Themes</a></li> |
| 177 </ul> |
| 178 </li> |
| 179 </ul> |
| 180 </div> |
| 181 <script> |
| 182 initToggles(); |
| 183 </script> |
| 184 <div class="g-unit" id="gc-pagecontent"> |
| 185 <div id="pageTitle"> |
| 186 <h1 class="page_title">chrome.experimental.downloads</h1> |
| 187 </div> |
| 188 <!-- TABLE OF CONTENTS --> |
| 189 <div id="toc"> |
| 190 <h2>Contents</h2> |
| 191 <ol> |
| 192 <li> |
| 193 <a href="#apiReference">API reference: chrome.experimental.downl
oads</a> |
| 194 <ol> |
| 195 <li> |
| 196 <a href="#properties">Properties</a> |
| 197 <ol> |
| 198 <li> |
| 199 <a href="#property-ERROR_GENERIC">ERROR_GENERIC</a> |
| 200 </li><li> |
| 201 <a href="#property-ERROR_INVALID_URL">ERROR_INVALID_URL</a> |
| 202 </li> |
| 203 </ol> |
| 204 </li> |
| 205 <li> |
| 206 <a href="#global-methods">Methods</a> |
| 207 <ol> |
| 208 <li> |
| 209 <a href="#method-download">download</a> |
| 210 </li> |
| 211 </ol> |
| 212 </li> |
| 213 <li> |
| 214 <a href="#global-events">Events</a> |
| 215 <ol> |
| 216 </ol> |
| 217 </li> |
| 218 <li> |
| 219 <a href="#types">Types</a> |
| 220 <ol> |
| 221 <li> |
| 222 <a href="#type-HttpHeaders">HttpHeaders</a> |
| 223 <ol> |
| 224 </ol> |
| 225 </li> |
| 226 </ol> |
| 227 </li> |
| 228 </ol> |
| 229 </li> |
| 230 </ol> |
| 231 </div> |
| 232 <!-- /TABLE OF CONTENTS --> |
| 233 <!-- Standard content lead-in for experimental API pages --> |
| 234 <p id="classSummary"> |
| 235 For information on how to use experimental APIs, see the <a href="expe
rimental.html">chrome.experimental.* APIs</a> page. |
| 236 </p> |
| 237 <!-- STATIC CONTENT PLACEHOLDER --> |
| 238 <div id="static">The downloads API allows you to programmatically initia
te downloads, examine and monitor properties of downloads, and manipulate downlo
ads. |
| 239 </div> |
| 240 <!-- API PAGE --> |
| 241 <div class="apiPage"> |
| 242 <a name="apiReference"></a> |
| 243 <h2>API reference: chrome.experimental.downloads</h2> |
| 244 <!-- PROPERTIES --> |
| 245 <div class="apiGroup"> |
| 246 <a name="properties"></a> |
| 247 <h3 id="properties">Properties</h3> |
| 248 <div> |
| 249 <a name="property-ERROR_GENERIC"></a> |
| 250 <h4>ERROR_GENERIC</h4> |
| 251 <div class="summary"> |
| 252 <!-- Note: intentionally longer 80 columns --> |
| 253 <span>chrome.experimental.downloads.</span><span>ERROR_GENERIC</
span> |
| 254 </div> |
| 255 <div> |
| 256 <dt> |
| 257 <var>ERROR_GENERIC</var> |
| 258 <em> |
| 259 <!-- TYPE --> |
| 260 <div style="display:inline"> |
| 261 ( |
| 262 <span id="typeTemplate"> |
| 263 <code>"I'm afraid I can't do that."</code> |
| 264 </span> |
| 265 ) |
| 266 </div> |
| 267 </em> |
| 268 </dt> |
| 269 <dd>Generic error.</dd> |
| 270 <!-- OBJECT PROPERTIES --> |
| 271 <!-- OBJECT METHODS --> |
| 272 <!-- OBJECT EVENT FIELDS --> |
| 273 <!-- FUNCTION PARAMETERS --> |
| 274 </div> |
| 275 </div><div> |
| 276 <a name="property-ERROR_INVALID_URL"></a> |
| 277 <h4>ERROR_INVALID_URL</h4> |
| 278 <div class="summary"> |
| 279 <!-- Note: intentionally longer 80 columns --> |
| 280 <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_U
RL</span> |
| 281 </div> |
| 282 <div> |
| 283 <dt> |
| 284 <var>ERROR_INVALID_URL</var> |
| 285 <em> |
| 286 <!-- TYPE --> |
| 287 <div style="display:inline"> |
| 288 ( |
| 289 <span id="typeTemplate"> |
| 290 <code>"Invalid URL."</code> |
| 291 </span> |
| 292 ) |
| 293 </div> |
| 294 </em> |
| 295 </dt> |
| 296 <dd>The URL was invalid.</dd> |
| 297 <!-- OBJECT PROPERTIES --> |
| 298 <!-- OBJECT METHODS --> |
| 299 <!-- OBJECT EVENT FIELDS --> |
| 300 <!-- FUNCTION PARAMETERS --> |
| 301 </div> |
| 302 </div> |
| 303 </div> <!-- /apiGroup --> |
| 304 <!-- METHODS --> |
| 305 <div id="methodsTemplate" class="apiGroup"> |
| 306 <a name="global-methods"></a> |
| 307 <h3>Methods</h3> |
| 308 <!-- iterates over all functions --> |
| 309 <div class="apiItem"> |
| 310 <a name="method-download"></a> <!-- method-anchor --> |
| 311 <h4>download</h4> |
| 312 <div class="summary"> |
| 313 <!-- Note: intentionally longer 80 columns --> |
| 314 <span>chrome.experimental.downloads.download</span>(<span clas
s="null"><span>object</span> |
| 315 <var><span>options</span></var></span><span class="optiona
l"><span>, </span><span>function</span> |
| 316 <var><span>callback</span></var></span>)</div> |
| 317 <div class="description"> |
| 318 <p>Download a URL. If the URL uses the HTTP[S] protocol, then th
e request will include all cookies currently set for its hostname. If the downlo
ad started successfully, |callback| will be called with the new DownloadItem’s |
id|. If there was an error starting the download, then |callback| will be called
with |downloadId|=undefined and chrome.extension.lastError will be set. If the
URL’s hostname is not specified in the |permissions| section of the extension’s
manifest, then the |chrome.extensions.lastError| object will indicate that the e
xtension does not have permission to access that hostname.</p> |
| 319 <!-- PARAMETERS --> |
| 320 <h4>Parameters</h4> |
| 321 <dl> |
| 322 <div> |
| 323 <div> |
| 324 <dt> |
| 325 <var>options</var> |
| 326 <em> |
| 327 <!-- TYPE --> |
| 328 <div style="display:inline"> |
| 329 ( |
| 330 <span id="typeTemplate"> |
| 331 <span> |
| 332 <span>object</span> |
| 333 </span> |
| 334 </span> |
| 335 ) |
| 336 </div> |
| 337 </em> |
| 338 </dt> |
| 339 <dd class="todo"> |
| 340 Undocumented. |
| 341 </dd> |
| 342 <!-- OBJECT PROPERTIES --> |
| 343 <dd> |
| 344 <dl> |
| 345 <div> |
| 346 <div> |
| 347 <dt> |
| 348 <var>url</var> |
| 349 <em> |
| 350 <!-- TYPE --> |
| 351 <div style="display:inline"> |
| 352 ( |
| 353 <span id="typeTemplate"> |
| 354 <span> |
| 355 <span>string</span> |
| 356 </span> |
| 357 </span> |
| 358 ) |
| 359 </div> |
| 360 </em> |
| 361 </dt> |
| 362 <dd>The URL to download.</dd> |
| 363 <!-- OBJECT PROPERTIES --> |
| 364 <!-- OBJECT METHODS --> |
| 365 <!-- OBJECT EVENT FIELDS --> |
| 366 <!-- FUNCTION PARAMETERS --> |
| 367 </div> |
| 368 </div><div> |
| 369 <div> |
| 370 <dt> |
| 371 <var>filename</var> |
| 372 <em> |
| 373 <!-- TYPE --> |
| 374 <div style="display:inline"> |
| 375 ( |
| 376 <span class="optional">optional</span> |
| 377 <span id="typeTemplate"> |
| 378 <span> |
| 379 <span>string</span> |
| 380 </span> |
| 381 </span> |
| 382 ) |
| 383 </div> |
| 384 </em> |
| 385 </dt> |
| 386 <dd>A file path relative to the Downloads directory to contain the dow
nloaded file.</dd> |
| 387 <!-- OBJECT PROPERTIES --> |
| 388 <!-- OBJECT METHODS --> |
| 389 <!-- OBJECT EVENT FIELDS --> |
| 390 <!-- FUNCTION PARAMETERS --> |
| 391 </div> |
| 392 </div><div> |
| 393 <div> |
| 394 <dt> |
| 395 <var>saveAs</var> |
| 396 <em> |
| 397 <!-- TYPE --> |
| 398 <div style="display:inline"> |
| 399 ( |
| 400 <span class="optional">optional</span> |
| 401 <span id="typeTemplate"> |
| 402 <span> |
| 403 <span>boolean</span> |
| 404 </span> |
| 405 </span> |
| 406 ) |
| 407 </div> |
| 408 </em> |
| 409 </dt> |
| 410 <dd>Use a file-chooser to allow the user to select a filename.</dd> |
| 411 <!-- OBJECT PROPERTIES --> |
| 412 <!-- OBJECT METHODS --> |
| 413 <!-- OBJECT EVENT FIELDS --> |
| 414 <!-- FUNCTION PARAMETERS --> |
| 415 </div> |
| 416 </div><div> |
| 417 <div> |
| 418 <dt> |
| 419 <var>method</var> |
| 420 <em> |
| 421 <!-- TYPE --> |
| 422 <div style="display:inline"> |
| 423 ( |
| 424 <span class="optional">optional</span> |
| 425 <span class="enum">enumerated</span> |
| 426 <span id="typeTemplate"> |
| 427 <span> |
| 428 <span>string</span> |
| 429 <span>["GET", "POST"]</span> |
| 430 </span> |
| 431 </span> |
| 432 ) |
| 433 </div> |
| 434 </em> |
| 435 </dt> |
| 436 <dd>The HTTP method to use if the URL uses the HTTP[S] protocol.</dd> |
| 437 <!-- OBJECT PROPERTIES --> |
| 438 <!-- OBJECT METHODS --> |
| 439 <!-- OBJECT EVENT FIELDS --> |
| 440 <!-- FUNCTION PARAMETERS --> |
| 441 </div> |
| 442 </div><div> |
| 443 <div> |
| 444 <dt> |
| 445 <var>headers</var> |
| 446 <em> |
| 447 <!-- TYPE --> |
| 448 <div style="display:inline"> |
| 449 ( |
| 450 <span class="optional">optional</span> |
| 451 <span id="typeTemplate"> |
| 452 <span> |
| 453 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</
a> |
| 454 </span> |
| 455 </span> |
| 456 ) |
| 457 </div> |
| 458 </em> |
| 459 </dt> |
| 460 <dd>Extra HTTP headers to send with the request if the URL uses the HT
TP[s] protocol, restricted to those allowed by XMLHttpRequest.</dd> |
| 461 <!-- OBJECT PROPERTIES --> |
| 462 <!-- OBJECT METHODS --> |
| 463 <!-- OBJECT EVENT FIELDS --> |
| 464 <!-- FUNCTION PARAMETERS --> |
| 465 </div> |
| 466 </div><div> |
| 467 <div> |
| 468 <dt> |
| 469 <var>body</var> |
| 470 <em> |
| 471 <!-- TYPE --> |
| 472 <div style="display:inline"> |
| 473 ( |
| 474 <span class="optional">optional</span> |
| 475 <span id="typeTemplate"> |
| 476 <span> |
| 477 <span>string</span> |
| 478 </span> |
| 479 </span> |
| 480 ) |
| 481 </div> |
| 482 </em> |
| 483 </dt> |
| 484 <dd>post body</dd> |
| 485 <!-- OBJECT PROPERTIES --> |
| 486 <!-- OBJECT METHODS --> |
| 487 <!-- OBJECT EVENT FIELDS --> |
| 488 <!-- FUNCTION PARAMETERS --> |
| 489 </div> |
| 490 </div> |
| 491 </dl> |
| 492 </dd> |
| 493 <!-- OBJECT METHODS --> |
| 494 <!-- OBJECT EVENT FIELDS --> |
| 495 <!-- FUNCTION PARAMETERS --> |
| 496 </div> |
| 497 </div><div> |
| 498 <div> |
| 499 <dt> |
| 500 <var>callback</var> |
| 501 <em> |
| 502 <!-- TYPE --> |
| 503 <div style="display:inline"> |
| 504 ( |
| 505 <span class="optional">optional</span> |
| 506 <span id="typeTemplate"> |
| 507 <span> |
| 508 <span>function</span> |
| 509 </span> |
| 510 </span> |
| 511 ) |
| 512 </div> |
| 513 </em> |
| 514 </dt> |
| 515 <dd class="todo"> |
| 516 Undocumented. |
| 517 </dd> |
| 518 <!-- OBJECT PROPERTIES --> |
| 519 <!-- OBJECT METHODS --> |
| 520 <!-- OBJECT EVENT FIELDS --> |
| 521 <!-- FUNCTION PARAMETERS --> |
| 522 </div> |
| 523 </div> |
| 524 </dl> |
| 525 <!-- RETURNS --> |
| 526 <dl> |
| 527 </dl> |
| 528 <!-- CALLBACK --> |
| 529 <div> |
| 530 <div> |
| 531 <h4>Callback function</h4> |
| 532 <p> |
| 533 If you specify the <em>callback</em> parameter, it should |
| 534 specify a function that looks like this: |
| 535 </p> |
| 536 <!-- Note: intentionally longer 80 columns --> |
| 537 <pre>function(<span>integer id</span>) <span class="subdued">{
...}</span>;</pre> |
| 538 <dl> |
| 539 <div> |
| 540 <div> |
| 541 <dt> |
| 542 <var>id</var> |
| 543 <em> |
| 544 <!-- TYPE --> |
| 545 <div style="display:inline"> |
| 546 ( |
| 547 <span id="typeTemplate"> |
| 548 <span> |
| 549 <span>integer</span> |
| 550 </span> |
| 551 </span> |
| 552 ) |
| 553 </div> |
| 554 </em> |
| 555 </dt> |
| 556 <dd class="todo"> |
| 557 Undocumented. |
| 558 </dd> |
| 559 <!-- OBJECT PROPERTIES --> |
| 560 <!-- OBJECT METHODS --> |
| 561 <!-- OBJECT EVENT FIELDS --> |
| 562 <!-- FUNCTION PARAMETERS --> |
| 563 </div> |
| 564 </div> |
| 565 </dl> |
| 566 </div> |
| 567 </div> |
| 568 <!-- MIN_VERSION --> |
| 569 </div> <!-- /description --> |
| 570 </div> <!-- /apiItem --> |
| 571 </div> <!-- /apiGroup --> |
| 572 <!-- EVENTS --> |
| 573 <div id="eventsTemplate" class="apiGroup"> |
| 574 <a name="global-events"></a> |
| 575 <h3>Events</h3> |
| 576 <!-- iterates over all events --> |
| 577 <!-- /apiItem --> |
| 578 </div> <!-- /apiGroup --> |
| 579 <!-- TYPES --> |
| 580 <div class="apiGroup"> |
| 581 <a name="types"></a> |
| 582 <h3 id="types">Types</h3> |
| 583 <!-- iterates over all types --> |
| 584 <div class="apiItem"> |
| 585 <a name="type-HttpHeaders"></a> |
| 586 <h4>HttpHeaders</h4> |
| 587 <div> |
| 588 <dt> |
| 589 <em> |
| 590 <!-- TYPE --> |
| 591 <div style="display:inline"> |
| 592 ( |
| 593 <span id="typeTemplate"> |
| 594 <span> |
| 595 <span> |
| 596 array of <span><span> |
| 597 <span> |
| 598 <span>object</span> |
| 599 </span> |
| 600 </span></span> |
| 601 </span> |
| 602 </span> |
| 603 </span> |
| 604 ) |
| 605 </div> |
| 606 </em> |
| 607 </dt> |
| 608 <dd>An array of HTTP headers. Each header is represented as a dictiona
ry containing the keys <code>name</code> and either <code>value</code> or <code>
binaryValue</code>.</dd> |
| 609 <!-- OBJECT PROPERTIES --> |
| 610 <dd> |
| 611 <dl> |
| 612 <div> |
| 613 <div> |
| 614 <dt> |
| 615 <var>name</var> |
| 616 <em> |
| 617 <!-- TYPE --> |
| 618 <div style="display:inline"> |
| 619 ( |
| 620 <span id="typeTemplate"> |
| 621 <span> |
| 622 <span>string</span> |
| 623 </span> |
| 624 </span> |
| 625 ) |
| 626 </div> |
| 627 </em> |
| 628 </dt> |
| 629 <dd>Name of the HTTP header.</dd> |
| 630 <!-- OBJECT PROPERTIES --> |
| 631 <!-- OBJECT METHODS --> |
| 632 <!-- OBJECT EVENT FIELDS --> |
| 633 <!-- FUNCTION PARAMETERS --> |
| 634 </div> |
| 635 </div><div> |
| 636 <div> |
| 637 <dt> |
| 638 <var>value</var> |
| 639 <em> |
| 640 <!-- TYPE --> |
| 641 <div style="display:inline"> |
| 642 ( |
| 643 <span class="optional">optional</span> |
| 644 <span id="typeTemplate"> |
| 645 <span> |
| 646 <span>string</span> |
| 647 </span> |
| 648 </span> |
| 649 ) |
| 650 </div> |
| 651 </em> |
| 652 </dt> |
| 653 <dd>Value of the HTTP header if it can be represented by UTF-8.</dd> |
| 654 <!-- OBJECT PROPERTIES --> |
| 655 <!-- OBJECT METHODS --> |
| 656 <!-- OBJECT EVENT FIELDS --> |
| 657 <!-- FUNCTION PARAMETERS --> |
| 658 </div> |
| 659 </div><div> |
| 660 <div> |
| 661 <dt> |
| 662 <var>binaryValue</var> |
| 663 <em> |
| 664 <!-- TYPE --> |
| 665 <div style="display:inline"> |
| 666 ( |
| 667 <span class="optional">optional</span> |
| 668 <span id="typeTemplate"> |
| 669 <span> |
| 670 <span> |
| 671 array of <span><span> |
| 672 <span> |
| 673 <span>integer</span> |
| 674 </span> |
| 675 </span></span> |
| 676 </span> |
| 677 </span> |
| 678 </span> |
| 679 ) |
| 680 </div> |
| 681 </em> |
| 682 </dt> |
| 683 <dd>Value of the HTTP header if it cannot be represented by UTF-8, sto
red as individual byte values (0..255).</dd> |
| 684 <!-- OBJECT PROPERTIES --> |
| 685 <!-- OBJECT METHODS --> |
| 686 <!-- OBJECT EVENT FIELDS --> |
| 687 <!-- FUNCTION PARAMETERS --> |
| 688 </div> |
| 689 </div> |
| 690 </dl> |
| 691 </dd> |
| 692 <!-- OBJECT METHODS --> |
| 693 <!-- OBJECT EVENT FIELDS --> |
| 694 <!-- FUNCTION PARAMETERS --> |
| 695 </div> |
| 696 </div> <!-- /apiItem --> |
| 697 </div> <!-- /apiGroup --> |
| 698 </div> <!-- /apiPage --> |
| 699 </div> <!-- /gc-pagecontent --> |
| 700 </div> <!-- /g-section --> |
| 701 </div> <!-- /codesiteContent --> |
| 702 <div id="gc-footer" --=""> |
| 703 <div class="text"> |
| 704 <p> |
| 705 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, |
| 706 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons |
| 707 Attribution 3.0 License</a>, and code samples are licensed under the |
| 708 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. |
| 709 </p> |
| 710 <p> |
| 711 ©2011 Google |
| 712 </p> |
| 713 <!-- begin analytics --> |
| 714 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> |
| 715 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> |
| 716 <script type="text/javascript"> |
| 717 // chrome doc tracking |
| 718 try { |
| 719 var engdocs = _gat._getTracker("YT-10763712-2"); |
| 720 engdocs._trackPageview(); |
| 721 } catch(err) {} |
| 722 // code.google.com site-wide tracking |
| 723 try { |
| 724 _uacct="UA-18071-1"; |
| 725 _uanchor=1; |
| 726 _uff=0; |
| 727 urchinTracker(); |
| 728 } |
| 729 catch(e) {/* urchinTracker not available. */} |
| 730 </script> |
| 731 <!-- end analytics --> |
| 732 </div> |
| 733 </div> <!-- /gc-footer --> |
| 734 </div> <!-- /gc-container --> |
| 735 </body></html> |
OLD | NEW |