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

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

Powered by Google App Engine
This is Rietveld 408576698