chrome/common/extensions/docs/experimental.downloads.html - Issue 9617010: Move chrome.downloads out of experimental to dev

Side by Side Diff: chrome/common/extensions/docs/experimental.downloads.html

Issue 9617010: Move chrome.downloads out of experimental to dev (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: merge Created 8 years, 6 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View unified diff | Download patch | Annotate | Revision Log

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.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 >

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.experimental.downloads</h1>

189 </div>

190 <!-- TABLE OF CONTENTS -->

191 <div id="toc">

192 <h2>Contents</h2>

193 <ol>

194 <li>

195 <a href="#manifest">Manifest</a>

196 <ol>

197 </ol>

198 </li><li>

199 <a href="#examples"> Examples </a>

200 <ol>

201 </ol>

202 </li>

203 <li>

204 <a href="#apiReference">API reference: chrome.experimental.downl oads</a>

205 <ol>

206 <li>

207 <a href="#properties">Properties</a>

208 <ol>

209 <li>

210 <a href="#property-ERROR_GENERIC">ERROR_GENERIC</a>

211 </li><li>

212 <a href="#property-ERROR_INVALID_URL">ERROR_INVALID_URL</a>

213 </li>

214 </ol>

215 </li>

216 <li>

217 <a href="#global-methods">Methods</a>

218 <ol>

219 <li>

220 <a href="#method-download">download</a>

221 </li>

222 </ol>

223 </li>

224 <li>

225 <a href="#types">Types</a>

226 <ol>

227 <li>

228 <a href="#type-HttpHeaders">HttpHeaders</a>

229 <ol>

230 </ol>

231 </li>

232 </ol>

233 </li>

234 </ol>

235 </li>

236 </ol>

237 </div>

238 <!-- /TABLE OF CONTENTS -->

239 <!-- Standard content lead-in for experimental API pages -->

240 <p id="classSummary">

241 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.

242 </p>

243 <!-- STATIC CONTENT PLACEHOLDER -->

244 <div id="static"><p>The downloads API allows you to programmatically ini tiate downloads. In the

245 future, you will also be able to monitor and manipulate downloads.</p>

246 <h2 id="manifest">Manifest</h2>

247 <p>The downloads API is currently experimental, so you must declare the

248 "experimental" permission to use it. Also, you must specify the hostname of any

249 URLs to be downloaded. For example:</p>

250 <pre>{

251 "name": "Download Selected Links",

252 "description": "Select links on a page and download them.",

253 "version": "0.1",

254 "permissions": [

255 "experimental", "http:///", "https:///"

256 ]

257 }</pre>

258 <p>If the URL’s hostname is not specified in the permissions, then

259 <a href="extension.html#property-lastError">chrome.extension.lastError</a>

260 will indicate that the extension does not have permission to access that

261 hostname. <a href="#properties">downloads.ERROR_*</a> are some of the errors

262 that may be returned.</p>

263 <h2 id="examples"> Examples </h2>

264 <p>You can find simple examples of using the downloads module in the

265 <a href="http://src.chromium.org/viewvc/chrome/trunk/src/chrome/common/extension s/docs/examples/api/downloads/">examples/api/downloads</a>

266 directory. For other examples and for help in viewing the source code, see

267 <a href="samples.html">Samples</a>.</p>

268 </div>

269 <!-- API PAGE -->

270 <div class="apiPage">

271 <a name="apiReference"></a>

272 <h2>API reference: chrome.experimental.downloads</h2>

273 <!-- PROPERTIES -->

274 <div class="apiGroup">

275 <a name="properties"></a>

276 <h3 id="properties">Properties</h3>

277 <div>

278 <a name="property-ERROR_GENERIC"></a>

279 <h4>ERROR_GENERIC</h4>

280 <div class="summary">

281 <!-- Note: intentionally longer 80 columns -->

282 <span>chrome.experimental.downloads.</span><span>ERROR_GENERIC</ span>

283 </div>

284 <div>

285 <dt>

286 <var>ERROR_GENERIC</var>

287 <em>

288 <!-- TYPE -->

289 <div style="display:inline">

290 (

291 <span id="typeTemplate">

292 <code>"I'm afraid I can't do that."</code>

293 </span>

294 )

295 </div>

296 </em>

297 </dt>

298 <dd>Generic error.</dd>

299 <!-- OBJECT PROPERTIES -->

300 <!-- OBJECT METHODS -->

301 <!-- OBJECT EVENT FIELDS -->

302 <!-- FUNCTION PARAMETERS -->

303 </div>

304 </div><div>

305 <a name="property-ERROR_INVALID_URL"></a>

306 <h4>ERROR_INVALID_URL</h4>

307 <div class="summary">

308 <!-- Note: intentionally longer 80 columns -->

309 <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_U RL</span>

310 </div>

311 <div>

312 <dt>

313 <var>ERROR_INVALID_URL</var>

314 <em>

315 <!-- TYPE -->

316 <div style="display:inline">

317 (

318 <span id="typeTemplate">

319 <code>"Invalid URL."</code>

320 </span>

321 )

322 </div>

323 </em>

324 </dt>

325 <dd>The URL was invalid.</dd>

326 <!-- OBJECT PROPERTIES -->

327 <!-- OBJECT METHODS -->

328 <!-- OBJECT EVENT FIELDS -->

329 <!-- FUNCTION PARAMETERS -->

330 </div>

331 </div>

332 </div> <!-- /apiGroup -->

333 <!-- METHODS -->

334 <div id="methodsTemplate" class="apiGroup">

335 <a name="global-methods"></a>

336 <h3>Methods</h3>

337 <!-- iterates over all functions -->

338 <div class="apiItem">

339 <a name="method-download"></a> <!-- method-anchor -->

340 <h4>download</h4>

341 <div class="summary">

342 <!-- Note: intentionally longer 80 columns -->

343 <span>chrome.experimental.downloads.download</span>(<span clas s="null"><span>object</span>

344 <var><span>options</span></var></span><span class="optiona l"><span>, </span><span>function</span>

345 <var><span>callback</span></var></span>)</div>

346 <div class="description">

347 <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 both <code >filename</code> and <code>saveAs</code> are specified, then the Save As dialog will be displayed, pre-populated with the specified <code>filename</code>. If th e download started successfully, <code>callback</code> will be called with the n ew DownloadItem’s <code>downloadId</code>. If there was an error starting the do wnload, then <code>callback</code> will be called with <code>downloadId=undefine d</code> and <a href="extension.html#property-lastError">chrome.extension.lastEr ror</a> will be set to either one of the <code>ERROR_</code> constants defined above or another descriptive string. The error strings are not guaranteed to rem ain backwards compatible between releases. You must not parse it, though you may compare it to one of the ERROR_ constants defined above and conditionalize on that comparison.</p>

348 <!-- PARAMETERS -->

349 <h4>Parameters</h4>

350 <dl>

351 <div>

352 <div>

353 <dt>

354 <var>options</var>

355 <em>

356 <!-- TYPE -->

357 <div style="display:inline">

358 (

359 <span id="typeTemplate">

360 <span>

361 <span>object</span>

362 </span>

363 </span>

364 )

365 </div>

366 </em>

367 </dt>

368 <dd class="todo">

369 Undocumented.

370 </dd>

371 <!-- OBJECT PROPERTIES -->

372 <dd>

373 <dl>

374 <div>

375 <div>

376 <dt>

377 <var>url</var>

378 <em>

379 <!-- TYPE -->

380 <div style="display:inline">

381 (

382 <span id="typeTemplate">

383 <span>

384 <span>string</span>

385 </span>

386 </span>

387 )

388 </div>

389 </em>

390 </dt>

391 <dd>The URL to download.</dd>

392 <!-- OBJECT PROPERTIES -->

393 <!-- OBJECT METHODS -->

394 <!-- OBJECT EVENT FIELDS -->

395 <!-- FUNCTION PARAMETERS -->

396 </div>

397 </div><div>

398 <div>

399 <dt>

400 <var>filename</var>

401 <em>

402 <!-- TYPE -->

403 <div style="display:inline">

404 (

405 <span class="optional">optional</span>

406 <span id="typeTemplate">

407 <span>

408 <span>string</span>

409 </span>

410 </span>

411 )

412 </div>

413 </em>

414 </dt>

415 <dd>A file path relative to the Downloads directory to contain the dow nloaded file. For now, sub-directories are not allowed, so this string may not c ontain either forward slashes or back-slashes. Sub-directories will be implement ed soon.</dd>

416 <!-- OBJECT PROPERTIES -->

417 <!-- OBJECT METHODS -->

418 <!-- OBJECT EVENT FIELDS -->

419 <!-- FUNCTION PARAMETERS -->

420 </div>

421 </div><div>

422 <div>

423 <dt>

424 <var>saveAs</var>

425 <em>

426 <!-- TYPE -->

427 <div style="display:inline">

428 (

429 <span class="optional">optional</span>

430 <span id="typeTemplate">

431 <span>

432 <span>boolean</span>

433 </span>

434 </span>

435 )

436 </div>

437 </em>

438 </dt>

439 <dd>Use a file-chooser to allow the user to select a filename.</dd>

440 <!-- OBJECT PROPERTIES -->

441 <!-- OBJECT METHODS -->

442 <!-- OBJECT EVENT FIELDS -->

443 <!-- FUNCTION PARAMETERS -->

444 </div>

445 </div><div>

446 <div>

447 <dt>

448 <var>method</var>

449 <em>

450 <!-- TYPE -->

451 <div style="display:inline">

452 (

453 <span class="optional">optional</span>

454 <span class="enum">enumerated</span>

455 <span id="typeTemplate">

456 <span>

457 <span>string</span>

458 <span>["GET", "POST"]</span>

459 </span>

460 </span>

461 )

462 </div>

463 </em>

464 </dt>

465 <dd>The HTTP method to use if the URL uses the HTTP[S] protocol.</dd>

466 <!-- OBJECT PROPERTIES -->

467 <!-- OBJECT METHODS -->

468 <!-- OBJECT EVENT FIELDS -->

469 <!-- FUNCTION PARAMETERS -->

470 </div>

471 </div><div>

472 <div>

473 <dt>

474 <var>headers</var>

475 <em>

476 <!-- TYPE -->

477 <div style="display:inline">

478 (

479 <span class="optional">optional</span>

480 <span id="typeTemplate">

481 <span>

482 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>

483 </span>

484 </span>

485 )

486 </div>

487 </em>

488 </dt>

489 <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>

490 <!-- OBJECT PROPERTIES -->

491 <!-- OBJECT METHODS -->

492 <!-- OBJECT EVENT FIELDS -->

493 <!-- FUNCTION PARAMETERS -->

494 </div>

495 </div><div>

496 <div>

497 <dt>

498 <var>body</var>

499 <em>

500 <!-- TYPE -->

501 <div style="display:inline">

502 (

503 <span class="optional">optional</span>

504 <span id="typeTemplate">

505 <span>

506 <span>string</span>

507 </span>

508 </span>

509 )

510 </div>

511 </em>

512 </dt>

513 <dd>post body</dd>

514 <!-- OBJECT PROPERTIES -->

515 <!-- OBJECT METHODS -->

516 <!-- OBJECT EVENT FIELDS -->

517 <!-- FUNCTION PARAMETERS -->

518 </div>

519 </div>

520 </dl>

521 </dd>

522 <!-- OBJECT METHODS -->

523 <!-- OBJECT EVENT FIELDS -->

524 <!-- FUNCTION PARAMETERS -->

525 </div>

526 </div><div>

527 <div>

528 <dt>

529 <var>callback</var>

530 <em>

531 <!-- TYPE -->

532 <div style="display:inline">

533 (

534 <span class="optional">optional</span>

535 <span id="typeTemplate">

536 <span>

537 <span>function</span>

538 </span>

539 </span>

540 )

541 </div>

542 </em>

543 </dt>

544 <dd class="todo">

545 Undocumented.

546 </dd>

547 <!-- OBJECT PROPERTIES -->

548 <!-- OBJECT METHODS -->

549 <!-- OBJECT EVENT FIELDS -->

550 <!-- FUNCTION PARAMETERS -->

551 </div>

552 </div>

553 </dl>

554 <!-- RETURNS -->

555 <dl>

556 </dl>

557 <!-- CALLBACK -->

558 <div>

559 <div>

560 <h4>Callback function</h4>

561 <p>

562 If you specify the <em>callback</em> parameter, it should

563 specify a function that looks like this:

564 </p>

565 <!-- Note: intentionally longer 80 columns -->

566 <pre>function(<span>integer downloadId</span>) <span class="su bdued">{...}</span>;</pre>

567 <dl>

568 <div>

569 <div>

570 <dt>

571 <var>downloadId</var>

572 <em>

573 <!-- TYPE -->

574 <div style="display:inline">

575 (

576 <span id="typeTemplate">

577 <span>

578 <span>integer</span>

579 </span>

580 </span>

581 )

582 </div>

583 </em>

584 </dt>

585 <dd>If not null, the identifier of the resulting Download Item.</dd>

586 <!-- OBJECT PROPERTIES -->

587 <!-- OBJECT METHODS -->

588 <!-- OBJECT EVENT FIELDS -->

589 <!-- FUNCTION PARAMETERS -->

590 </div>

591 </div>

592 </dl>

593 </div>

594 </div>

595 <!-- MIN_VERSION -->

596 </div> <!-- /description -->

597 </div> <!-- /apiItem -->

598 </div> <!-- /apiGroup -->

599 <!-- EVENTS -->

600 <!-- /apiGroup -->

601 <!-- TYPES -->

602 <div class="apiGroup">

603 <a name="types"></a>

604 <h3 id="types">Types</h3>

605 <!-- iterates over all types -->

606 <div class="apiItem">

607 <a name="type-HttpHeaders"></a>

608 <h4>HttpHeaders</h4>

609 <div>

610 <dt>

611 <em>

612 <!-- TYPE -->

613 <div style="display:inline">

614 (

615 <span id="typeTemplate">

616 <span>

617 <span>

618 array of <span><span>

619 <span>

620 <span>object</span>

621 </span>

622 </span></span>

623 </span>

624 </span>

625 </span>

626 )

627 </div>

628 </em>

629 </dt>

630 <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>

631 <!-- OBJECT PROPERTIES -->

632 <dd>

633 <dl>

634 <div>

635 <div>

636 <dt>

637 <var>name</var>

638 <em>

639 <!-- TYPE -->

640 <div style="display:inline">

641 (

642 <span id="typeTemplate">

643 <span>

644 <span>string</span>

645 </span>

646 </span>

647 )

648 </div>

649 </em>

650 </dt>

651 <dd>Name of the HTTP header.</dd>

652 <!-- OBJECT PROPERTIES -->

653 <!-- OBJECT METHODS -->

654 <!-- OBJECT EVENT FIELDS -->

655 <!-- FUNCTION PARAMETERS -->

656 </div>

657 </div><div>

658 <div>

659 <dt>

660 <var>value</var>

661 <em>

662 <!-- TYPE -->

663 <div style="display:inline">

664 (

665 <span class="optional">optional</span>

666 <span id="typeTemplate">

667 <span>

668 <span>string</span>

669 </span>

670 </span>

671 )

672 </div>

673 </em>

674 </dt>

675 <dd>Value of the HTTP header if it can be represented by UTF-8.</dd>

676 <!-- OBJECT PROPERTIES -->

677 <!-- OBJECT METHODS -->

678 <!-- OBJECT EVENT FIELDS -->

679 <!-- FUNCTION PARAMETERS -->

680 </div>

681 </div><div>

682 <div>

683 <dt>

684 <var>binaryValue</var>

685 <em>

686 <!-- TYPE -->

687 <div style="display:inline">

688 (

689 <span class="optional">optional</span>

690 <span id="typeTemplate">

691 <span>

692 <span>

693 array of <span><span>

694 <span>

695 <span>integer</span>

696 </span>

697 </span></span>

698 </span>

699 </span>

700 </span>

701 )

702 </div>

703 </em>

704 </dt>

705 <dd>Value of the HTTP header if it cannot be represented by UTF-8, sto red as individual byte values (0..255).</dd>

706 <!-- OBJECT PROPERTIES -->

707 <!-- OBJECT METHODS -->

708 <!-- OBJECT EVENT FIELDS -->

709 <!-- FUNCTION PARAMETERS -->

710 </div>

711 </div>

712 </dl>

713 </dd>

714 <!-- OBJECT METHODS -->

715 <!-- OBJECT EVENT FIELDS -->

716 <!-- FUNCTION PARAMETERS -->

717 </div>

718 </div> <!-- /apiItem -->

719 </div> <!-- /apiGroup -->

720 </div> <!-- /apiPage -->

721 </div> <!-- /gc-pagecontent -->

722 </div> <!-- /g-section -->

723 </div> <!-- /codesiteContent -->

724 <div id="gc-footer" --="">

725 <div class="text">

726 <p>

727 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,

728 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons

729 Attribution 3.0 License</a>, and code samples are licensed under the

730 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.

731 </p>

732 <p>

733 ©2011 Google

734 </p>

735 <!-- begin analytics -->

736 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>

737 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>

738 <script type="text/javascript">

739 // chrome doc tracking

740 try {

741 var engdocs = _gat._getTracker("YT-10763712-2");

742 engdocs._trackPageview();

743 } catch(err) {}

744 // code.google.com site-wide tracking

745 try {

746 _uacct="UA-18071-1";

747 _uanchor=1;

748 _uff=0;

749 urchinTracker();

750 }

751 catch(e) {/* urchinTracker not available. */}

752 </script>

753 <!-- end analytics -->

754 </div>

755 </div> <!-- /gc-footer -->

756 </div> <!-- /gc-container -->

757 </body></html>

OLD	NEW