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

Issues Search
    My Issues | Starred     Open | Closed | All

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

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

Powered by Google App Engine
This is Rietveld 408576698