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

« chrome/common/extensions/api/experimental.downloads.json ('K') | « chrome/common/extensions/docs/experimental.html ('k') | chrome/common/extensions/docs/samples.html » ('j') | chrome/common/extensions/docs/static/experimental.downloads.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..d979ea2ac091d78ed7429ad39e80c2adf0939d42

--- /dev/null

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

@@ -0,0 +1,733 @@

+<!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">

+ <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">

+ <h2>Contents</h2>

+ <ol>

+ <li>

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

+ <ol>

+ <li>

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

+ <ol>

+ <li>

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

+ </li><li>

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

+ </li>

+ </ol>

+ </li>

+ <li>

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

+ <ol>

+ <li>

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

+ </li>

+ </ol>

+ </li>

+ <li>

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

+ <ol>

+ </ol>

+ </li>

+ <li>

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

+ <ol>

+ <li>

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

+ <ol>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </li>

+ </ol>

+ </div>

+

+

+ <p id="classSummary">

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

+ </p>

+

+ <div id="static">The downloads API allows you to programmatically initiate downloads, examine and monitor properties of downloads, and manipulate downloads.

+</div>

+

+ <div class="apiPage">

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

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

+

+ <div class="apiGroup">

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

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

+ <div>

+ <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>ERROR_GENERIC</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>Generic error.</dd>

+

+

+

+

+ </div>

+ </div><div>

+ <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>ERROR_INVALID_URL</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div>

+

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

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

+ <h3>Methods</h3>

+

+ <div class="apiItem">

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

+ <h4>download</h4>

+ <div class="summary">

+

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

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

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

+ <div class="description">

+ <p>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, <code>callback</code> will be called with the new DownloadItem’s <code>id</code>. If there was an error starting the download, then <code>callback</code> will be called with <code>downloadId=undefined</code> and chrome.extension.lastError will be set. If the URL’s hostname is not specified in the <code>permissions</code> section of the extension’s manifest, then the <code>chrome.extensions.lastError</code> object will indicate that the extension does not have permission to access that hostname. <code>downloads.ERROR_*</code> are some of the errors that may be returned via <code>chrome.extensions.lastError</code>.</p>

+

+ <h4>Parameters</h4>

+ <dl>

+ <div>

+ <dt>

+ <var>options</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>object</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+ <dd>

+ <dl>

+ <div>

+ <dt>

+ <var>url</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>filename</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>saveAs</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ <span>boolean</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>method</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

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

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>headers</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

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

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>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>

+ <div>

+ <dt>

+ <var>body</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>post body</dd>

+

+

+

+

+ </div>

+ </dl>

+ </dd>

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>callback</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ <span>function</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd class="todo">

+ Undocumented.

+ </dd>

+

+

+

+

+ </div>

+ </dl>

+

+ <dl>

+ </dl>

+

+ <div>

+ <h4>Callback function</h4>

+ <p>

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

+ specify a function that looks like this:

+ </p>

+

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

+ <dl>

+ <div>

+ <dt>

+ <var>downloadId</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>integer</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </dl>

+ </div>

+

+ </div>

+ </div>

+ </div>

+

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

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

+ <h3>Events</h3>

+

+

+ </div>

+

+ <div class="apiGroup">

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

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

+

+ <div class="apiItem">

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

+ <h4>HttpHeaders</h4>

+ <div>

+ <dt>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ array of <span><span>

+ <span>

+ <span>object</span>

+ </span>

+ </span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>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>

+ <dl>

+ <div>

+ <dt>

+ <var>name</var>

+ <em>

+

+ <div style="display:inline">

+ (

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>value</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ <span>string</span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

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

+

+

+

+

+ </div>

+ </div><div>

+ <div>

+ <dt>

+ <var>binaryValue</var>

+ <em>

+

+ <div style="display:inline">

+ (

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

+ <span id="typeTemplate">

+ <span>

+ array of <span><span>

+ <span>

+ <span>integer</span>

+ </span>

+ </span></span>

+ </span>

+ )

+ </div>

+ </em>

+ </dt>

+ <dd>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>

+ </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>