Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(275)

Issues Search
    My Issues | Starred     Open | Closed | All

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

Issue 9452019: experimental.downloads extension api docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Created 8 years, 10 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
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/themes.html » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
(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&amp;t13n_langs=en"></script>
68 <script type="text/javascript" src="https://www.google.com/coop/cse/br and?form=cse&amp;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" style="">
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" style="">
190 <h2>Contents</h2>
191 <ol>
192 <li style="">
193 <a href="#apiReference">API reference: chrome.experimental.downl oads</a>
194 <ol>
195 <li style="">
196 <a href="#properties">Properties</a>
197 <ol>
198 <li style="">
199 <a href="#property-STATE_IN_PROGRESS">STATE_IN_PROGRESS</a>
200 </li><li style="">
201 <a href="#property-STATE_INTERRUPTED">STATE_INTERRUPTED</a>
202 </li><li style="">
203 <a href="#property-STATE_COMPLETE">STATE_COMPLETE</a>
204 </li><li style="">
205 <a href="#property-DANGER_SAFE">DANGER_SAFE</a>
206 </li><li style="">
207 <a href="#property-DANGER_FILE">DANGER_FILE</a>
208 </li><li style="">
209 <a href="#property-DANGER_URL">DANGER_URL</a>
210 </li><li style="">
211 <a href="#property-DANGER_CONTENT">DANGER_CONTENT</a>
212 </li><li style="">
213 <a href="#property-ERROR_GENERIC">ERROR_GENERIC</a>
214 </li><li style="">
215 <a href="#property-ERROR_INVALID_URL">ERROR_INVALID_URL</a>
216 </li><li style="">
217 <a href="#property-ERROR_INVALID_OPERATION">ERROR_INVALID_OPERAT ION</a>
218 </li>
219 </ol>
220 </li>
221 <li style="">
222 <a href="#global-methods">Methods</a>
223 <ol>
224 <li style="">
225 <a href="#method-cancel">cancel</a>
226 </li><li style="">
227 <a href="#method-download">download</a>
228 </li><li style="">
229 <a href="#method-getFileIcon">getFileIcon</a>
230 </li><li style="">
231 <a href="#method-pause">pause</a>
232 </li><li style="">
233 <a href="#method-resume">resume</a>
234 </li><li style="">
235 <a href="#method-search">search</a>
236 </li>
237 </ol>
238 </li>
239 <li style="">
240 <a href="#global-events">Events</a>
241 <ol>
242 <li style="">
243 <a href="#event-onChanged">onChanged</a>
244 </li><li style="">
245 <a href="#event-onCreated">onCreated</a>
246 </li><li style="">
247 <a href="#event-onErased">onErased</a>
248 </li>
249 </ol>
250 </li>
251 <li style="">
252 <a href="#types">Types</a>
253 <ol>
254 <li style="">
255 <a href="#type-HttpHeaders">HttpHeaders</a>
256 <ol>
257 </ol>
258 </li><li style="">
259 <a href="#type-DownloadItem">DownloadItem</a>
260 <ol>
261 </ol>
262 </li><li style="">
263 <a href="#type-DownloadOptions">DownloadOptions</a>
264 <ol>
265 </ol>
266 </li><li style="">
267 <a href="#type-DownloadQuery">DownloadQuery</a>
268 <ol>
269 </ol>
270 </li><li style="">
271 <a href="#type-DownloadBooleanDiff">DownloadBooleanDiff</a>
272 <ol>
273 </ol>
274 </li><li style="">
275 <a href="#type-DownloadIntegerDiff">DownloadIntegerDiff</a>
276 <ol>
277 </ol>
278 </li><li style="">
279 <a href="#type-DownloadStringDiff">DownloadStringDiff</a>
280 <ol>
281 </ol>
282 </li><li style="">
283 <a href="#type-DownloadDelta">DownloadDelta</a>
284 <ol>
285 </ol>
286 </li><li style="">
287 <a href="#type-DownloadFileIconOptions">DownloadFileIconOptions< /a>
288 <ol>
289 </ol>
290 </li>
291 </ol>
292 </li>
293 </ol>
294 </li>
295 </ol>
296 </div>
297 <!-- /TABLE OF CONTENTS -->
298 <!-- Standard content lead-in for experimental API pages -->
299 <p id="classSummary" style="">
300 For information on how to use experimental APIs, see the <a href="expe rimental.html">chrome.experimental.* APIs</a> page.
301 </p>
302 <!-- STATIC CONTENT PLACEHOLDER -->
303 <div id="static"></div>
304 <!-- API PAGE -->
305 <div class="apiPage" style="">
306 <a name="apiReference"></a>
307 <h2>API reference: chrome.experimental.downloads</h2>
308 <!-- PROPERTIES -->
309 <div class="apiGroup" style="">
310 <a name="properties"></a>
311 <h3 id="properties">Properties</h3>
312 <div style="">
313 <a name="property-STATE_IN_PROGRESS"></a>
314 <h4>STATE_IN_PROGRESS</h4>
315 <div class="summary">
316 <!-- Note: intentionally longer 80 columns -->
317 <span>chrome.experimental.downloads.</span><span>STATE_IN_PROGRE SS</span>
318 </div>
319 <div>
320 <dt>
321 <var style="">STATE_IN_PROGRESS</var>
322 <em>
323 <!-- TYPE -->
324 <div style="display:inline">
325 (
326 <span id="typeTemplate">
327 <code style="">"in_progress"</code>
328 </span>
329 )
330 </div>
331 </em>
332 </dt>
333 <dd style="">The download is currently receiving data from the server. </dd>
334 <!-- OBJECT PROPERTIES -->
335 <!-- OBJECT METHODS -->
336 <!-- OBJECT EVENT FIELDS -->
337 <!-- FUNCTION PARAMETERS -->
338 </div>
339 </div><div style="">
340 <a name="property-STATE_INTERRUPTED"></a>
341 <h4>STATE_INTERRUPTED</h4>
342 <div class="summary">
343 <!-- Note: intentionally longer 80 columns -->
344 <span>chrome.experimental.downloads.</span><span>STATE_INTERRUPT ED</span>
345 </div>
346 <div>
347 <dt>
348 <var style="">STATE_INTERRUPTED</var>
349 <em>
350 <!-- TYPE -->
351 <div style="display:inline">
352 (
353 <span id="typeTemplate">
354 <code style="">"interrupted"</code>
355 </span>
356 )
357 </div>
358 </em>
359 </dt>
360 <dd style="">An error broke the connection with the file host.</dd>
361 <!-- OBJECT PROPERTIES -->
362 <!-- OBJECT METHODS -->
363 <!-- OBJECT EVENT FIELDS -->
364 <!-- FUNCTION PARAMETERS -->
365 </div>
366 </div><div style="">
367 <a name="property-STATE_COMPLETE"></a>
368 <h4>STATE_COMPLETE</h4>
369 <div class="summary">
370 <!-- Note: intentionally longer 80 columns -->
371 <span>chrome.experimental.downloads.</span><span>STATE_COMPLETE< /span>
372 </div>
373 <div>
374 <dt>
375 <var style="">STATE_COMPLETE</var>
376 <em>
377 <!-- TYPE -->
378 <div style="display:inline">
379 (
380 <span id="typeTemplate">
381 <code style="">"complete"</code>
382 </span>
383 )
384 </div>
385 </em>
386 </dt>
387 <dd style="">The download has completed.</dd>
388 <!-- OBJECT PROPERTIES -->
389 <!-- OBJECT METHODS -->
390 <!-- OBJECT EVENT FIELDS -->
391 <!-- FUNCTION PARAMETERS -->
392 </div>
393 </div><div style="">
394 <a name="property-DANGER_SAFE"></a>
395 <h4>DANGER_SAFE</h4>
396 <div class="summary">
397 <!-- Note: intentionally longer 80 columns -->
398 <span>chrome.experimental.downloads.</span><span>DANGER_SAFE</sp an>
399 </div>
400 <div>
401 <dt>
402 <var style="">DANGER_SAFE</var>
403 <em>
404 <!-- TYPE -->
405 <div style="display:inline">
406 (
407 <span id="typeTemplate">
408 <code style="">"safe"</code>
409 </span>
410 )
411 </div>
412 </em>
413 </dt>
414 <dd style="">The file has been determined to present no known danger t o the user's computer.</dd>
415 <!-- OBJECT PROPERTIES -->
416 <!-- OBJECT METHODS -->
417 <!-- OBJECT EVENT FIELDS -->
418 <!-- FUNCTION PARAMETERS -->
419 </div>
420 </div><div style="">
421 <a name="property-DANGER_FILE"></a>
422 <h4>DANGER_FILE</h4>
423 <div class="summary">
424 <!-- Note: intentionally longer 80 columns -->
425 <span>chrome.experimental.downloads.</span><span>DANGER_FILE</sp an>
426 </div>
427 <div>
428 <dt>
429 <var style="">DANGER_FILE</var>
430 <em>
431 <!-- TYPE -->
432 <div style="display:inline">
433 (
434 <span id="typeTemplate">
435 <code style="">"file"</code>
436 </span>
437 )
438 </div>
439 </em>
440 </dt>
441 <dd style="">The download's filename is suspicious.</dd>
442 <!-- OBJECT PROPERTIES -->
443 <!-- OBJECT METHODS -->
444 <!-- OBJECT EVENT FIELDS -->
445 <!-- FUNCTION PARAMETERS -->
446 </div>
447 </div><div style="">
448 <a name="property-DANGER_URL"></a>
449 <h4>DANGER_URL</h4>
450 <div class="summary">
451 <!-- Note: intentionally longer 80 columns -->
452 <span>chrome.experimental.downloads.</span><span>DANGER_URL</spa n>
453 </div>
454 <div>
455 <dt>
456 <var style="">DANGER_URL</var>
457 <em>
458 <!-- TYPE -->
459 <div style="display:inline">
460 (
461 <span id="typeTemplate">
462 <code style="">"url"</code>
463 </span>
464 )
465 </div>
466 </em>
467 </dt>
468 <dd style="">The download's URL is malicious.</dd>
469 <!-- OBJECT PROPERTIES -->
470 <!-- OBJECT METHODS -->
471 <!-- OBJECT EVENT FIELDS -->
472 <!-- FUNCTION PARAMETERS -->
473 </div>
474 </div><div style="">
475 <a name="property-DANGER_CONTENT"></a>
476 <h4>DANGER_CONTENT</h4>
477 <div class="summary">
478 <!-- Note: intentionally longer 80 columns -->
479 <span>chrome.experimental.downloads.</span><span>DANGER_CONTENT< /span>
480 </div>
481 <div>
482 <dt>
483 <var style="">DANGER_CONTENT</var>
484 <em>
485 <!-- TYPE -->
486 <div style="display:inline">
487 (
488 <span id="typeTemplate">
489 <code style="">"content"</code>
490 </span>
491 )
492 </div>
493 </em>
494 </dt>
495 <dd style="">The download's content is malicious.</dd>
496 <!-- OBJECT PROPERTIES -->
497 <!-- OBJECT METHODS -->
498 <!-- OBJECT EVENT FIELDS -->
499 <!-- FUNCTION PARAMETERS -->
500 </div>
501 </div><div style="">
502 <a name="property-ERROR_GENERIC"></a>
503 <h4>ERROR_GENERIC</h4>
504 <div class="summary">
505 <!-- Note: intentionally longer 80 columns -->
506 <span>chrome.experimental.downloads.</span><span>ERROR_GENERIC</ span>
507 </div>
508 <div>
509 <dt>
510 <var style="">ERROR_GENERIC</var>
511 <em>
512 <!-- TYPE -->
513 <div style="display:inline">
514 (
515 <span id="typeTemplate">
516 <code style="">"I'm afraid I can't do that."</code>
517 </span>
518 )
519 </div>
520 </em>
521 </dt>
522 <dd style="">Generic error.</dd>
523 <!-- OBJECT PROPERTIES -->
524 <!-- OBJECT METHODS -->
525 <!-- OBJECT EVENT FIELDS -->
526 <!-- FUNCTION PARAMETERS -->
527 </div>
528 </div><div style="">
529 <a name="property-ERROR_INVALID_URL"></a>
530 <h4>ERROR_INVALID_URL</h4>
531 <div class="summary">
532 <!-- Note: intentionally longer 80 columns -->
533 <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_U RL</span>
534 </div>
535 <div>
536 <dt>
537 <var style="">ERROR_INVALID_URL</var>
538 <em>
539 <!-- TYPE -->
540 <div style="display:inline">
541 (
542 <span id="typeTemplate">
543 <code style="">"Invalid URL."</code>
544 </span>
545 )
546 </div>
547 </em>
548 </dt>
549 <dd style="">The URL was invalid.</dd>
550 <!-- OBJECT PROPERTIES -->
551 <!-- OBJECT METHODS -->
552 <!-- OBJECT EVENT FIELDS -->
553 <!-- FUNCTION PARAMETERS -->
554 </div>
555 </div><div style="">
556 <a name="property-ERROR_INVALID_OPERATION"></a>
557 <h4>ERROR_INVALID_OPERATION</h4>
558 <div class="summary">
559 <!-- Note: intentionally longer 80 columns -->
560 <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_O PERATION</span>
561 </div>
562 <div>
563 <dt>
564 <var style="">ERROR_INVALID_OPERATION</var>
565 <em>
566 <!-- TYPE -->
567 <div style="display:inline">
568 (
569 <span id="typeTemplate">
570 <code style="">"Invalid operation."</code>
571 </span>
572 )
573 </div>
574 </em>
575 </dt>
576 <dd style="">The requested operation cannot be performed at this time. This maybe due to the download being in a state where the requested operation i s not allowed.</dd>
577 <!-- OBJECT PROPERTIES -->
578 <!-- OBJECT METHODS -->
579 <!-- OBJECT EVENT FIELDS -->
580 <!-- FUNCTION PARAMETERS -->
581 </div>
582 </div>
583 </div> <!-- /apiGroup -->
584 <!-- METHODS -->
585 <div id="methodsTemplate" class="apiGroup" style="">
586 <a name="global-methods"></a>
587 <h3>Methods</h3>
588 <!-- iterates over all functions -->
589 <div class="apiItem" style="">
590 <a name="method-cancel"></a> <!-- method-anchor -->
591 <h4>cancel</h4>
592 <div class="summary">
593 <!-- Note: intentionally longer 80 columns -->
594 <span>chrome.experimental.downloads.cancel</span>(<span style= "" class="null"><span>integer</span>
595 <var><span>id</span></var></span><span style="" class="opt ional"><span style="">, </span><span>function</span>
596 <var><span>callback</span></var></span>)</div>
597 <div class="description">
598 <p style="">Cancel a download.</p>
599 <!-- PARAMETERS -->
600 <h4 style="">Parameters</h4>
601 <dl>
602 <div style="">
603 <div>
604 <dt>
605 <var style="">id</var>
606 <em>
607 <!-- TYPE -->
608 <div style="display:inline">
609 (
610 <span id="typeTemplate">
611 <span style="">
612 <span style="">integer</span>
613 </span>
614 </span>
615 )
616 </div>
617 </em>
618 </dt>
619 <dd class="todo" style="">
620 Undocumented.
621 </dd>
622 <!-- OBJECT PROPERTIES -->
623 <!-- OBJECT METHODS -->
624 <!-- OBJECT EVENT FIELDS -->
625 <!-- FUNCTION PARAMETERS -->
626 </div>
627 </div><div style="">
628 <div>
629 <dt>
630 <var style="">callback</var>
631 <em>
632 <!-- TYPE -->
633 <div style="display:inline">
634 (
635 <span class="optional" style="">optional</span>
636 <span id="typeTemplate">
637 <span style="">
638 <span style="">function</span>
639 </span>
640 </span>
641 )
642 </div>
643 </em>
644 </dt>
645 <dd style="">Called when the request is completed. The download is can celled, completed, interrupted or doesn't exist anymore.</dd>
646 <!-- OBJECT PROPERTIES -->
647 <!-- OBJECT METHODS -->
648 <!-- OBJECT EVENT FIELDS -->
649 <!-- FUNCTION PARAMETERS -->
650 </div>
651 </div>
652 </dl>
653 <!-- RETURNS -->
654 <dl>
655 </dl>
656 <!-- CALLBACK -->
657 <div style="">
658 <div style="">
659 <h4>Callback function</h4>
660 <p style="">
661 If you specify the <em>callback</em> parameter, it should
662 specify a function that looks like this:
663 </p>
664 <!-- Note: intentionally longer 80 columns -->
665 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
666 <dl>
667 </dl>
668 </div>
669 </div>
670 <!-- MIN_VERSION -->
671 </div> <!-- /description -->
672 </div><div class="apiItem" style="">
673 <a name="method-download"></a> <!-- method-anchor -->
674 <h4>download</h4>
675 <div class="summary">
676 <!-- Note: intentionally longer 80 columns -->
677 <span>chrome.experimental.downloads.download</span>(<span styl e="" class="null"><span>DownloadOptions</span>
678 <var><span>options</span></var></span><span style="" class ="optional"><span style="">, </span><span>function</span>
679 <var><span>callback</span></var></span>)</div>
680 <div class="description">
681 <p style="">Download a URL. If the URL uses the HTTP[S] protocol , then the request will include all cookies currently set for its hostname. If t he download started successfully, |callback| will be called with the new Downloa dItem’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 ext ension’s manifest, then the |chrome.extensions.lastError| object will indicate t hat the extension does not have permission to access that hostname.</p>
682 <!-- PARAMETERS -->
683 <h4 style="">Parameters</h4>
684 <dl>
685 <div style="">
686 <div>
687 <dt>
688 <var style="">options</var>
689 <em>
690 <!-- TYPE -->
691 <div style="display:inline">
692 (
693 <span id="typeTemplate">
694 <span style="">
695 <a href="experimental.downloads.html#type-DownloadOption s">DownloadOptions</a>
696 </span>
697 </span>
698 )
699 </div>
700 </em>
701 </dt>
702 <dd class="todo" style="">
703 Undocumented.
704 </dd>
705 <!-- OBJECT PROPERTIES -->
706 <!-- OBJECT METHODS -->
707 <!-- OBJECT EVENT FIELDS -->
708 <!-- FUNCTION PARAMETERS -->
709 </div>
710 </div><div style="">
711 <div>
712 <dt>
713 <var style="">callback</var>
714 <em>
715 <!-- TYPE -->
716 <div style="display:inline">
717 (
718 <span class="optional" style="">optional</span>
719 <span id="typeTemplate">
720 <span style="">
721 <span style="">function</span>
722 </span>
723 </span>
724 )
725 </div>
726 </em>
727 </dt>
728 <dd class="todo" style="">
729 Undocumented.
730 </dd>
731 <!-- OBJECT PROPERTIES -->
732 <!-- OBJECT METHODS -->
733 <!-- OBJECT EVENT FIELDS -->
734 <!-- FUNCTION PARAMETERS -->
735 </div>
736 </div>
737 </dl>
738 <!-- RETURNS -->
739 <dl>
740 </dl>
741 <!-- CALLBACK -->
742 <div style="">
743 <div style="">
744 <h4>Callback function</h4>
745 <p style="">
746 If you specify the <em>callback</em> parameter, it should
747 specify a function that looks like this:
748 </p>
749 <!-- Note: intentionally longer 80 columns -->
750 <pre>function(<span>integer id</span>) <span class="subdued">{ ...}</span>;</pre>
751 <dl>
752 <div style="">
753 <div>
754 <dt>
755 <var style="">id</var>
756 <em>
757 <!-- TYPE -->
758 <div style="display:inline">
759 (
760 <span id="typeTemplate">
761 <span style="">
762 <span style="">integer</span>
763 </span>
764 </span>
765 )
766 </div>
767 </em>
768 </dt>
769 <dd class="todo" style="">
770 Undocumented.
771 </dd>
772 <!-- OBJECT PROPERTIES -->
773 <!-- OBJECT METHODS -->
774 <!-- OBJECT EVENT FIELDS -->
775 <!-- FUNCTION PARAMETERS -->
776 </div>
777 </div>
778 </dl>
779 </div>
780 </div>
781 <!-- MIN_VERSION -->
782 </div> <!-- /description -->
783 </div><div class="apiItem" style="">
784 <a name="method-getFileIcon"></a> <!-- method-anchor -->
785 <h4>getFileIcon</h4>
786 <div class="summary">
787 <!-- Note: intentionally longer 80 columns -->
788 <span>chrome.experimental.downloads.getFileIcon</span>(<span s tyle="" class="null"><span>integer</span>
789 <var><span>id</span></var></span><span style="" class="nul l"><span style="">, </span><span>DownloadFileIconOptions</span>
790 <var><span>options</span></var></span><span style="" class ="null"><span style="">, </span><span>function</span>
791 <var><span>callback</span></var></span>)</div>
792 <div class="description">
793 <p style="">Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received . The image returned by this function while a download is in progress may be dif ferent from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit depending on the pl atform. The icon that is returned will therefore depend on a number of factors i ncluding state of the download, platform, registered file types and visual theme .</p>
794 <!-- PARAMETERS -->
795 <h4 style="">Parameters</h4>
796 <dl>
797 <div style="">
798 <div>
799 <dt>
800 <var style="">id</var>
801 <em>
802 <!-- TYPE -->
803 <div style="display:inline">
804 (
805 <span id="typeTemplate">
806 <span style="">
807 <span style="">integer</span>
808 </span>
809 </span>
810 )
811 </div>
812 </em>
813 </dt>
814 <dd style="">The identifier for the download.</dd>
815 <!-- OBJECT PROPERTIES -->
816 <!-- OBJECT METHODS -->
817 <!-- OBJECT EVENT FIELDS -->
818 <!-- FUNCTION PARAMETERS -->
819 </div>
820 </div><div style="">
821 <div>
822 <dt>
823 <var style="">options</var>
824 <em>
825 <!-- TYPE -->
826 <div style="display:inline">
827 (
828 <span id="typeTemplate">
829 <span style="">
830 <a href="experimental.downloads.html#type-DownloadFileIc onOptions">DownloadFileIconOptions</a>
831 </span>
832 </span>
833 )
834 </div>
835 </em>
836 </dt>
837 <dd style="">Options for the returned image.</dd>
838 <!-- OBJECT PROPERTIES -->
839 <!-- OBJECT METHODS -->
840 <!-- OBJECT EVENT FIELDS -->
841 <!-- FUNCTION PARAMETERS -->
842 </div>
843 </div><div style="">
844 <div>
845 <dt>
846 <var style="">callback</var>
847 <em>
848 <!-- TYPE -->
849 <div style="display:inline">
850 (
851 <span id="typeTemplate">
852 <span style="">
853 <span style="">function</span>
854 </span>
855 </span>
856 )
857 </div>
858 </em>
859 </dt>
860 <dd class="todo" style="">
861 Undocumented.
862 </dd>
863 <!-- OBJECT PROPERTIES -->
864 <!-- OBJECT METHODS -->
865 <!-- OBJECT EVENT FIELDS -->
866 <!-- FUNCTION PARAMETERS -->
867 </div>
868 </div>
869 </dl>
870 <!-- RETURNS -->
871 <dl>
872 </dl>
873 <!-- CALLBACK -->
874 <div style="">
875 <div style="">
876 <h4>Callback function</h4>
877 <p style="">
878 The callback <em>parameter</em> should specify a function
879 that looks like this:
880 </p>
881 <!-- Note: intentionally longer 80 columns -->
882 <pre>function(<span>string iconURL</span>) <span class="subdue d">{...}</span>;</pre>
883 <dl>
884 <div style="">
885 <div>
886 <dt>
887 <var style="">iconURL</var>
888 <em>
889 <!-- TYPE -->
890 <div style="display:inline">
891 (
892 <span id="typeTemplate">
893 <span style="">
894 <span style="">string</span>
895 </span>
896 </span>
897 )
898 </div>
899 </em>
900 </dt>
901 <dd style="">A URL to an image that represents the download. If a file icon cannot be determined, chrome.extension.lastError will contain an error mes sage.</dd>
902 <!-- OBJECT PROPERTIES -->
903 <!-- OBJECT METHODS -->
904 <!-- OBJECT EVENT FIELDS -->
905 <!-- FUNCTION PARAMETERS -->
906 </div>
907 </div>
908 </dl>
909 </div>
910 </div>
911 <!-- MIN_VERSION -->
912 </div> <!-- /description -->
913 </div><div class="apiItem" style="">
914 <a name="method-pause"></a> <!-- method-anchor -->
915 <h4>pause</h4>
916 <div class="summary">
917 <!-- Note: intentionally longer 80 columns -->
918 <span>chrome.experimental.downloads.pause</span>(<span style=" " class="null"><span>integer</span>
919 <var><span>id</span></var></span><span style="" class="opt ional"><span style="">, </span><span>function</span>
920 <var><span>callback</span></var></span>)</div>
921 <div class="description">
922 <p style="">Pause the download.</p>
923 <!-- PARAMETERS -->
924 <h4 style="">Parameters</h4>
925 <dl>
926 <div style="">
927 <div>
928 <dt>
929 <var style="">id</var>
930 <em>
931 <!-- TYPE -->
932 <div style="display:inline">
933 (
934 <span id="typeTemplate">
935 <span style="">
936 <span style="">integer</span>
937 </span>
938 </span>
939 )
940 </div>
941 </em>
942 </dt>
943 <dd class="todo" style="">
944 Undocumented.
945 </dd>
946 <!-- OBJECT PROPERTIES -->
947 <!-- OBJECT METHODS -->
948 <!-- OBJECT EVENT FIELDS -->
949 <!-- FUNCTION PARAMETERS -->
950 </div>
951 </div><div style="">
952 <div>
953 <dt>
954 <var style="">callback</var>
955 <em>
956 <!-- TYPE -->
957 <div style="display:inline">
958 (
959 <span class="optional" style="">optional</span>
960 <span id="typeTemplate">
961 <span style="">
962 <span style="">function</span>
963 </span>
964 </span>
965 )
966 </div>
967 </em>
968 </dt>
969 <dd style="">Called when the pause request is completed. If the reques t was successful the download is in a paused state. Otherwise chrome.extension.l astError contains an error message. The request will fail if the download is not active.</dd>
970 <!-- OBJECT PROPERTIES -->
971 <!-- OBJECT METHODS -->
972 <!-- OBJECT EVENT FIELDS -->
973 <!-- FUNCTION PARAMETERS -->
974 </div>
975 </div>
976 </dl>
977 <!-- RETURNS -->
978 <dl>
979 </dl>
980 <!-- CALLBACK -->
981 <div style="">
982 <div style="">
983 <h4>Callback function</h4>
984 <p style="">
985 If you specify the <em>callback</em> parameter, it should
986 specify a function that looks like this:
987 </p>
988 <!-- Note: intentionally longer 80 columns -->
989 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
990 <dl>
991 </dl>
992 </div>
993 </div>
994 <!-- MIN_VERSION -->
995 </div> <!-- /description -->
996 </div><div class="apiItem" style="">
997 <a name="method-resume"></a> <!-- method-anchor -->
998 <h4>resume</h4>
999 <div class="summary">
1000 <!-- Note: intentionally longer 80 columns -->
1001 <span>chrome.experimental.downloads.resume</span>(<span style= "" class="null"><span>integer</span>
1002 <var><span>id</span></var></span><span style="" class="opt ional"><span style="">, </span><span>function</span>
1003 <var><span>callback</span></var></span>)</div>
1004 <div class="description">
1005 <p style="">Resume a paused download.</p>
1006 <!-- PARAMETERS -->
1007 <h4 style="">Parameters</h4>
1008 <dl>
1009 <div style="">
1010 <div>
1011 <dt>
1012 <var style="">id</var>
1013 <em>
1014 <!-- TYPE -->
1015 <div style="display:inline">
1016 (
1017 <span id="typeTemplate">
1018 <span style="">
1019 <span style="">integer</span>
1020 </span>
1021 </span>
1022 )
1023 </div>
1024 </em>
1025 </dt>
1026 <dd class="todo" style="">
1027 Undocumented.
1028 </dd>
1029 <!-- OBJECT PROPERTIES -->
1030 <!-- OBJECT METHODS -->
1031 <!-- OBJECT EVENT FIELDS -->
1032 <!-- FUNCTION PARAMETERS -->
1033 </div>
1034 </div><div style="">
1035 <div>
1036 <dt>
1037 <var style="">callback</var>
1038 <em>
1039 <!-- TYPE -->
1040 <div style="display:inline">
1041 (
1042 <span class="optional" style="">optional</span>
1043 <span id="typeTemplate">
1044 <span style="">
1045 <span style="">function</span>
1046 </span>
1047 </span>
1048 )
1049 </div>
1050 </em>
1051 </dt>
1052 <dd style="">Called when the resume request is completed. If the reque st was successful the download is in progress and unpaused. Otherwise chrome.ext ension.lastError contains an error message. The request will fail if the downloa d is not active.</dd>
1053 <!-- OBJECT PROPERTIES -->
1054 <!-- OBJECT METHODS -->
1055 <!-- OBJECT EVENT FIELDS -->
1056 <!-- FUNCTION PARAMETERS -->
1057 </div>
1058 </div>
1059 </dl>
1060 <!-- RETURNS -->
1061 <dl>
1062 </dl>
1063 <!-- CALLBACK -->
1064 <div style="">
1065 <div style="">
1066 <h4>Callback function</h4>
1067 <p style="">
1068 If you specify the <em>callback</em> parameter, it should
1069 specify a function that looks like this:
1070 </p>
1071 <!-- Note: intentionally longer 80 columns -->
1072 <pre>function(<span></span>) <span class="subdued">{...}</span >;</pre>
1073 <dl>
1074 </dl>
1075 </div>
1076 </div>
1077 <!-- MIN_VERSION -->
1078 </div> <!-- /description -->
1079 </div><div class="apiItem" style="">
1080 <a name="method-search"></a> <!-- method-anchor -->
1081 <h4>search</h4>
1082 <div class="summary">
1083 <!-- Note: intentionally longer 80 columns -->
1084 <span>chrome.experimental.downloads.search</span>(<span style= "" class="null"><span>DownloadQuery</span>
1085 <var><span>query</span></var></span><span style="" class=" optional"><span style="">, </span><span>function</span>
1086 <var><span>callback</span></var></span>)</div>
1087 <div class="description">
1088 <p style="">Find DownloadItems. Set |query| to the empty object to get all DownloadItems. To get a specific DownloadItem, set only the |id| fiel d.</p>
1089 <!-- PARAMETERS -->
1090 <h4 style="">Parameters</h4>
1091 <dl>
1092 <div style="">
1093 <div>
1094 <dt>
1095 <var style="">query</var>
1096 <em>
1097 <!-- TYPE -->
1098 <div style="display:inline">
1099 (
1100 <span id="typeTemplate">
1101 <span style="">
1102 <a href="experimental.downloads.html#type-DownloadQuery" >DownloadQuery</a>
1103 </span>
1104 </span>
1105 )
1106 </div>
1107 </em>
1108 </dt>
1109 <dd class="todo" style="">
1110 Undocumented.
1111 </dd>
1112 <!-- OBJECT PROPERTIES -->
1113 <!-- OBJECT METHODS -->
1114 <!-- OBJECT EVENT FIELDS -->
1115 <!-- FUNCTION PARAMETERS -->
1116 </div>
1117 </div><div style="">
1118 <div>
1119 <dt>
1120 <var style="">callback</var>
1121 <em>
1122 <!-- TYPE -->
1123 <div style="display:inline">
1124 (
1125 <span class="optional" style="">optional</span>
1126 <span id="typeTemplate">
1127 <span style="">
1128 <span style="">function</span>
1129 </span>
1130 </span>
1131 )
1132 </div>
1133 </em>
1134 </dt>
1135 <dd class="todo" style="">
1136 Undocumented.
1137 </dd>
1138 <!-- OBJECT PROPERTIES -->
1139 <!-- OBJECT METHODS -->
1140 <!-- OBJECT EVENT FIELDS -->
1141 <!-- FUNCTION PARAMETERS -->
1142 </div>
1143 </div>
1144 </dl>
1145 <!-- RETURNS -->
1146 <dl>
1147 </dl>
1148 <!-- CALLBACK -->
1149 <div style="">
1150 <div style="">
1151 <h4>Callback function</h4>
1152 <p style="">
1153 If you specify the <em>callback</em> parameter, it should
1154 specify a function that looks like this:
1155 </p>
1156 <!-- Note: intentionally longer 80 columns -->
1157 <pre>function(<span>null</span>) <span class="subdued">{...}</ span>;</pre>
1158 <dl>
1159 <div style="">
1160 <div>
1161 <dt>
1162 <var style="">items</var>
1163 <em>
1164 <!-- TYPE -->
1165 <div style="display:inline">
1166 (
1167 <span id="typeTemplate">
1168 <span style="">
1169 <span style="">
1170 array of
1171 </span>
1172 </span>
1173 </span>
1174 )
1175 </div>
1176 </em>
1177 </dt>
1178 <dd class="todo" style="">
1179 Undocumented.
1180 </dd>
1181 <!-- OBJECT PROPERTIES -->
1182 <!-- OBJECT METHODS -->
1183 <!-- OBJECT EVENT FIELDS -->
1184 <!-- FUNCTION PARAMETERS -->
1185 </div>
1186 </div>
1187 </dl>
1188 </div>
1189 </div>
1190 <!-- MIN_VERSION -->
1191 </div> <!-- /description -->
1192 </div> <!-- /apiItem -->
1193 </div> <!-- /apiGroup -->
1194 <!-- EVENTS -->
1195 <div id="eventsTemplate" class="apiGroup" style="">
1196 <a name="global-events"></a>
1197 <h3>Events</h3>
1198 <!-- iterates over all events -->
1199 <div class="apiItem" style="">
1200 <a name="event-onChanged"></a>
1201 <h4>onChanged</h4>
1202 <div class="summary">
1203 <!-- Note: intentionally longer 80 columns -->
1204 <span class="subdued">chrome.experimental.downloads.</span><span >onChanged</span><span class="subdued">.addListener</span>(function(<span>Downlo adDelta downloadDelta</span>) <span class="subdued">{...}</span><span></span>);
1205 </div>
1206 <div class="description">
1207 <p style="">When any of a DownloadItem's properties except |byte sReceived| changes, this event fires with the download id and an object containi ng the properties that changed.</p>
1208 <!-- LISTENER PARAMETERS -->
1209 <div style="">
1210 <h4>Listener parameters</h4>
1211 <dl>
1212 <div style="">
1213 <div>
1214 <dt>
1215 <var style="">downloadDelta</var>
1216 <em>
1217 <!-- TYPE -->
1218 <div style="display:inline">
1219 (
1220 <span id="typeTemplate">
1221 <span style="">
1222 <a href="experimental.downloads.html#type-DownloadDelta" >DownloadDelta</a>
1223 </span>
1224 </span>
1225 )
1226 </div>
1227 </em>
1228 </dt>
1229 <dd class="todo" style="">
1230 Undocumented.
1231 </dd>
1232 <!-- OBJECT PROPERTIES -->
1233 <!-- OBJECT METHODS -->
1234 <!-- OBJECT EVENT FIELDS -->
1235 <!-- FUNCTION PARAMETERS -->
1236 </div>
1237 </div>
1238 </dl>
1239 </div>
1240 <!-- EXTRA PARAMETERS -->
1241 <!-- LISTENER RETURN VALUE -->
1242 <dl>
1243 </dl>
1244 </div> <!-- /description -->
1245 </div><div class="apiItem" style="">
1246 <a name="event-onCreated"></a>
1247 <h4>onCreated</h4>
1248 <div class="summary">
1249 <!-- Note: intentionally longer 80 columns -->
1250 <span class="subdued">chrome.experimental.downloads.</span><span >onCreated</span><span class="subdued">.addListener</span>(function(<span>Downlo adItem downloadItem</span>) <span class="subdued">{...}</span><span></span>);
1251 </div>
1252 <div class="description">
1253 <p style="">This event fires with the DownloadItem object when a download begins.</p>
1254 <!-- LISTENER PARAMETERS -->
1255 <div style="">
1256 <h4>Listener parameters</h4>
1257 <dl>
1258 <div style="">
1259 <div>
1260 <dt>
1261 <var style="">downloadItem</var>
1262 <em>
1263 <!-- TYPE -->
1264 <div style="display:inline">
1265 (
1266 <span id="typeTemplate">
1267 <span style="">
1268 <a href="experimental.downloads.html#type-DownloadItem"> DownloadItem</a>
1269 </span>
1270 </span>
1271 )
1272 </div>
1273 </em>
1274 </dt>
1275 <dd class="todo" style="">
1276 Undocumented.
1277 </dd>
1278 <!-- OBJECT PROPERTIES -->
1279 <!-- OBJECT METHODS -->
1280 <!-- OBJECT EVENT FIELDS -->
1281 <!-- FUNCTION PARAMETERS -->
1282 </div>
1283 </div>
1284 </dl>
1285 </div>
1286 <!-- EXTRA PARAMETERS -->
1287 <!-- LISTENER RETURN VALUE -->
1288 <dl>
1289 </dl>
1290 </div> <!-- /description -->
1291 </div><div class="apiItem" style="">
1292 <a name="event-onErased"></a>
1293 <h4>onErased</h4>
1294 <div class="summary">
1295 <!-- Note: intentionally longer 80 columns -->
1296 <span class="subdued">chrome.experimental.downloads.</span><span >onErased</span><span class="subdued">.addListener</span>(function(<span>integer downloadId</span>) <span class="subdued">{...}</span><span></span>);
1297 </div>
1298 <div class="description">
1299 <p style="">Fires with the download id when a download is erased from history.</p>
1300 <!-- LISTENER PARAMETERS -->
1301 <div style="">
1302 <h4>Listener parameters</h4>
1303 <dl>
1304 <div style="">
1305 <div>
1306 <dt>
1307 <var style="">downloadId</var>
1308 <em>
1309 <!-- TYPE -->
1310 <div style="display:inline">
1311 (
1312 <span id="typeTemplate">
1313 <span style="">
1314 <span style="">integer</span>
1315 </span>
1316 </span>
1317 )
1318 </div>
1319 </em>
1320 </dt>
1321 <dd class="todo" style="">
1322 Undocumented.
1323 </dd>
1324 <!-- OBJECT PROPERTIES -->
1325 <!-- OBJECT METHODS -->
1326 <!-- OBJECT EVENT FIELDS -->
1327 <!-- FUNCTION PARAMETERS -->
1328 </div>
1329 </div>
1330 </dl>
1331 </div>
1332 <!-- EXTRA PARAMETERS -->
1333 <!-- LISTENER RETURN VALUE -->
1334 <dl>
1335 </dl>
1336 </div> <!-- /description -->
1337 </div> <!-- /apiItem -->
1338 </div> <!-- /apiGroup -->
1339 <!-- TYPES -->
1340 <div class="apiGroup" style="">
1341 <a name="types"></a>
1342 <h3 id="types">Types</h3>
1343 <!-- iterates over all types -->
1344 <div class="apiItem" style="">
1345 <a name="type-HttpHeaders"></a>
1346 <h4>HttpHeaders</h4>
1347 <div>
1348 <dt>
1349 <em>
1350 <!-- TYPE -->
1351 <div style="display:inline">
1352 (
1353 <span id="typeTemplate">
1354 <span style="">
1355 <span style="">
1356 array of <span style=""><span>
1357 <span style="">
1358 <span style="">object</span>
1359 </span>
1360 </span></span>
1361 </span>
1362 </span>
1363 </span>
1364 )
1365 </div>
1366 </em>
1367 </dt>
1368 <dd style="">An array of HTTP headers. Each header is represented as a dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>.</dd>
1369 <!-- OBJECT PROPERTIES -->
1370 <dd style="">
1371 <dl>
1372 <div style="">
1373 <div>
1374 <dt>
1375 <var style="">name</var>
1376 <em>
1377 <!-- TYPE -->
1378 <div style="display:inline">
1379 (
1380 <span id="typeTemplate">
1381 <span style="">
1382 <span style="">string</span>
1383 </span>
1384 </span>
1385 )
1386 </div>
1387 </em>
1388 </dt>
1389 <dd style="">Name of the HTTP header.</dd>
1390 <!-- OBJECT PROPERTIES -->
1391 <!-- OBJECT METHODS -->
1392 <!-- OBJECT EVENT FIELDS -->
1393 <!-- FUNCTION PARAMETERS -->
1394 </div>
1395 </div><div style="">
1396 <div>
1397 <dt>
1398 <var style="">value</var>
1399 <em>
1400 <!-- TYPE -->
1401 <div style="display:inline">
1402 (
1403 <span class="optional" style="">optional</span>
1404 <span id="typeTemplate">
1405 <span style="">
1406 <span style="">string</span>
1407 </span>
1408 </span>
1409 )
1410 </div>
1411 </em>
1412 </dt>
1413 <dd style="">Value of the HTTP header if it can be represented by UTF- 8.</dd>
1414 <!-- OBJECT PROPERTIES -->
1415 <!-- OBJECT METHODS -->
1416 <!-- OBJECT EVENT FIELDS -->
1417 <!-- FUNCTION PARAMETERS -->
1418 </div>
1419 </div><div style="">
1420 <div>
1421 <dt>
1422 <var style="">binaryValue</var>
1423 <em>
1424 <!-- TYPE -->
1425 <div style="display:inline">
1426 (
1427 <span class="optional" style="">optional</span>
1428 <span id="typeTemplate">
1429 <span style="">
1430 <span style="">
1431 array of <span style=""><span>
1432 <span style="">
1433 <span style="">integer</span>
1434 </span>
1435 </span></span>
1436 </span>
1437 </span>
1438 </span>
1439 )
1440 </div>
1441 </em>
1442 </dt>
1443 <dd style="">Value of the HTTP header if it cannot be represented by U TF-8, stored as individual byte values (0..255).</dd>
1444 <!-- OBJECT PROPERTIES -->
1445 <!-- OBJECT METHODS -->
1446 <!-- OBJECT EVENT FIELDS -->
1447 <!-- FUNCTION PARAMETERS -->
1448 </div>
1449 </div>
1450 </dl>
1451 </dd>
1452 <!-- OBJECT METHODS -->
1453 <!-- OBJECT EVENT FIELDS -->
1454 <!-- FUNCTION PARAMETERS -->
1455 </div>
1456 </div><div class="apiItem" style="">
1457 <a name="type-DownloadItem"></a>
1458 <h4>DownloadItem</h4>
1459 <div>
1460 <dt>
1461 <em>
1462 <!-- TYPE -->
1463 <div style="display:inline">
1464 (
1465 <span id="typeTemplate">
1466 <span style="">
1467 <span style="">object</span>
1468 </span>
1469 </span>
1470 )
1471 </div>
1472 </em>
1473 </dt>
1474 <dd style="">The state of a file as it is downloaded from the internet .</dd>
1475 <!-- OBJECT PROPERTIES -->
1476 <dd style="">
1477 <dl>
1478 <div style="">
1479 <div>
1480 <dt>
1481 <var style="">id</var>
1482 <em>
1483 <!-- TYPE -->
1484 <div style="display:inline">
1485 (
1486 <span id="typeTemplate">
1487 <span style="">
1488 <span style="">integer</span>
1489 </span>
1490 </span>
1491 )
1492 </div>
1493 </em>
1494 </dt>
1495 <dd style="">An identifier that is persistent across browser sessions. </dd>
1496 <!-- OBJECT PROPERTIES -->
1497 <!-- OBJECT METHODS -->
1498 <!-- OBJECT EVENT FIELDS -->
1499 <!-- FUNCTION PARAMETERS -->
1500 </div>
1501 </div><div style="">
1502 <div>
1503 <dt>
1504 <var style="">url</var>
1505 <em>
1506 <!-- TYPE -->
1507 <div style="display:inline">
1508 (
1509 <span id="typeTemplate">
1510 <span style="">
1511 <span style="">string</span>
1512 </span>
1513 </span>
1514 )
1515 </div>
1516 </em>
1517 </dt>
1518 <dd style="">absolute URL</dd>
1519 <!-- OBJECT PROPERTIES -->
1520 <!-- OBJECT METHODS -->
1521 <!-- OBJECT EVENT FIELDS -->
1522 <!-- FUNCTION PARAMETERS -->
1523 </div>
1524 </div><div style="">
1525 <div>
1526 <dt>
1527 <var style="">filename</var>
1528 <em>
1529 <!-- TYPE -->
1530 <div style="display:inline">
1531 (
1532 <span id="typeTemplate">
1533 <span style="">
1534 <span style="">string</span>
1535 </span>
1536 </span>
1537 )
1538 </div>
1539 </em>
1540 </dt>
1541 <dd style="">absolute local path</dd>
1542 <!-- OBJECT PROPERTIES -->
1543 <!-- OBJECT METHODS -->
1544 <!-- OBJECT EVENT FIELDS -->
1545 <!-- FUNCTION PARAMETERS -->
1546 </div>
1547 </div><div style="">
1548 <div>
1549 <dt>
1550 <var style="">danger</var>
1551 <em>
1552 <!-- TYPE -->
1553 <div style="display:inline">
1554 (
1555 <span class="optional" style="">optional</span>
1556 <span class="enum" style="">enumerated</span>
1557 <span id="typeTemplate">
1558 <span style="">
1559 <span style="">string</span>
1560 <span style="">["safe", "file", "url", "content"]</span>
1561 </span>
1562 </span>
1563 )
1564 </div>
1565 </em>
1566 </dt>
1567 <dd style="">Indication of whether this download is thought to be safe or known to be suspicious.</dd>
1568 <!-- OBJECT PROPERTIES -->
1569 <!-- OBJECT METHODS -->
1570 <!-- OBJECT EVENT FIELDS -->
1571 <!-- FUNCTION PARAMETERS -->
1572 </div>
1573 </div><div style="">
1574 <div>
1575 <dt>
1576 <var style="">dangerAccepted</var>
1577 <em>
1578 <!-- TYPE -->
1579 <div style="display:inline">
1580 (
1581 <span class="optional" style="">optional</span>
1582 <span id="typeTemplate">
1583 <span style="">
1584 <span style="">boolean</span>
1585 </span>
1586 </span>
1587 )
1588 </div>
1589 </em>
1590 </dt>
1591 <dd style="">true if the user has accepted the download's danger.</dd>
1592 <!-- OBJECT PROPERTIES -->
1593 <!-- OBJECT METHODS -->
1594 <!-- OBJECT EVENT FIELDS -->
1595 <!-- FUNCTION PARAMETERS -->
1596 </div>
1597 </div><div style="">
1598 <div>
1599 <dt>
1600 <var style="">mime</var>
1601 <em>
1602 <!-- TYPE -->
1603 <div style="display:inline">
1604 (
1605 <span id="typeTemplate">
1606 <span style="">
1607 <span style="">string</span>
1608 </span>
1609 </span>
1610 )
1611 </div>
1612 </em>
1613 </dt>
1614 <dd style="">The file's MIME type.</dd>
1615 <!-- OBJECT PROPERTIES -->
1616 <!-- OBJECT METHODS -->
1617 <!-- OBJECT EVENT FIELDS -->
1618 <!-- FUNCTION PARAMETERS -->
1619 </div>
1620 </div><div style="">
1621 <div>
1622 <dt>
1623 <var style="">startTime</var>
1624 <em>
1625 <!-- TYPE -->
1626 <div style="display:inline">
1627 (
1628 <span id="typeTemplate">
1629 <span style="">
1630 <span style="">integer</span>
1631 </span>
1632 </span>
1633 )
1634 </div>
1635 </em>
1636 </dt>
1637 <dd style="">Number of milliseconds between the unix epoch and when th is download began.</dd>
1638 <!-- OBJECT PROPERTIES -->
1639 <!-- OBJECT METHODS -->
1640 <!-- OBJECT EVENT FIELDS -->
1641 <!-- FUNCTION PARAMETERS -->
1642 </div>
1643 </div><div style="">
1644 <div>
1645 <dt>
1646 <var style="">endTime</var>
1647 <em>
1648 <!-- TYPE -->
1649 <div style="display:inline">
1650 (
1651 <span class="optional" style="">optional</span>
1652 <span id="typeTemplate">
1653 <span style="">
1654 <span style="">integer</span>
1655 </span>
1656 </span>
1657 )
1658 </div>
1659 </em>
1660 </dt>
1661 <dd style="">Number of milliseconds between the unix epoch and when th is download ended.</dd>
1662 <!-- OBJECT PROPERTIES -->
1663 <!-- OBJECT METHODS -->
1664 <!-- OBJECT EVENT FIELDS -->
1665 <!-- FUNCTION PARAMETERS -->
1666 </div>
1667 </div><div style="">
1668 <div>
1669 <dt>
1670 <var style="">state</var>
1671 <em>
1672 <!-- TYPE -->
1673 <div style="display:inline">
1674 (
1675 <span class="enum" style="">enumerated</span>
1676 <span id="typeTemplate">
1677 <span style="">
1678 <span style="">string</span>
1679 <span style="">["in_progress", "complete", "interrupted" ]</span>
1680 </span>
1681 </span>
1682 )
1683 </div>
1684 </em>
1685 </dt>
1686 <dd style="">Indicates whether the download is progressing, interrupte d, or complete.</dd>
1687 <!-- OBJECT PROPERTIES -->
1688 <!-- OBJECT METHODS -->
1689 <!-- OBJECT EVENT FIELDS -->
1690 <!-- FUNCTION PARAMETERS -->
1691 </div>
1692 </div><div style="">
1693 <div>
1694 <dt>
1695 <var style="">paused</var>
1696 <em>
1697 <!-- TYPE -->
1698 <div style="display:inline">
1699 (
1700 <span id="typeTemplate">
1701 <span style="">
1702 <span style="">boolean</span>
1703 </span>
1704 </span>
1705 )
1706 </div>
1707 </em>
1708 </dt>
1709 <dd style="">true if the download has stopped reading data from the ho st, but kept the connection open.</dd>
1710 <!-- OBJECT PROPERTIES -->
1711 <!-- OBJECT METHODS -->
1712 <!-- OBJECT EVENT FIELDS -->
1713 <!-- FUNCTION PARAMETERS -->
1714 </div>
1715 </div><div style="">
1716 <div>
1717 <dt>
1718 <var style="">error</var>
1719 <em>
1720 <!-- TYPE -->
1721 <div style="display:inline">
1722 (
1723 <span class="optional" style="">optional</span>
1724 <span id="typeTemplate">
1725 <span style="">
1726 <span style="">integer</span>
1727 </span>
1728 </span>
1729 )
1730 </div>
1731 </em>
1732 </dt>
1733 <dd style="">Number indicating why a download was interrupted.</dd>
1734 <!-- OBJECT PROPERTIES -->
1735 <!-- OBJECT METHODS -->
1736 <!-- OBJECT EVENT FIELDS -->
1737 <!-- FUNCTION PARAMETERS -->
1738 </div>
1739 </div><div style="">
1740 <div>
1741 <dt>
1742 <var style="">bytesReceived</var>
1743 <em>
1744 <!-- TYPE -->
1745 <div style="display:inline">
1746 (
1747 <span id="typeTemplate">
1748 <span style="">
1749 <span style="">integer</span>
1750 </span>
1751 </span>
1752 )
1753 </div>
1754 </em>
1755 </dt>
1756 <dd style="">Number of bytes received so far from the host, without co nsidering file compression.</dd>
1757 <!-- OBJECT PROPERTIES -->
1758 <!-- OBJECT METHODS -->
1759 <!-- OBJECT EVENT FIELDS -->
1760 <!-- FUNCTION PARAMETERS -->
1761 </div>
1762 </div><div style="">
1763 <div>
1764 <dt>
1765 <var style="">totalBytes</var>
1766 <em>
1767 <!-- TYPE -->
1768 <div style="display:inline">
1769 (
1770 <span id="typeTemplate">
1771 <span style="">
1772 <span style="">integer</span>
1773 </span>
1774 </span>
1775 )
1776 </div>
1777 </em>
1778 </dt>
1779 <dd style="">Number of bytes in the whole file, without considering fi le compression, or -1 if unknown.</dd>
1780 <!-- OBJECT PROPERTIES -->
1781 <!-- OBJECT METHODS -->
1782 <!-- OBJECT EVENT FIELDS -->
1783 <!-- FUNCTION PARAMETERS -->
1784 </div>
1785 </div><div style="">
1786 <div>
1787 <dt>
1788 <var style="">fileSize</var>
1789 <em>
1790 <!-- TYPE -->
1791 <div style="display:inline">
1792 (
1793 <span id="typeTemplate">
1794 <span style="">
1795 <span style="">integer</span>
1796 </span>
1797 </span>
1798 )
1799 </div>
1800 </em>
1801 </dt>
1802 <dd style="">Number of bytes in the whole file post-decompression, or -1 if unknown.</dd>
1803 <!-- OBJECT PROPERTIES -->
1804 <!-- OBJECT METHODS -->
1805 <!-- OBJECT EVENT FIELDS -->
1806 <!-- FUNCTION PARAMETERS -->
1807 </div>
1808 </div>
1809 </dl>
1810 </dd>
1811 <!-- OBJECT METHODS -->
1812 <!-- OBJECT EVENT FIELDS -->
1813 <!-- FUNCTION PARAMETERS -->
1814 </div>
1815 </div><div class="apiItem" style="">
1816 <a name="type-DownloadOptions"></a>
1817 <h4>DownloadOptions</h4>
1818 <div>
1819 <dt>
1820 <em>
1821 <!-- TYPE -->
1822 <div style="display:inline">
1823 (
1824 <span id="typeTemplate">
1825 <span style="">
1826 <span style="">object</span>
1827 </span>
1828 </span>
1829 )
1830 </div>
1831 </em>
1832 </dt>
1833 <dd class="todo" style="">
1834 Undocumented.
1835 </dd>
1836 <!-- OBJECT PROPERTIES -->
1837 <dd style="">
1838 <dl>
1839 <div style="">
1840 <div>
1841 <dt>
1842 <var style="">url</var>
1843 <em>
1844 <!-- TYPE -->
1845 <div style="display:inline">
1846 (
1847 <span id="typeTemplate">
1848 <span style="">
1849 <span style="">string</span>
1850 </span>
1851 </span>
1852 )
1853 </div>
1854 </em>
1855 </dt>
1856 <dd style="">The URL to download.</dd>
1857 <!-- OBJECT PROPERTIES -->
1858 <!-- OBJECT METHODS -->
1859 <!-- OBJECT EVENT FIELDS -->
1860 <!-- FUNCTION PARAMETERS -->
1861 </div>
1862 </div><div style="">
1863 <div>
1864 <dt>
1865 <var style="">filename</var>
1866 <em>
1867 <!-- TYPE -->
1868 <div style="display:inline">
1869 (
1870 <span class="optional" style="">optional</span>
1871 <span id="typeTemplate">
1872 <span style="">
1873 <span style="">string</span>
1874 </span>
1875 </span>
1876 )
1877 </div>
1878 </em>
1879 </dt>
1880 <dd style="">A file path relative to the Downloads directory to contai n the downloaded file.</dd>
1881 <!-- OBJECT PROPERTIES -->
1882 <!-- OBJECT METHODS -->
1883 <!-- OBJECT EVENT FIELDS -->
1884 <!-- FUNCTION PARAMETERS -->
1885 </div>
1886 </div><div style="">
1887 <div>
1888 <dt>
1889 <var style="">saveAs</var>
1890 <em>
1891 <!-- TYPE -->
1892 <div style="display:inline">
1893 (
1894 <span class="optional" style="">optional</span>
1895 <span id="typeTemplate">
1896 <span style="">
1897 <span style="">boolean</span>
1898 </span>
1899 </span>
1900 )
1901 </div>
1902 </em>
1903 </dt>
1904 <dd style="">Use a file-chooser to allow the user to select a filename .</dd>
1905 <!-- OBJECT PROPERTIES -->
1906 <!-- OBJECT METHODS -->
1907 <!-- OBJECT EVENT FIELDS -->
1908 <!-- FUNCTION PARAMETERS -->
1909 </div>
1910 </div><div style="">
1911 <div>
1912 <dt>
1913 <var style="">method</var>
1914 <em>
1915 <!-- TYPE -->
1916 <div style="display:inline">
1917 (
1918 <span class="optional" style="">optional</span>
1919 <span class="enum" style="">enumerated</span>
1920 <span id="typeTemplate">
1921 <span style="">
1922 <span style="">string</span>
1923 <span style="">["GET", "POST"]</span>
1924 </span>
1925 </span>
1926 )
1927 </div>
1928 </em>
1929 </dt>
1930 <dd style="">The HTTP method to use if the URL uses the HTTP[S] protoc ol.</dd>
1931 <!-- OBJECT PROPERTIES -->
1932 <!-- OBJECT METHODS -->
1933 <!-- OBJECT EVENT FIELDS -->
1934 <!-- FUNCTION PARAMETERS -->
1935 </div>
1936 </div><div style="">
1937 <div>
1938 <dt>
1939 <var style="">headers</var>
1940 <em>
1941 <!-- TYPE -->
1942 <div style="display:inline">
1943 (
1944 <span class="optional" style="">optional</span>
1945 <span id="typeTemplate">
1946 <span style="">
1947 <a href="webRequest.html#type-HttpHeaders">HttpHeaders</ a>
1948 </span>
1949 </span>
1950 )
1951 </div>
1952 </em>
1953 </dt>
1954 <dd style="">Extra HTTP headers to send with the request if the URL us es the HTTP[s] protocol, restricted to those allowed by XMLHttpRequest.</dd>
1955 <!-- OBJECT PROPERTIES -->
1956 <!-- OBJECT METHODS -->
1957 <!-- OBJECT EVENT FIELDS -->
1958 <!-- FUNCTION PARAMETERS -->
1959 </div>
1960 </div><div style="">
1961 <div>
1962 <dt>
1963 <var style="">body</var>
1964 <em>
1965 <!-- TYPE -->
1966 <div style="display:inline">
1967 (
1968 <span class="optional" style="">optional</span>
1969 <span id="typeTemplate">
1970 <span style="">
1971 <span style="">string</span>
1972 </span>
1973 </span>
1974 )
1975 </div>
1976 </em>
1977 </dt>
1978 <dd style="">post body</dd>
1979 <!-- OBJECT PROPERTIES -->
1980 <!-- OBJECT METHODS -->
1981 <!-- OBJECT EVENT FIELDS -->
1982 <!-- FUNCTION PARAMETERS -->
1983 </div>
1984 </div>
1985 </dl>
1986 </dd>
1987 <!-- OBJECT METHODS -->
1988 <!-- OBJECT EVENT FIELDS -->
1989 <!-- FUNCTION PARAMETERS -->
1990 </div>
1991 </div><div class="apiItem" style="">
1992 <a name="type-DownloadQuery"></a>
1993 <h4>DownloadQuery</h4>
1994 <div>
1995 <dt>
1996 <em>
1997 <!-- TYPE -->
1998 <div style="display:inline">
1999 (
2000 <span id="typeTemplate">
2001 <span style="">
2002 <span style="">object</span>
2003 </span>
2004 </span>
2005 )
2006 </div>
2007 </em>
2008 </dt>
2009 <dd class="todo" style="">
2010 Undocumented.
2011 </dd>
2012 <!-- OBJECT PROPERTIES -->
2013 <dd style="">
2014 <dl>
2015 <div style="">
2016 <div>
2017 <dt>
2018 <var style="">query</var>
2019 <em>
2020 <!-- TYPE -->
2021 <div style="display:inline">
2022 (
2023 <span class="optional" style="">optional</span>
2024 <span id="typeTemplate">
2025 <span style="">
2026 <span style="">string</span>
2027 </span>
2028 </span>
2029 )
2030 </div>
2031 </em>
2032 </dt>
2033 <dd style="">This space-separated string of search terms that may be g rouped using quotation marks limits results to downloads whose filename or url c ontain all of the search terms that do not begin with a dash ‘-’ and none of the search terms that do begin with a dash.</dd>
2034 <!-- OBJECT PROPERTIES -->
2035 <!-- OBJECT METHODS -->
2036 <!-- OBJECT EVENT FIELDS -->
2037 <!-- FUNCTION PARAMETERS -->
2038 </div>
2039 </div><div style="">
2040 <div>
2041 <dt>
2042 <var style="">startedBefore</var>
2043 <em>
2044 <!-- TYPE -->
2045 <div style="display:inline">
2046 (
2047 <span class="optional" style="">optional</span>
2048 <span id="typeTemplate">
2049 <span style="">
2050 <span style="">integer</span>
2051 </span>
2052 </span>
2053 )
2054 </div>
2055 </em>
2056 </dt>
2057 <dd style="">Limits results to downloads that started before the given ms since the epoch.</dd>
2058 <!-- OBJECT PROPERTIES -->
2059 <!-- OBJECT METHODS -->
2060 <!-- OBJECT EVENT FIELDS -->
2061 <!-- FUNCTION PARAMETERS -->
2062 </div>
2063 </div><div style="">
2064 <div>
2065 <dt>
2066 <var style="">startedAfter</var>
2067 <em>
2068 <!-- TYPE -->
2069 <div style="display:inline">
2070 (
2071 <span class="optional" style="">optional</span>
2072 <span id="typeTemplate">
2073 <span style="">
2074 <span style="">integer</span>
2075 </span>
2076 </span>
2077 )
2078 </div>
2079 </em>
2080 </dt>
2081 <dd style="">Limits results to downloads that started after the given ms since the epoch.</dd>
2082 <!-- OBJECT PROPERTIES -->
2083 <!-- OBJECT METHODS -->
2084 <!-- OBJECT EVENT FIELDS -->
2085 <!-- FUNCTION PARAMETERS -->
2086 </div>
2087 </div><div style="">
2088 <div>
2089 <dt>
2090 <var style="">endedBefore</var>
2091 <em>
2092 <!-- TYPE -->
2093 <div style="display:inline">
2094 (
2095 <span class="optional" style="">optional</span>
2096 <span id="typeTemplate">
2097 <span style="">
2098 <span style="">integer</span>
2099 </span>
2100 </span>
2101 )
2102 </div>
2103 </em>
2104 </dt>
2105 <dd style="">Limits results to downloads that ended before the given m s since the epoch.</dd>
2106 <!-- OBJECT PROPERTIES -->
2107 <!-- OBJECT METHODS -->
2108 <!-- OBJECT EVENT FIELDS -->
2109 <!-- FUNCTION PARAMETERS -->
2110 </div>
2111 </div><div style="">
2112 <div>
2113 <dt>
2114 <var style="">endedAfter</var>
2115 <em>
2116 <!-- TYPE -->
2117 <div style="display:inline">
2118 (
2119 <span class="optional" style="">optional</span>
2120 <span id="typeTemplate">
2121 <span style="">
2122 <span style="">integer</span>
2123 </span>
2124 </span>
2125 )
2126 </div>
2127 </em>
2128 </dt>
2129 <dd style="">Limits results to downloads that ended after the given ms since the epoch.</dd>
2130 <!-- OBJECT PROPERTIES -->
2131 <!-- OBJECT METHODS -->
2132 <!-- OBJECT EVENT FIELDS -->
2133 <!-- FUNCTION PARAMETERS -->
2134 </div>
2135 </div><div style="">
2136 <div>
2137 <dt>
2138 <var style="">totalBytesGreater</var>
2139 <em>
2140 <!-- TYPE -->
2141 <div style="display:inline">
2142 (
2143 <span class="optional" style="">optional</span>
2144 <span id="typeTemplate">
2145 <span style="">
2146 <span style="">integer</span>
2147 </span>
2148 </span>
2149 )
2150 </div>
2151 </em>
2152 </dt>
2153 <dd style="">Limits results to downloads whose totalBytes is greater t han the given integer.</dd>
2154 <!-- OBJECT PROPERTIES -->
2155 <!-- OBJECT METHODS -->
2156 <!-- OBJECT EVENT FIELDS -->
2157 <!-- FUNCTION PARAMETERS -->
2158 </div>
2159 </div><div style="">
2160 <div>
2161 <dt>
2162 <var style="">totalBytesLess</var>
2163 <em>
2164 <!-- TYPE -->
2165 <div style="display:inline">
2166 (
2167 <span class="optional" style="">optional</span>
2168 <span id="typeTemplate">
2169 <span style="">
2170 <span style="">integer</span>
2171 </span>
2172 </span>
2173 )
2174 </div>
2175 </em>
2176 </dt>
2177 <dd style="">Limits results to downloads whose totalBytes is less than the given integer.</dd>
2178 <!-- OBJECT PROPERTIES -->
2179 <!-- OBJECT METHODS -->
2180 <!-- OBJECT EVENT FIELDS -->
2181 <!-- FUNCTION PARAMETERS -->
2182 </div>
2183 </div><div style="">
2184 <div>
2185 <dt>
2186 <var style="">filenameRegex</var>
2187 <em>
2188 <!-- TYPE -->
2189 <div style="display:inline">
2190 (
2191 <span class="optional" style="">optional</span>
2192 <span id="typeTemplate">
2193 <span style="">
2194 <span style="">string</span>
2195 </span>
2196 </span>
2197 )
2198 </div>
2199 </em>
2200 </dt>
2201 <dd style="">Limits results to downloads whose filename matches the gi ven regular expression.</dd>
2202 <!-- OBJECT PROPERTIES -->
2203 <!-- OBJECT METHODS -->
2204 <!-- OBJECT EVENT FIELDS -->
2205 <!-- FUNCTION PARAMETERS -->
2206 </div>
2207 </div><div style="">
2208 <div>
2209 <dt>
2210 <var style="">urlRegex</var>
2211 <em>
2212 <!-- TYPE -->
2213 <div style="display:inline">
2214 (
2215 <span class="optional" style="">optional</span>
2216 <span id="typeTemplate">
2217 <span style="">
2218 <span style="">string</span>
2219 </span>
2220 </span>
2221 )
2222 </div>
2223 </em>
2224 </dt>
2225 <dd style="">Limits results to downloads whose url matches the given r egular expression.</dd>
2226 <!-- OBJECT PROPERTIES -->
2227 <!-- OBJECT METHODS -->
2228 <!-- OBJECT EVENT FIELDS -->
2229 <!-- FUNCTION PARAMETERS -->
2230 </div>
2231 </div><div style="">
2232 <div>
2233 <dt>
2234 <var style="">limit</var>
2235 <em>
2236 <!-- TYPE -->
2237 <div style="display:inline">
2238 (
2239 <span class="optional" style="">optional</span>
2240 <span id="typeTemplate">
2241 <span style="">
2242 <span style="">integer</span>
2243 </span>
2244 </span>
2245 )
2246 </div>
2247 </em>
2248 </dt>
2249 <dd style="">Setting this integer limits the number of results. Otherw ise, all matching DownloadItems will be returned.</dd>
2250 <!-- OBJECT PROPERTIES -->
2251 <!-- OBJECT METHODS -->
2252 <!-- OBJECT EVENT FIELDS -->
2253 <!-- FUNCTION PARAMETERS -->
2254 </div>
2255 </div><div style="">
2256 <div>
2257 <dt>
2258 <var style="">orderBy</var>
2259 <em>
2260 <!-- TYPE -->
2261 <div style="display:inline">
2262 (
2263 <span class="optional" style="">optional</span>
2264 <span id="typeTemplate">
2265 <span style="">
2266 <span style="">string</span>
2267 </span>
2268 </span>
2269 )
2270 </div>
2271 </em>
2272 </dt>
2273 <dd style="">Setting this string to a DownloadItem property sorts the DownloadItems prior to applying the above filters. For example, setting |orderBy |=”startTime” sorts the DownloadItems by their start time in ascending order. To specify descending order, prefix |orderBy| with a hyphen: “-startTime”.</dd>
2274 <!-- OBJECT PROPERTIES -->
2275 <!-- OBJECT METHODS -->
2276 <!-- OBJECT EVENT FIELDS -->
2277 <!-- FUNCTION PARAMETERS -->
2278 </div>
2279 </div><div style="">
2280 <div>
2281 <dt>
2282 <var style="">id</var>
2283 <em>
2284 <!-- TYPE -->
2285 <div style="display:inline">
2286 (
2287 <span class="optional" style="">optional</span>
2288 <span id="typeTemplate">
2289 <span style="">
2290 <span style="">integer</span>
2291 </span>
2292 </span>
2293 )
2294 </div>
2295 </em>
2296 </dt>
2297 <dd style="">An identifier that is persistent across browser sessions. </dd>
2298 <!-- OBJECT PROPERTIES -->
2299 <!-- OBJECT METHODS -->
2300 <!-- OBJECT EVENT FIELDS -->
2301 <!-- FUNCTION PARAMETERS -->
2302 </div>
2303 </div><div style="">
2304 <div>
2305 <dt>
2306 <var style="">url</var>
2307 <em>
2308 <!-- TYPE -->
2309 <div style="display:inline">
2310 (
2311 <span class="optional" style="">optional</span>
2312 <span id="typeTemplate">
2313 <span style="">
2314 <span style="">string</span>
2315 </span>
2316 </span>
2317 )
2318 </div>
2319 </em>
2320 </dt>
2321 <dd style="">absolute URL</dd>
2322 <!-- OBJECT PROPERTIES -->
2323 <!-- OBJECT METHODS -->
2324 <!-- OBJECT EVENT FIELDS -->
2325 <!-- FUNCTION PARAMETERS -->
2326 </div>
2327 </div><div style="">
2328 <div>
2329 <dt>
2330 <var style="">filename</var>
2331 <em>
2332 <!-- TYPE -->
2333 <div style="display:inline">
2334 (
2335 <span class="optional" style="">optional</span>
2336 <span id="typeTemplate">
2337 <span style="">
2338 <span style="">string</span>
2339 </span>
2340 </span>
2341 )
2342 </div>
2343 </em>
2344 </dt>
2345 <dd style="">absolute local path</dd>
2346 <!-- OBJECT PROPERTIES -->
2347 <!-- OBJECT METHODS -->
2348 <!-- OBJECT EVENT FIELDS -->
2349 <!-- FUNCTION PARAMETERS -->
2350 </div>
2351 </div><div style="">
2352 <div>
2353 <dt>
2354 <var style="">danger</var>
2355 <em>
2356 <!-- TYPE -->
2357 <div style="display:inline">
2358 (
2359 <span class="optional" style="">optional</span>
2360 <span class="enum" style="">enumerated</span>
2361 <span id="typeTemplate">
2362 <span style="">
2363 <span style="">string</span>
2364 <span style="">["safe", "file", "url"]</span>
2365 </span>
2366 </span>
2367 )
2368 </div>
2369 </em>
2370 </dt>
2371 <dd style="">Indication of whether this download is thought to be safe or known to be suspicious.</dd>
2372 <!-- OBJECT PROPERTIES -->
2373 <!-- OBJECT METHODS -->
2374 <!-- OBJECT EVENT FIELDS -->
2375 <!-- FUNCTION PARAMETERS -->
2376 </div>
2377 </div><div style="">
2378 <div>
2379 <dt>
2380 <var style="">dangerAccepted</var>
2381 <em>
2382 <!-- TYPE -->
2383 <div style="display:inline">
2384 (
2385 <span class="optional" style="">optional</span>
2386 <span id="typeTemplate">
2387 <span style="">
2388 <span style="">boolean</span>
2389 </span>
2390 </span>
2391 )
2392 </div>
2393 </em>
2394 </dt>
2395 <dd style="">true if the user has accepted the download's danger.</dd>
2396 <!-- OBJECT PROPERTIES -->
2397 <!-- OBJECT METHODS -->
2398 <!-- OBJECT EVENT FIELDS -->
2399 <!-- FUNCTION PARAMETERS -->
2400 </div>
2401 </div><div style="">
2402 <div>
2403 <dt>
2404 <var style="">mime</var>
2405 <em>
2406 <!-- TYPE -->
2407 <div style="display:inline">
2408 (
2409 <span class="optional" style="">optional</span>
2410 <span id="typeTemplate">
2411 <span style="">
2412 <span style="">string</span>
2413 </span>
2414 </span>
2415 )
2416 </div>
2417 </em>
2418 </dt>
2419 <dd style="">The file's MIME type.</dd>
2420 <!-- OBJECT PROPERTIES -->
2421 <!-- OBJECT METHODS -->
2422 <!-- OBJECT EVENT FIELDS -->
2423 <!-- FUNCTION PARAMETERS -->
2424 </div>
2425 </div><div style="">
2426 <div>
2427 <dt>
2428 <var style="">startTime</var>
2429 <em>
2430 <!-- TYPE -->
2431 <div style="display:inline">
2432 (
2433 <span class="optional" style="">optional</span>
2434 <span id="typeTemplate">
2435 <span style="">
2436 <span style="">integer</span>
2437 </span>
2438 </span>
2439 )
2440 </div>
2441 </em>
2442 </dt>
2443 <dd style="">Number of milliseconds between the unix epoch and when th is download began.</dd>
2444 <!-- OBJECT PROPERTIES -->
2445 <!-- OBJECT METHODS -->
2446 <!-- OBJECT EVENT FIELDS -->
2447 <!-- FUNCTION PARAMETERS -->
2448 </div>
2449 </div><div style="">
2450 <div>
2451 <dt>
2452 <var style="">endTime</var>
2453 <em>
2454 <!-- TYPE -->
2455 <div style="display:inline">
2456 (
2457 <span class="optional" style="">optional</span>
2458 <span id="typeTemplate">
2459 <span style="">
2460 <span style="">integer</span>
2461 </span>
2462 </span>
2463 )
2464 </div>
2465 </em>
2466 </dt>
2467 <dd style="">Number of milliseconds between the unix epoch and when th is download ended.</dd>
2468 <!-- OBJECT PROPERTIES -->
2469 <!-- OBJECT METHODS -->
2470 <!-- OBJECT EVENT FIELDS -->
2471 <!-- FUNCTION PARAMETERS -->
2472 </div>
2473 </div><div style="">
2474 <div>
2475 <dt>
2476 <var style="">state</var>
2477 <em>
2478 <!-- TYPE -->
2479 <div style="display:inline">
2480 (
2481 <span class="optional" style="">optional</span>
2482 <span class="enum" style="">enumerated</span>
2483 <span id="typeTemplate">
2484 <span style="">
2485 <span style="">string</span>
2486 <span style="">["in_progress", "complete", "interrupted" ]</span>
2487 </span>
2488 </span>
2489 )
2490 </div>
2491 </em>
2492 </dt>
2493 <dd style="">Indicates whether the download is progressing, interrupte d, or complete.</dd>
2494 <!-- OBJECT PROPERTIES -->
2495 <!-- OBJECT METHODS -->
2496 <!-- OBJECT EVENT FIELDS -->
2497 <!-- FUNCTION PARAMETERS -->
2498 </div>
2499 </div><div style="">
2500 <div>
2501 <dt>
2502 <var style="">paused</var>
2503 <em>
2504 <!-- TYPE -->
2505 <div style="display:inline">
2506 (
2507 <span class="optional" style="">optional</span>
2508 <span id="typeTemplate">
2509 <span style="">
2510 <span style="">boolean</span>
2511 </span>
2512 </span>
2513 )
2514 </div>
2515 </em>
2516 </dt>
2517 <dd style="">true if the download has stopped reading data from the ho st, but kept the connection open.</dd>
2518 <!-- OBJECT PROPERTIES -->
2519 <!-- OBJECT METHODS -->
2520 <!-- OBJECT EVENT FIELDS -->
2521 <!-- FUNCTION PARAMETERS -->
2522 </div>
2523 </div><div style="">
2524 <div>
2525 <dt>
2526 <var style="">error</var>
2527 <em>
2528 <!-- TYPE -->
2529 <div style="display:inline">
2530 (
2531 <span class="optional" style="">optional</span>
2532 <span id="typeTemplate">
2533 <span style="">
2534 <span style="">integer</span>
2535 </span>
2536 </span>
2537 )
2538 </div>
2539 </em>
2540 </dt>
2541 <dd style="">Number indicating why a download was interrupted.</dd>
2542 <!-- OBJECT PROPERTIES -->
2543 <!-- OBJECT METHODS -->
2544 <!-- OBJECT EVENT FIELDS -->
2545 <!-- FUNCTION PARAMETERS -->
2546 </div>
2547 </div><div style="">
2548 <div>
2549 <dt>
2550 <var style="">bytesReceived</var>
2551 <em>
2552 <!-- TYPE -->
2553 <div style="display:inline">
2554 (
2555 <span class="optional" style="">optional</span>
2556 <span id="typeTemplate">
2557 <span style="">
2558 <span style="">integer</span>
2559 </span>
2560 </span>
2561 )
2562 </div>
2563 </em>
2564 </dt>
2565 <dd style="">Number of bytes received so far from the host, without co nsidering file compression.</dd>
2566 <!-- OBJECT PROPERTIES -->
2567 <!-- OBJECT METHODS -->
2568 <!-- OBJECT EVENT FIELDS -->
2569 <!-- FUNCTION PARAMETERS -->
2570 </div>
2571 </div><div style="">
2572 <div>
2573 <dt>
2574 <var style="">totalBytes</var>
2575 <em>
2576 <!-- TYPE -->
2577 <div style="display:inline">
2578 (
2579 <span class="optional" style="">optional</span>
2580 <span id="typeTemplate">
2581 <span style="">
2582 <span style="">integer</span>
2583 </span>
2584 </span>
2585 )
2586 </div>
2587 </em>
2588 </dt>
2589 <dd style="">Number of bytes in the whole file, without considering fi le compression, or -1 if unknown.</dd>
2590 <!-- OBJECT PROPERTIES -->
2591 <!-- OBJECT METHODS -->
2592 <!-- OBJECT EVENT FIELDS -->
2593 <!-- FUNCTION PARAMETERS -->
2594 </div>
2595 </div><div style="">
2596 <div>
2597 <dt>
2598 <var style="">fileSize</var>
2599 <em>
2600 <!-- TYPE -->
2601 <div style="display:inline">
2602 (
2603 <span class="optional" style="">optional</span>
2604 <span id="typeTemplate">
2605 <span style="">
2606 <span style="">integer</span>
2607 </span>
2608 </span>
2609 )
2610 </div>
2611 </em>
2612 </dt>
2613 <dd style="">Number of bytes in the whole file post-decompression, or -1 if unknown.</dd>
2614 <!-- OBJECT PROPERTIES -->
2615 <!-- OBJECT METHODS -->
2616 <!-- OBJECT EVENT FIELDS -->
2617 <!-- FUNCTION PARAMETERS -->
2618 </div>
2619 </div>
2620 </dl>
2621 </dd>
2622 <!-- OBJECT METHODS -->
2623 <!-- OBJECT EVENT FIELDS -->
2624 <!-- FUNCTION PARAMETERS -->
2625 </div>
2626 </div><div class="apiItem" style="">
2627 <a name="type-DownloadBooleanDiff"></a>
2628 <h4>DownloadBooleanDiff</h4>
2629 <div>
2630 <dt>
2631 <em>
2632 <!-- TYPE -->
2633 <div style="display:inline">
2634 (
2635 <span id="typeTemplate">
2636 <span style="">
2637 <span style="">object</span>
2638 </span>
2639 </span>
2640 )
2641 </div>
2642 </em>
2643 </dt>
2644 <dd style="">Encapsulates a change in a boolean DownloadItem field.</d d>
2645 <!-- OBJECT PROPERTIES -->
2646 <dd style="">
2647 <dl>
2648 <div style="">
2649 <div>
2650 <dt>
2651 <var style="">old</var>
2652 <em>
2653 <!-- TYPE -->
2654 <div style="display:inline">
2655 (
2656 <span class="optional" style="">optional</span>
2657 <span id="typeTemplate">
2658 <span style="">
2659 <span style="">boolean</span>
2660 </span>
2661 </span>
2662 )
2663 </div>
2664 </em>
2665 </dt>
2666 <dd class="todo" style="">
2667 Undocumented.
2668 </dd>
2669 <!-- OBJECT PROPERTIES -->
2670 <!-- OBJECT METHODS -->
2671 <!-- OBJECT EVENT FIELDS -->
2672 <!-- FUNCTION PARAMETERS -->
2673 </div>
2674 </div><div style="">
2675 <div>
2676 <dt>
2677 <var style="">new</var>
2678 <em>
2679 <!-- TYPE -->
2680 <div style="display:inline">
2681 (
2682 <span class="optional" style="">optional</span>
2683 <span id="typeTemplate">
2684 <span style="">
2685 <span style="">boolean</span>
2686 </span>
2687 </span>
2688 )
2689 </div>
2690 </em>
2691 </dt>
2692 <dd class="todo" style="">
2693 Undocumented.
2694 </dd>
2695 <!-- OBJECT PROPERTIES -->
2696 <!-- OBJECT METHODS -->
2697 <!-- OBJECT EVENT FIELDS -->
2698 <!-- FUNCTION PARAMETERS -->
2699 </div>
2700 </div>
2701 </dl>
2702 </dd>
2703 <!-- OBJECT METHODS -->
2704 <!-- OBJECT EVENT FIELDS -->
2705 <!-- FUNCTION PARAMETERS -->
2706 </div>
2707 </div><div class="apiItem" style="">
2708 <a name="type-DownloadIntegerDiff"></a>
2709 <h4>DownloadIntegerDiff</h4>
2710 <div>
2711 <dt>
2712 <em>
2713 <!-- TYPE -->
2714 <div style="display:inline">
2715 (
2716 <span id="typeTemplate">
2717 <span style="">
2718 <span style="">object</span>
2719 </span>
2720 </span>
2721 )
2722 </div>
2723 </em>
2724 </dt>
2725 <dd style="">Encapsulates a change in an integer DownloadItem field.</ dd>
2726 <!-- OBJECT PROPERTIES -->
2727 <dd style="">
2728 <dl>
2729 <div style="">
2730 <div>
2731 <dt>
2732 <var style="">old</var>
2733 <em>
2734 <!-- TYPE -->
2735 <div style="display:inline">
2736 (
2737 <span class="optional" style="">optional</span>
2738 <span id="typeTemplate">
2739 <span style="">
2740 <span style="">integer</span>
2741 </span>
2742 </span>
2743 )
2744 </div>
2745 </em>
2746 </dt>
2747 <dd class="todo" style="">
2748 Undocumented.
2749 </dd>
2750 <!-- OBJECT PROPERTIES -->
2751 <!-- OBJECT METHODS -->
2752 <!-- OBJECT EVENT FIELDS -->
2753 <!-- FUNCTION PARAMETERS -->
2754 </div>
2755 </div><div style="">
2756 <div>
2757 <dt>
2758 <var style="">new</var>
2759 <em>
2760 <!-- TYPE -->
2761 <div style="display:inline">
2762 (
2763 <span class="optional" style="">optional</span>
2764 <span id="typeTemplate">
2765 <span style="">
2766 <span style="">integer</span>
2767 </span>
2768 </span>
2769 )
2770 </div>
2771 </em>
2772 </dt>
2773 <dd class="todo" style="">
2774 Undocumented.
2775 </dd>
2776 <!-- OBJECT PROPERTIES -->
2777 <!-- OBJECT METHODS -->
2778 <!-- OBJECT EVENT FIELDS -->
2779 <!-- FUNCTION PARAMETERS -->
2780 </div>
2781 </div>
2782 </dl>
2783 </dd>
2784 <!-- OBJECT METHODS -->
2785 <!-- OBJECT EVENT FIELDS -->
2786 <!-- FUNCTION PARAMETERS -->
2787 </div>
2788 </div><div class="apiItem" style="">
2789 <a name="type-DownloadStringDiff"></a>
2790 <h4>DownloadStringDiff</h4>
2791 <div>
2792 <dt>
2793 <em>
2794 <!-- TYPE -->
2795 <div style="display:inline">
2796 (
2797 <span id="typeTemplate">
2798 <span style="">
2799 <span style="">object</span>
2800 </span>
2801 </span>
2802 )
2803 </div>
2804 </em>
2805 </dt>
2806 <dd style="">Encapsulates a change in a string DownloadItem field.</dd >
2807 <!-- OBJECT PROPERTIES -->
2808 <dd style="">
2809 <dl>
2810 <div style="">
2811 <div>
2812 <dt>
2813 <var style="">old</var>
2814 <em>
2815 <!-- TYPE -->
2816 <div style="display:inline">
2817 (
2818 <span class="optional" style="">optional</span>
2819 <span id="typeTemplate">
2820 <span style="">
2821 <span style="">string</span>
2822 </span>
2823 </span>
2824 )
2825 </div>
2826 </em>
2827 </dt>
2828 <dd class="todo" style="">
2829 Undocumented.
2830 </dd>
2831 <!-- OBJECT PROPERTIES -->
2832 <!-- OBJECT METHODS -->
2833 <!-- OBJECT EVENT FIELDS -->
2834 <!-- FUNCTION PARAMETERS -->
2835 </div>
2836 </div><div style="">
2837 <div>
2838 <dt>
2839 <var style="">new</var>
2840 <em>
2841 <!-- TYPE -->
2842 <div style="display:inline">
2843 (
2844 <span class="optional" style="">optional</span>
2845 <span id="typeTemplate">
2846 <span style="">
2847 <span style="">string</span>
2848 </span>
2849 </span>
2850 )
2851 </div>
2852 </em>
2853 </dt>
2854 <dd class="todo" style="">
2855 Undocumented.
2856 </dd>
2857 <!-- OBJECT PROPERTIES -->
2858 <!-- OBJECT METHODS -->
2859 <!-- OBJECT EVENT FIELDS -->
2860 <!-- FUNCTION PARAMETERS -->
2861 </div>
2862 </div>
2863 </dl>
2864 </dd>
2865 <!-- OBJECT METHODS -->
2866 <!-- OBJECT EVENT FIELDS -->
2867 <!-- FUNCTION PARAMETERS -->
2868 </div>
2869 </div><div class="apiItem" style="">
2870 <a name="type-DownloadDelta"></a>
2871 <h4>DownloadDelta</h4>
2872 <div>
2873 <dt>
2874 <em>
2875 <!-- TYPE -->
2876 <div style="display:inline">
2877 (
2878 <span id="typeTemplate">
2879 <span style="">
2880 <span style="">object</span>
2881 </span>
2882 </span>
2883 )
2884 </div>
2885 </em>
2886 </dt>
2887 <dd style="">Encapsulates a change in a DownloadItem.</dd>
2888 <!-- OBJECT PROPERTIES -->
2889 <dd style="">
2890 <dl>
2891 <div style="">
2892 <div>
2893 <dt>
2894 <var style="">id</var>
2895 <em>
2896 <!-- TYPE -->
2897 <div style="display:inline">
2898 (
2899 <span id="typeTemplate">
2900 <span style="">
2901 <span style="">integer</span>
2902 </span>
2903 </span>
2904 )
2905 </div>
2906 </em>
2907 </dt>
2908 <dd style="">An identifier that is persistent across browser sessions. </dd>
2909 <!-- OBJECT PROPERTIES -->
2910 <!-- OBJECT METHODS -->
2911 <!-- OBJECT EVENT FIELDS -->
2912 <!-- FUNCTION PARAMETERS -->
2913 </div>
2914 </div><div style="">
2915 <div>
2916 <dt>
2917 <var style="">url</var>
2918 <em>
2919 <!-- TYPE -->
2920 <div style="display:inline">
2921 (
2922 <span class="optional" style="">optional</span>
2923 <span id="typeTemplate">
2924 <span style="">
2925 <a href="experimental.downloads.html#type-DownloadString Diff">DownloadStringDiff</a>
2926 </span>
2927 </span>
2928 )
2929 </div>
2930 </em>
2931 </dt>
2932 <dd class="todo" style="">
2933 Undocumented.
2934 </dd>
2935 <!-- OBJECT PROPERTIES -->
2936 <!-- OBJECT METHODS -->
2937 <!-- OBJECT EVENT FIELDS -->
2938 <!-- FUNCTION PARAMETERS -->
2939 </div>
2940 </div><div style="">
2941 <div>
2942 <dt>
2943 <var style="">filename</var>
2944 <em>
2945 <!-- TYPE -->
2946 <div style="display:inline">
2947 (
2948 <span class="optional" style="">optional</span>
2949 <span id="typeTemplate">
2950 <span style="">
2951 <a href="experimental.downloads.html#type-DownloadString Diff">DownloadStringDiff</a>
2952 </span>
2953 </span>
2954 )
2955 </div>
2956 </em>
2957 </dt>
2958 <dd class="todo" style="">
2959 Undocumented.
2960 </dd>
2961 <!-- OBJECT PROPERTIES -->
2962 <!-- OBJECT METHODS -->
2963 <!-- OBJECT EVENT FIELDS -->
2964 <!-- FUNCTION PARAMETERS -->
2965 </div>
2966 </div><div style="">
2967 <div>
2968 <dt>
2969 <var style="">danger</var>
2970 <em>
2971 <!-- TYPE -->
2972 <div style="display:inline">
2973 (
2974 <span class="optional" style="">optional</span>
2975 <span id="typeTemplate">
2976 <span style="">
2977 <a href="experimental.downloads.html#type-DownloadString Diff">DownloadStringDiff</a>
2978 </span>
2979 </span>
2980 )
2981 </div>
2982 </em>
2983 </dt>
2984 <dd class="todo" style="">
2985 Undocumented.
2986 </dd>
2987 <!-- OBJECT PROPERTIES -->
2988 <!-- OBJECT METHODS -->
2989 <!-- OBJECT EVENT FIELDS -->
2990 <!-- FUNCTION PARAMETERS -->
2991 </div>
2992 </div><div style="">
2993 <div>
2994 <dt>
2995 <var style="">dangerAccepted</var>
2996 <em>
2997 <!-- TYPE -->
2998 <div style="display:inline">
2999 (
3000 <span class="optional" style="">optional</span>
3001 <span id="typeTemplate">
3002 <span style="">
3003 <a href="experimental.downloads.html#type-DownloadBoolea nDiff">DownloadBooleanDiff</a>
3004 </span>
3005 </span>
3006 )
3007 </div>
3008 </em>
3009 </dt>
3010 <dd class="todo" style="">
3011 Undocumented.
3012 </dd>
3013 <!-- OBJECT PROPERTIES -->
3014 <!-- OBJECT METHODS -->
3015 <!-- OBJECT EVENT FIELDS -->
3016 <!-- FUNCTION PARAMETERS -->
3017 </div>
3018 </div><div style="">
3019 <div>
3020 <dt>
3021 <var style="">mime</var>
3022 <em>
3023 <!-- TYPE -->
3024 <div style="display:inline">
3025 (
3026 <span class="optional" style="">optional</span>
3027 <span id="typeTemplate">
3028 <span style="">
3029 <a href="experimental.downloads.html#type-DownloadString Diff">DownloadStringDiff</a>
3030 </span>
3031 </span>
3032 )
3033 </div>
3034 </em>
3035 </dt>
3036 <dd class="todo" style="">
3037 Undocumented.
3038 </dd>
3039 <!-- OBJECT PROPERTIES -->
3040 <!-- OBJECT METHODS -->
3041 <!-- OBJECT EVENT FIELDS -->
3042 <!-- FUNCTION PARAMETERS -->
3043 </div>
3044 </div><div style="">
3045 <div>
3046 <dt>
3047 <var style="">startTime</var>
3048 <em>
3049 <!-- TYPE -->
3050 <div style="display:inline">
3051 (
3052 <span class="optional" style="">optional</span>
3053 <span id="typeTemplate">
3054 <span style="">
3055 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3056 </span>
3057 </span>
3058 )
3059 </div>
3060 </em>
3061 </dt>
3062 <dd class="todo" style="">
3063 Undocumented.
3064 </dd>
3065 <!-- OBJECT PROPERTIES -->
3066 <!-- OBJECT METHODS -->
3067 <!-- OBJECT EVENT FIELDS -->
3068 <!-- FUNCTION PARAMETERS -->
3069 </div>
3070 </div><div style="">
3071 <div>
3072 <dt>
3073 <var style="">endTime</var>
3074 <em>
3075 <!-- TYPE -->
3076 <div style="display:inline">
3077 (
3078 <span class="optional" style="">optional</span>
3079 <span id="typeTemplate">
3080 <span style="">
3081 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3082 </span>
3083 </span>
3084 )
3085 </div>
3086 </em>
3087 </dt>
3088 <dd class="todo" style="">
3089 Undocumented.
3090 </dd>
3091 <!-- OBJECT PROPERTIES -->
3092 <!-- OBJECT METHODS -->
3093 <!-- OBJECT EVENT FIELDS -->
3094 <!-- FUNCTION PARAMETERS -->
3095 </div>
3096 </div><div style="">
3097 <div>
3098 <dt>
3099 <var style="">state</var>
3100 <em>
3101 <!-- TYPE -->
3102 <div style="display:inline">
3103 (
3104 <span class="optional" style="">optional</span>
3105 <span id="typeTemplate">
3106 <span style="">
3107 <a href="experimental.downloads.html#type-DownloadString Diff">DownloadStringDiff</a>
3108 </span>
3109 </span>
3110 )
3111 </div>
3112 </em>
3113 </dt>
3114 <dd class="todo" style="">
3115 Undocumented.
3116 </dd>
3117 <!-- OBJECT PROPERTIES -->
3118 <!-- OBJECT METHODS -->
3119 <!-- OBJECT EVENT FIELDS -->
3120 <!-- FUNCTION PARAMETERS -->
3121 </div>
3122 </div><div style="">
3123 <div>
3124 <dt>
3125 <var style="">paused</var>
3126 <em>
3127 <!-- TYPE -->
3128 <div style="display:inline">
3129 (
3130 <span class="optional" style="">optional</span>
3131 <span id="typeTemplate">
3132 <span style="">
3133 <a href="experimental.downloads.html#type-DownloadBoolea nDiff">DownloadBooleanDiff</a>
3134 </span>
3135 </span>
3136 )
3137 </div>
3138 </em>
3139 </dt>
3140 <dd class="todo" style="">
3141 Undocumented.
3142 </dd>
3143 <!-- OBJECT PROPERTIES -->
3144 <!-- OBJECT METHODS -->
3145 <!-- OBJECT EVENT FIELDS -->
3146 <!-- FUNCTION PARAMETERS -->
3147 </div>
3148 </div><div style="">
3149 <div>
3150 <dt>
3151 <var style="">error</var>
3152 <em>
3153 <!-- TYPE -->
3154 <div style="display:inline">
3155 (
3156 <span class="optional" style="">optional</span>
3157 <span id="typeTemplate">
3158 <span style="">
3159 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3160 </span>
3161 </span>
3162 )
3163 </div>
3164 </em>
3165 </dt>
3166 <dd class="todo" style="">
3167 Undocumented.
3168 </dd>
3169 <!-- OBJECT PROPERTIES -->
3170 <!-- OBJECT METHODS -->
3171 <!-- OBJECT EVENT FIELDS -->
3172 <!-- FUNCTION PARAMETERS -->
3173 </div>
3174 </div><div style="">
3175 <div>
3176 <dt>
3177 <var style="">bytesReceived</var>
3178 <em>
3179 <!-- TYPE -->
3180 <div style="display:inline">
3181 (
3182 <span class="optional" style="">optional</span>
3183 <span id="typeTemplate">
3184 <span style="">
3185 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3186 </span>
3187 </span>
3188 )
3189 </div>
3190 </em>
3191 </dt>
3192 <dd class="todo" style="">
3193 Undocumented.
3194 </dd>
3195 <!-- OBJECT PROPERTIES -->
3196 <!-- OBJECT METHODS -->
3197 <!-- OBJECT EVENT FIELDS -->
3198 <!-- FUNCTION PARAMETERS -->
3199 </div>
3200 </div><div style="">
3201 <div>
3202 <dt>
3203 <var style="">totalBytes</var>
3204 <em>
3205 <!-- TYPE -->
3206 <div style="display:inline">
3207 (
3208 <span class="optional" style="">optional</span>
3209 <span id="typeTemplate">
3210 <span style="">
3211 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3212 </span>
3213 </span>
3214 )
3215 </div>
3216 </em>
3217 </dt>
3218 <dd class="todo" style="">
3219 Undocumented.
3220 </dd>
3221 <!-- OBJECT PROPERTIES -->
3222 <!-- OBJECT METHODS -->
3223 <!-- OBJECT EVENT FIELDS -->
3224 <!-- FUNCTION PARAMETERS -->
3225 </div>
3226 </div><div style="">
3227 <div>
3228 <dt>
3229 <var style="">fileSize</var>
3230 <em>
3231 <!-- TYPE -->
3232 <div style="display:inline">
3233 (
3234 <span class="optional" style="">optional</span>
3235 <span id="typeTemplate">
3236 <span style="">
3237 <a href="experimental.downloads.html#type-DownloadIntege rDiff">DownloadIntegerDiff</a>
3238 </span>
3239 </span>
3240 )
3241 </div>
3242 </em>
3243 </dt>
3244 <dd class="todo" style="">
3245 Undocumented.
3246 </dd>
3247 <!-- OBJECT PROPERTIES -->
3248 <!-- OBJECT METHODS -->
3249 <!-- OBJECT EVENT FIELDS -->
3250 <!-- FUNCTION PARAMETERS -->
3251 </div>
3252 </div>
3253 </dl>
3254 </dd>
3255 <!-- OBJECT METHODS -->
3256 <!-- OBJECT EVENT FIELDS -->
3257 <!-- FUNCTION PARAMETERS -->
3258 </div>
3259 </div><div class="apiItem" style="">
3260 <a name="type-DownloadFileIconOptions"></a>
3261 <h4>DownloadFileIconOptions</h4>
3262 <div>
3263 <dt>
3264 <em>
3265 <!-- TYPE -->
3266 <div style="display:inline">
3267 (
3268 <span id="typeTemplate">
3269 <span style="">
3270 <span style="">object</span>
3271 </span>
3272 </span>
3273 )
3274 </div>
3275 </em>
3276 </dt>
3277 <dd style="">Options for fetching the file icon for a download. See ch rome.experimental.downloads.getFileIcon.</dd>
3278 <!-- OBJECT PROPERTIES -->
3279 <dd style="">
3280 <dl>
3281 <div style="">
3282 <div>
3283 <dt>
3284 <var style="">size</var>
3285 <em>
3286 <!-- TYPE -->
3287 <div style="display:inline">
3288 (
3289 <span class="optional" style="">optional</span>
3290 <span class="enum" style="">enumerated</span>
3291 <span id="typeTemplate">
3292 <span style="">
3293 <span style="">integer</span>
3294 <span style="">[16, 32]</span>
3295 </span>
3296 </span>
3297 )
3298 </div>
3299 </em>
3300 </dt>
3301 <dd style="">The size of the icon. The returned icon will be square w ith dimensions size * size pixels. The default size for the icon is 32x32 pixel s.</dd>
3302 <!-- OBJECT PROPERTIES -->
3303 <!-- OBJECT METHODS -->
3304 <!-- OBJECT EVENT FIELDS -->
3305 <!-- FUNCTION PARAMETERS -->
3306 </div>
3307 </div>
3308 </dl>
3309 </dd>
3310 <!-- OBJECT METHODS -->
3311 <!-- OBJECT EVENT FIELDS -->
3312 <!-- FUNCTION PARAMETERS -->
3313 </div>
3314 </div> <!-- /apiItem -->
3315 </div> <!-- /apiGroup -->
3316 </div> <!-- /apiPage -->
3317 </div> <!-- /gc-pagecontent -->
3318 </div> <!-- /g-section -->
3319 </div> <!-- /codesiteContent -->
3320 <div id="gc-footer" --="">
3321 <div class="text">
3322 <p>
3323 Except as otherwise <a href="http://code.google.com/policies.html#restrictions ">noted</a>,
3324 the content of this page is licensed under the <a rel="license" href="http://c reativecommons.org/licenses/by/3.0/">Creative Commons
3325 Attribution 3.0 License</a>, and code samples are licensed under the
3326 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic ense</a>.
3327 </p>
3328 <p>
3329 ©2011 Google
3330 </p>
3331 <!-- begin analytics -->
3332 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript"> </script>
3333 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc ript>
3334 <script type="text/javascript">
3335 // chrome doc tracking
3336 try {
3337 var engdocs = _gat._getTracker("YT-10763712-2");
3338 engdocs._trackPageview();
3339 } catch(err) {}
3340 // code.google.com site-wide tracking
3341 try {
3342 _uacct="UA-18071-1";
3343 _uanchor=1;
3344 _uff=0;
3345 urchinTracker();
3346 }
3347 catch(e) {/* urchinTracker not available. */}
3348 </script>
3349 <!-- end analytics -->
3350 </div>
3351 </div> <!-- /gc-footer -->
3352 </div> <!-- /gc-container -->
3353 </body></html>
OLDNEW
« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/themes.html » ('J')

Powered by Google App Engine
This is Rietveld 408576698