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