chrome/common/extensions/docs/experimental.downloads.html - Issue 9452019: experimental.downloads extension api docs

Unified Diff: chrome/common/extensions/docs/experimental.downloads.html

Issue 9452019: experimental.downloads extension api docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 10 months ago

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

Jump to:

View side-by-side diff with in-line comments

« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/themes.html » ('J')
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: chrome/common/extensions/docs/experimental.downloads.html

diff --git a/chrome/common/extensions/docs/experimental.downloads.html b/chrome/common/extensions/docs/experimental.downloads.html

new file mode 100644

index 0000000000000000000000000000000000000000..ad633d81d0a30d4c9ba721dde20359e33a51d90c

--- /dev/null

+++ b/chrome/common/extensions/docs/experimental.downloads.html

@@ -0,0 +1,3353 @@

+<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note:

+ 1) The <head> information in this page is significant, should be uniform

+ across api docs and should be edited only with knowledge of the

+ templating mechanism.

+ 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a

+ browser, it will be re-generated from the template, json schema and

+ authored overview content.

+ 4) The <body>.innerHTML is also generated by an offline step so that this

+ page may easily be indexed by search engines.

+--><html xmlns="http://www.w3.org/1999/xhtml"><head>

+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

+ <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css">

+ <link href="css/print.css" rel="stylesheet" type="text/css" media="print">

+ <script type="text/javascript" src="../../../third_party/jstemplate/jstemplate_compiled.js">

+ </script>

+ <script type="text/javascript" src="js/api_page_generator.js"></script>

+ <script type="text/javascript" src="js/bootstrap.js"></script>

+ <script type="text/javascript" src="js/sidebar.js"></script>

+ <meta name="description" content="Documentation for the chrome.experimental.downloads module, which is part of the Google Chrome extension APIs."><title>chrome.experimental.downloads - Google Chrome Extensions - Google Code</title></head>

+ <body> <div id="devModeWarning" class="displayModeWarning">

+ You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files.

+ </div>

+ <div id="branchWarning" class="displayModeWarning">

+ <span>WARNING: This is the <span id="branchName">BETA</span> documentation.

+ It may not work with the stable release of Chrome.</span>

+ <select id="branchChooser">

+ <option>Choose a different version...

+ </option><option value="">Stable

+ </option><option value="beta">Beta

+ </option><option value="dev">Dev

+ </option><option value="trunk">Trunk

+ </option></select>

+ </div>

+ <div id="unofficialWarning" class="displayModeWarning">

+ <span>WARNING: This is unofficial documentation. It may not work with the

+ current release of Chrome.</span>

+ <button id="goToOfficialDocs">Go to the official docs</button>

+ </div>

+ <div id="gc-container" class="labs">

+

+ <!-- In particular, sub-templates that recurse, must be used by allowing

+ jstemplate to make a copy of the template in this section which

+ are not operated on by way of the jsskip="true" -->

+

+ <a id="top"></a>

+ <div id="skipto">

+ <a href="#gc-pagecontent">Skip to page content</a>

+ <a href="#gc-toc">Skip to main navigation</a>

+ </div>

+

+ <table id="header" width="100%" cellspacing="0" border="0">

+ <tbody><tr>

+ <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td>

+ <td valign="middle" width="100%" style="padding-left:0.6em;">

+ <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em">

+ <div id="gsc-search-box">

+ <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno">

+ <input type="hidden" name="ie" value="UTF-8">

+ <input type="text" name="q" value="" size="55">

+ <input class="gsc-search-button" type="submit" name="sa" value="Search">

+ <br>

+ <span class="greytext">e.g. "page action" or "tabs"</span>

+ </div>

+ </form>

+ <script type="text/javascript" src="https://www.google.com/jsapi"></script>

+ <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script>

+ <script type="text/javascript" src="https://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script>

+ <script type="text/javascript" src="https://www.google.com/coop/cse/brand?form=cse&lang=en"></script>

+ </td>

+ </tr>

+ </tbody></table>

+ <div id="codesiteContent" class="">

+ <a id="gc-topnav-anchor"></a>

+ <div id="gc-topnav">

+ <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1>

+ <ul id="home" class="gc-topnav-tabs">

+ <li id="home_link">

+ <a href="index.html" title="Google Chrome Extensions home page">Home</a>

+ </li>

+ <li id="docs_link">

+ <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a>

+ </li>

+ <li id="faq_link">

+ <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a>

+ </li>

+ <li id="samples_link">

+ <a href="samples.html" title="Sample extensions (with source code)">Samples</a>

+ </li>

+ <li id="group_link">

+ <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a>

+ </li>

+ <li id="so_link">

+ <a href="http://stackoverflow.com/questions/tagged/google-chrome-extension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a>

+ </li>

+ </ul>

+ </div>

+ <div class="g-section g-tpl-170">

+

+ <div class="g-unit g-first" id="gc-toc" style="">

+ <ul>

+ <li><a href="getstarted.html">Getting Started</a></li>

+ <li><a href="overview.html">Overview</a></li>

+ <li><a href="whats_new.html">What's New?</a></li>

+ <li><h2><a href="devguide.html">Developer's Guide</a></h2>

+ <ul>

+ <li>Browser UI

+ <ul>

+ <li><a href="browserAction.html">Browser Actions</a></li>

+ <li><a href="contextMenus.html">Context Menus</a></li>

+ <li><a href="notifications.html">Desktop Notifications</a></li>

+ <li><a href="omnibox.html">Omnibox</a></li>

+ <li><a href="options.html">Options Pages</a></li>

+ <li><a href="override.html">Override Pages</a></li>

+ <li><a href="pageAction.html">Page Actions</a></li>

+ </ul>

+ </li>

+ <li>Browser Interaction

+ <ul>

+ <li><a href="bookmarks.html">Bookmarks</a></li>

+ <li><a href="cookies.html">Cookies</a></li>

+ <li><a href="devtools.html">Developer Tools</a></li>

+ <li><a href="events.html">Events</a></li>

+ <li><a href="history.html">History</a></li>

+ <li><a href="management.html">Management</a></li>

+ <li><a href="tabs.html">Tabs</a></li>

+ <li><a href="windows.html">Windows</a></li>

+ </ul>

+ </li>

+ <li>Implementation

+ <ul>

+ <li><a href="a11y.html">Accessibility</a></li>

+ <li><a href="background_pages.html">Background Pages</a></li>

+ <li><a href="content_scripts.html">Content Scripts</a></li>

+ <li><a href="xhr.html">Cross-Origin XHR</a></li>

+ <li><a href="i18n.html">Internationalization</a></li>

+ <li><a href="messaging.html">Message Passing</a></li>

+ <li><a href="permissions.html">Optional Permissions</a></li>

+ <li><a href="npapi.html">NPAPI Plugins</a></li>

+ </ul>

+ </li>

+ <li>Finishing

+ <ul>

+ <li><a href="hosting.html">Hosting</a></li>

+ <li><a href="external_extensions.html">Other Deployment Options</a></li>

+ </ul>

+ </li>

+ </ul>

+ </li>

+ <li><h2><a href="apps.html">Packaged Apps</a></h2></li>

+ <li><h2><a href="tutorials.html">Tutorials</a></h2>

+ <ul>

+ <li><a href="tut_debugging.html">Debugging</a></li>

+ <li><a href="tut_analytics.html">Google Analytics</a></li>

+ <li><a href="tut_oauth.html">OAuth</a></li>

+ </ul>

+ </li>

+ <li><h2>Reference</h2>

+ <ul>

+ <li>Formats

+ <ul>

+ <li><a href="manifest.html">Manifest Files</a></li>

+ <li><a href="match_patterns.html">Match Patterns</a></li>

+ </ul>

+ </li>

+ <li><a href="permission_warnings.html">Permission Warnings</a></li>

+ <li><a href="api_index.html">chrome.* APIs</a></li>

+ <li><a href="api_other.html">Other APIs</a></li>

+ </ul>

+ </li>

+ <li><h2><a href="samples.html">Samples</a></h2></li>

+ <div class="line"> </div>

+ <li><h2>More</h2>

+ <ul>

+ <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li>

+ <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li>

+ <li><a href="themes.html">Themes</a></li>

+ </ul>

+ </li>

+ </ul>

+ </div>

+ <script>

+ initToggles();

+ </script>

+ <div class="g-unit" id="gc-pagecontent">

+ <div id="pageTitle">

+ <h1 class="page_title">chrome.experimental.downloads</h1>

+ </div>

+

+ <div id="toc" style="">

+ <h2>Contents</h2>

+ <ol>

+ <li style="">

+ <a href="#apiReference">API reference: chrome.experimental.downloads</a>

+ <ol>

+ <li style="">

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

+ <ol>

+ <li style="">

+ <a href="#property-STATE_IN_PROGRESS">STATE_IN_PROGRESS</a>

+ </li><li style="">

+ <a href="#property-STATE_INTERRUPTED">STATE_INTERRUPTED</a>

+ </li><li style="">

+ <a href="#property-STATE_COMPLETE">STATE_COMPLETE</a>

+ </li><li style="">

+ <a href="#property-DANGER_SAFE">DANGER_SAFE</a>

+ </li><li style="">

+ <a href="#property-DANGER_FILE">DANGER_FILE</a>

+ </li><li style="">

+ <a href="#property-DANGER_URL">DANGER_URL</a>

+ </li><li style="">

+ <a href="#property-DANGER_CONTENT">DANGER_CONTENT</a>

+ </li><li style="">

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

+ </li><li style="">

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

+ </li><li style="">

+ <a href="#property-ERROR_INVALID_OPERATION">ERROR_INVALID_OPERATION</a>

+ </li>

+ </ol>

+ </li>

+ <li style="">

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

+ <ol>

+ <li style="">

+ <a href="#method-cancel">cancel</a>

+ </li><li style="">

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

+ </li><li style="">

+ <a href="#method-getFileIcon">getFileIcon</a>

+ </li><li style="">

+ <a href="#method-pause">pause</a>

+ </li><li style="">

+ <a href="#method-resume">resume</a>

+ </li><li style="">

+ <a href="#method-search">search</a>

+ </li>

+ </ol>

+ </li>

+ <li style="">

+ <a href="#global-events">Events</a>

+ <ol>

+ <li style="">

+ <a href="#event-onChanged">onChanged</a>

+ </li><li style="">

+ <a href="#event-onCreated">onCreated</a>

+ </li><li style="">

+ <a href="#event-onErased">onErased</a>

+ </li>

+ </ol>

+ </li>

+ <li style="">

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

+ <ol>

+ <li style="">

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

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadItem">DownloadItem</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadOptions">DownloadOptions</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadQuery">DownloadQuery</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadBooleanDiff">DownloadBooleanDiff</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadStringDiff">DownloadStringDiff</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadDelta">DownloadDelta</a>

+ <ol>

+ </ol>

+ </li><li style="">

+ <a href="#type-DownloadFileIconOptions">DownloadFileIconOptions</a>

+ <ol>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </div>

+

+

+ <p id="classSummary" style="">

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

+ </p>

+

+ <div id="static"></div>

+

+ <div class="apiPage" style="">

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

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

+

+ <div class="apiGroup" style="">

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

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

+ <div style="">

+ <a name="property-STATE_IN_PROGRESS"></a>

+ <h4>STATE_IN_PROGRESS</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>STATE_IN_PROGRESS</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">STATE_IN_PROGRESS</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"in_progress"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The download is currently receiving data from the server.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-STATE_INTERRUPTED"></a>

+ <h4>STATE_INTERRUPTED</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>STATE_INTERRUPTED</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">STATE_INTERRUPTED</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"interrupted"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">An error broke the connection with the file host.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-STATE_COMPLETE"></a>

+ <h4>STATE_COMPLETE</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>STATE_COMPLETE</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">STATE_COMPLETE</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"complete"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The download has completed.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-DANGER_SAFE"></a>

+ <h4>DANGER_SAFE</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>DANGER_SAFE</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">DANGER_SAFE</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"safe"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The file has been determined to present no known danger to the user's computer.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-DANGER_FILE"></a>

+ <h4>DANGER_FILE</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>DANGER_FILE</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">DANGER_FILE</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"file"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The download's filename is suspicious.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-DANGER_URL"></a>

+ <h4>DANGER_URL</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>DANGER_URL</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">DANGER_URL</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"url"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The download's URL is malicious.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-DANGER_CONTENT"></a>

+ <h4>DANGER_CONTENT</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>DANGER_CONTENT</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">DANGER_CONTENT</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"content"</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The download's content is malicious.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

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

+ <h4>ERROR_GENERIC</h4>

+ <div class="summary">

+

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

+ </div>

+ <div>

+ <dt>

+ <var style="">ERROR_GENERIC</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"I'm afraid I can't do that."</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Generic error.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

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

+ <h4>ERROR_INVALID_URL</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_URL</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">ERROR_INVALID_URL</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"Invalid URL."</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The URL was invalid.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <a name="property-ERROR_INVALID_OPERATION"></a>

+ <h4>ERROR_INVALID_OPERATION</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.</span><span>ERROR_INVALID_OPERATION</span>

+ </div>

+ <div>

+ <dt>

+ <var style="">ERROR_INVALID_OPERATION</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <code style="">"Invalid operation."</code>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The requested operation cannot be performed at this time. This maybe due to the download being in a state where the requested operation is not allowed.</dd>

+

+

+

+

+ </div>

+ </div>

+

+ <div id="methodsTemplate" class="apiGroup" style="">

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

+ <h3>Methods</h3>

+

+ <div class="apiItem" style="">

+ <a name="method-cancel"></a>

+ <h4>cancel</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.cancel</span>(<span style="" class="null"><span>integer</span>

+ <var><span>id</span></var></span><span style="" class="optional"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Cancel a download.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Called when the request is completed. The download is cancelled, completed, interrupted or doesn't exist anymore.</dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

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

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ </dl>

+ </div>

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="method-download"></a>

+ <h4>download</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.download</span>(<span style="" class="null"><span>DownloadOptions</span>

+ <var><span>options</span></var></span><span style="" class="optional"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Download a URL. If the URL uses the HTTP[S] protocol, then the request will include all cookies currently set for its hostname. If the download started successfully, |callback| will be called with the new DownloadItem’s |id|. If there was an error starting the download, then |callback| will be called with |downloadId|=undefined and chrome.extension.lastError will be set. If the URL’s hostname is not specified in the |permissions| section of the extension’s manifest, then the |chrome.extensions.lastError| object will indicate that the extension does not have permission to access that hostname.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">options</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadOptions">DownloadOptions</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

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

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span>integer id</span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="method-getFileIcon"></a>

+ <h4>getFileIcon</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.getFileIcon</span>(<span style="" class="null"><span>integer</span>

+ <var><span>id</span></var></span><span style="" class="null"><span style="">, </span><span>DownloadFileIconOptions</span>

+ <var><span>options</span></var></span><span style="" class="null"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Retrieve an icon for the specified download. For new downloads, file icons are available after the onCreated event has been received. The image returned by this function while a download is in progress may be different from the image returned after the download is complete. Icon retrieval is done by querying the underlying operating system or toolkit 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.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The identifier for the download.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">options</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadFileIconOptions">DownloadFileIconOptions</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Options for the returned image.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

+ The callback <em>parameter</em> should specify a function

+ that looks like this:

+ </p>

+

+ <pre>function(<span>string iconURL</span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">iconURL</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">A URL to an image that represents the download. If a file icon cannot be determined, chrome.extension.lastError will contain an error message.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="method-pause"></a>

+ <h4>pause</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.pause</span>(<span style="" class="null"><span>integer</span>

+ <var><span>id</span></var></span><span style="" class="optional"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Pause the download.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Called when the pause request is completed. If the request was successful the download is in a paused state. Otherwise chrome.extension.lastError contains an error message. The request will fail if the download is not active.</dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

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

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ </dl>

+ </div>

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="method-resume"></a>

+ <h4>resume</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.resume</span>(<span style="" class="null"><span>integer</span>

+ <var><span>id</span></var></span><span style="" class="optional"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Resume a paused download.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Called when the resume request is completed. If the request was successful the download is in progress and unpaused. Otherwise chrome.extension.lastError contains an error message. The request will fail if the download is not active.</dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

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

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ </dl>

+ </div>

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="method-search"></a>

+ <h4>search</h4>

+ <div class="summary">

+

+ <span>chrome.experimental.downloads.search</span>(<span style="" class="null"><span>DownloadQuery</span>

+ <var><span>query</span></var></span><span style="" class="optional"><span style="">, </span><span>function</span>

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

+ <div class="description">

+ <p style="">Find DownloadItems. Set |query| to the empty object to get all DownloadItems. To get a specific DownloadItem, set only the |id| field.</p>

+

+ <h4 style="">Parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">query</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadQuery">DownloadQuery</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div style="">

+ <h4>Callback function</h4>

+ <p style="">

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

+ specify a function that looks like this:

+ </p>

+

+ <pre>function(<span>null</span>) <span class="subdued">{...}</span>;</pre>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">items</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ array of

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+ </div>

+ </div>

+ </div>

+

+ <div id="eventsTemplate" class="apiGroup" style="">

+ <a name="global-events"></a>

+ <h3>Events</h3>

+

+ <div class="apiItem" style="">

+ <a name="event-onChanged"></a>

+ <h4>onChanged</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.downloads.</span><span>onChanged</span><span class="subdued">.addListener</span>(function(<span>DownloadDelta downloadDelta</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p style="">When any of a DownloadItem's properties except |bytesReceived| changes, this event fires with the download id and an object containing the properties that changed.</p>

+

+ <div style="">

+ <h4>Listener parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">downloadDelta</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadDelta">DownloadDelta</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+

+ <dl>

+ </dl>

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="event-onCreated"></a>

+ <h4>onCreated</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.downloads.</span><span>onCreated</span><span class="subdued">.addListener</span>(function(<span>DownloadItem downloadItem</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p style="">This event fires with the DownloadItem object when a download begins.</p>

+

+ <div style="">

+ <h4>Listener parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">downloadItem</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadItem">DownloadItem</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+

+ <dl>

+ </dl>

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="event-onErased"></a>

+ <h4>onErased</h4>

+ <div class="summary">

+

+ <span class="subdued">chrome.experimental.downloads.</span><span>onErased</span><span class="subdued">.addListener</span>(function(<span>integer downloadId</span>) <span class="subdued">{...}</span><span></span>);

+ </div>

+ <div class="description">

+ <p style="">Fires with the download id when a download is erased from history.</p>

+

+ <div style="">

+ <h4>Listener parameters</h4>

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">downloadId</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+

+ <dl>

+ </dl>

+ </div>

+ </div>

+ </div>

+

+ <div class="apiGroup" style="">

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

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

+

+ <div class="apiItem" style="">

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

+ <h4>HttpHeaders</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ array of <span style=""><span>

+ <span style="">

+ <span style="">object</span>

+ </span>

+ </span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">An array of HTTP headers. Each header is represented as a dictionary containing the keys <code>name</code> and either <code>value</code> or <code>binaryValue</code>.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">name</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Name of the HTTP header.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">value</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Value of the HTTP header if it can be represented by UTF-8.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">binaryValue</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ array of <span style=""><span>

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ </span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Value of the HTTP header if it cannot be represented by UTF-8, stored as individual byte values (0..255).</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadItem"></a>

+ <h4>DownloadItem</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The state of a file as it is downloaded from the internet.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">An identifier that is persistent across browser sessions.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">url</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">absolute URL</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">filename</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">absolute local path</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">danger</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ <span style="">["safe", "file", "url", "content"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Indication of whether this download is thought to be safe or known to be suspicious.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">dangerAccepted</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">true if the user has accepted the download's danger.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">mime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The file's MIME type.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">startTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of milliseconds between the unix epoch and when this download began.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">endTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of milliseconds between the unix epoch and when this download ended.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">state</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ <span style="">["in_progress", "complete", "interrupted"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Indicates whether the download is progressing, interrupted, or complete.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">paused</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">true if the download has stopped reading data from the host, but kept the connection open.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">error</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number indicating why a download was interrupted.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">bytesReceived</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes received so far from the host, without considering file compression.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">totalBytes</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes in the whole file, without considering file compression, or -1 if unknown.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">fileSize</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes in the whole file post-decompression, or -1 if unknown.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadOptions"></a>

+ <h4>DownloadOptions</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">url</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The URL to download.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">filename</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">A file path relative to the Downloads directory to contain the downloaded file.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">saveAs</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Use a file-chooser to allow the user to select a filename.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">method</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ <span style="">["GET", "POST"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The HTTP method to use if the URL uses the HTTP[S] protocol.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">headers</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Extra HTTP headers to send with the request if the URL uses the HTTP[s] protocol, restricted to those allowed by XMLHttpRequest.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">body</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">post body</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadQuery"></a>

+ <h4>DownloadQuery</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">query</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">This space-separated string of search terms that may be grouped using quotation marks limits results to downloads whose filename or url contain all of the search terms that do not begin with a dash ‘-’ and none of the search terms that do begin with a dash.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">startedBefore</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads that started before the given ms since the epoch.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">startedAfter</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads that started after the given ms since the epoch.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">endedBefore</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads that ended before the given ms since the epoch.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">endedAfter</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads that ended after the given ms since the epoch.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">totalBytesGreater</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads whose totalBytes is greater than the given integer.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">totalBytesLess</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads whose totalBytes is less than the given integer.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">filenameRegex</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads whose filename matches the given regular expression.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">urlRegex</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Limits results to downloads whose url matches the given regular expression.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">limit</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Setting this integer limits the number of results. Otherwise, all matching DownloadItems will be returned.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">orderBy</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Setting this string to a DownloadItem property sorts the DownloadItems prior to applying the above filters. For example, setting |orderBy|=”startTime” sorts the DownloadItems by their start time in ascending order. To specify descending order, prefix |orderBy| with a hyphen: “-startTime”.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">An identifier that is persistent across browser sessions.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">url</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">absolute URL</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">filename</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">absolute local path</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">danger</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ <span style="">["safe", "file", "url"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Indication of whether this download is thought to be safe or known to be suspicious.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">dangerAccepted</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">true if the user has accepted the download's danger.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">mime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The file's MIME type.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">startTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of milliseconds between the unix epoch and when this download began.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">endTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of milliseconds between the unix epoch and when this download ended.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">state</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ <span style="">["in_progress", "complete", "interrupted"]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Indicates whether the download is progressing, interrupted, or complete.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">paused</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">true if the download has stopped reading data from the host, but kept the connection open.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">error</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number indicating why a download was interrupted.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">bytesReceived</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes received so far from the host, without considering file compression.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">totalBytes</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes in the whole file, without considering file compression, or -1 if unknown.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">fileSize</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Number of bytes in the whole file post-decompression, or -1 if unknown.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadBooleanDiff"></a>

+ <h4>DownloadBooleanDiff</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Encapsulates a change in a boolean DownloadItem field.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">old</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">new</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadIntegerDiff"></a>

+ <h4>DownloadIntegerDiff</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Encapsulates a change in an integer DownloadItem field.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">old</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">new</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadStringDiff"></a>

+ <h4>DownloadStringDiff</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Encapsulates a change in a string DownloadItem field.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">old</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">new</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadDelta"></a>

+ <h4>DownloadDelta</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Encapsulates a change in a DownloadItem.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">id</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">An identifier that is persistent across browser sessions.</dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">url</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadStringDiff">DownloadStringDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">filename</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadStringDiff">DownloadStringDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">danger</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadStringDiff">DownloadStringDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">dangerAccepted</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadBooleanDiff">DownloadBooleanDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">mime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadStringDiff">DownloadStringDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">startTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">endTime</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">state</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadStringDiff">DownloadStringDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">paused</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadBooleanDiff">DownloadBooleanDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">error</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">bytesReceived</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">totalBytes</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </div><div style="">

+ <div>

+ <dt>

+ <var style="">fileSize</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span id="typeTemplate">

+ <span style="">

+ <a href="experimental.downloads.html#type-DownloadIntegerDiff">DownloadIntegerDiff</a>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo" style="">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div class="apiItem" style="">

+ <a name="type-DownloadFileIconOptions"></a>

+ <h4>DownloadFileIconOptions</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">Options for fetching the file icon for a download. See chrome.experimental.downloads.getFileIcon.</dd>

+

+ <dd style="">

+ <dl>

+ <div style="">

+ <div>

+ <dt>

+ <var style="">size</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span class="optional" style="">optional</span>

+ <span class="enum" style="">enumerated</span>

+ <span id="typeTemplate">

+ <span style="">

+ <span style="">integer</span>

+ <span style="">[16, 32]</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd style="">The size of the icon. The returned icon will be square with dimensions size * size pixels. The default size for the icon is 32x32 pixels.</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div>

+ </div>

+ </div>

+ </div>

+ </div>

+ </div>

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

+ <div class="text">

+ <p>

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

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

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

+ <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>.

+ </p>

+ <p>

+ </p>

+

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

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

+<script type="text/javascript">

+ // chrome doc tracking

+ try {

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

+ engdocs._trackPageview();

+ } catch(err) {}

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

+ try {

+ _uacct="UA-18071-1";

+ _uanchor=1;

+ _uff=0;

+ urchinTracker();

+ }

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

+</script>

+

+ </div>

+ </div>

+ </div>

+</body></html>

« no previous file with comments | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.json » ('j') | chrome/common/extensions/docs/themes.html » ('J')