chrome/common/extensions/docs/fileBrowserHandler.html - Issue 10642015: Basic setup for generating app docs

Unified Diff: chrome/common/extensions/docs/fileBrowserHandler.html

Issue 10642015: Basic setup for generating app docs (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 8 years, 6 months ago

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

Jump to:

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

Index: chrome/common/extensions/docs/fileBrowserHandler.html

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

deleted file mode 100644

index 26b706598e5bc926b5fb9f852ffec0136f7db758..0000000000000000000000000000000000000000

--- a/chrome/common/extensions/docs/fileBrowserHandler.html

+++ /dev/null

@@ -1,771 +0,0 @@

-<!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="../../../../third_party/json_minify/minify-sans-regexp.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.fileBrowserHandler module, which is part of the Google Chrome extension APIs."><title>chrome.fileBrowserHandler - 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.fileBrowserHandler</h1>

- </div>

-

- <div id="toc">

- <h2>Contents</h2>

- <ol>

- <li>

- <a href="#manifest">Manifest</a>

- <ol>

- </ol>

- </li><li>

- <a href="#code">Implementing a file browser handler</a>

- <ol>

- </ol>

- </li>

- <li>

- <a href="#apiReference">API reference: chrome.fileBrowserHandler</a>

- <ol>

- <li>

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

- <ol>

- <li>

- <a href="#method-selectFile">selectFile</a>

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

- <a href="#event-onExecute">onExecute</a>

- </li>

- </ol>

- </li>

- <li>

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

- <ol>

- <li>

- <a href="#type-FileHandlerExecuteEventDetails">FileHandlerExecuteEventDetails</a>

- <ol>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </li>

- </ol>

- </div>

-

-

-

- <div id="static">

-<p id="classSummary">

-Use the <code>chrome.fileBrowserHandler</code> module to

-extend the Chrome OS file browser.

-For example, you can use this API

-to enable users to upload files to your website.

-</p>

-<p class="caution">

-<b>Important:</b>

-This API works <b>only on Chrome OS</b>.

-</p>

-<p>

-The Chrome OS file browser comes up when

-the user either presses Ctrl+M

-or connects an external storage device,

-such as an SD card, USB key, external drive, or digital camera.

-Besides showing the files on external devices,

-the file browser can also display files

-that the user has previously saved to the system.

-</p>

-<p>

-When the user selects one or more files,

-the file browser adds buttons

-representing the valid handlers for those files.

-For example, in the following screenshot,

-selecting a file with a ".jpg" suffix

-results in an "Upload to Picasa" button that the user can click.

-</p>

-<p>

-<img src="images/filebrowserhandler.png" width="640" height="400" alt="file browser screenshot">

-</p>

-<h2 id="manifest">Manifest</h2>

-<p>

-You must declare the "fileBrowserHandler" permission

-in the <a href="manifest.html">extension manifest</a>,

-and you must use the "file_browser_handlers" field

-to register the extension as a handler of at least one file type.

-You should also provide a 16x16 icon

-to be displayed on the button.

-For example:

-</p>

-<pre>{

- "name": "My extension",

- ...

- <b>"file_browser_handlers"</b>: [

- {

- <b>"id"</b>: "upload",

- <b>"default_title"</b>: "Save to Gallery", <em>// What the button will display</em>

- <b>"file_filters"</b>: [

- "filesystem:*.jpg", <em>// To match all files, use "filesystem:*.*"</em>

- "filesystem:*.jpeg",

- "filesystem:*.png"

- ]

- }

- ],

- "permissions" : [

- <b>"fileBrowserHandler"</b>

- ],

- "icons": { <b>"16"</b>: "icon16.png",

- "48": "icon48.png",

- "128": "icon128.png" },

- ...

-}</pre>

-<p class="note">

-<b>Note:</b>

-You can specify locale-specific strings for the value of "default_title".

-See <a href="i18n.html">Internationalization (i18n)</a> for details.

-</p>

-<h2 id="code">Implementing a file browser handler</h2>

-<p>

-To use this API,

-you must implement a function that handles the <code>onExecute</code> event

-of <code>chrome.fileBrowserHandler</code>.

-Your function will be called whenever the user clicks the button

-that represents your file browser handler.

-In your function, use the HTML5

-<a href="http://www.html5rocks.com/tutorials/file/filesystem/">FileSystem API</a>

-to get access to the file contents.

-Here is an example:

-</p>

-<pre><em>//In background.html:</em>

-chrome.fileBrowserHandler.onExecute.addListener(function(id, details) {

- if (id == 'upload') {

- var fileEntries = details.entries;

- for (var i = 0, entry; entry = fileEntries[i]; ++i) {

- entry.file(function(file) {

- <em>// send file somewhere</em>

- });

- }

-});

-</pre>

-<p>

-Your event handler is passed two arguments:

-</p>

-<dl>

- <dt> id </dt>

- <dd> The "id" value from the manifest file.

- If your extension implements multiple handlers,

- you can check the <code>id</code> value

- to see which handler has been triggered.

- </dd>

- <dt> details </dt>

- <dd> An object describing the event.

- You can get the file or files that the user has selected

- from the <code>entries</code> field of this object,

- which is an array of

- FileSystem <code>Entry</code> objects.

- </dd>

-<p></p>

-<!--

-<h2 id="manifest_details">Manifest details</h2>

-<p class="authornote">

-{PENDING: give details about "id" and "default_title".

-It should be unique within your extension -- don't worry about other extensions.

-"default_title" implies that you can change the title,

-but you can't aside from internationalizing it.

-</p>

-<p class="authornote">

-{PENDING: give details about the file_filters entry.

-File filters are currently case-sensitive, but we plan to change that.

-Mention <code>filesystem:*.*</code>.

-</p>

--->

-<!--

-<h2 id="examples">Examples</h2>

-<p>

-For examples of using this API, see ...

-For other examples and for help in viewing the source code, see

-<a href="samples.html">Samples</a>.

-</p>

--->

-

-</dl></div>

-

- <div class="apiPage">

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

- <h2>API reference: chrome.fileBrowserHandler</h2>

-

-

-

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

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

- <h3>Methods</h3>

-

- <div class="apiItem">

- <a name="method-selectFile"></a>

- <h4>selectFile</h4>

- <div class="summary">

-

- <span>chrome.fileBrowserHandler.selectFile</span>(<span class="null"><span>object</span>

- <var><span>selectionParams</span></var></span><span class="null"><span>, </span><span>function</span>

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

- <div class="description">

- <p>Prompts user to select file path under which a new file will be created. When the user selects file, the file gets created or, if it already existed, truncated. The function has to be called with a user gesture.</p>

-

- <h4>Parameters</h4>

- <dl>

- <div>

- <dt>

- <var>selectionParams</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Parameters that will be used to create a new file.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>suggestedName</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Suggested name for the new file.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>callback</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>function</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Function called upon completion.</dd>

-

-

-

-

- </div>

- </dl>

-

- <dl>

- </dl>

-

- <div>

- <h4>Callback function</h4>

- <p>

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

- that looks like this:

- </p>

-

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

- <dl>

- <div>

- <dt>

- <var>result</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Result of the method.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>success</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>boolean</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Has the file been selected.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>entry</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Selected file entry. It will be null if a file hasn't been selected.</dd>

-

-

-

-

- </div>

- </dl>

- </dd>

-

-

-

- </div>

- </dl>

- </div>

-

- </div>

- </div>

- </div>

-

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

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

- <h3>Events</h3>

-

- <div class="apiItem">

- <a name="event-onExecute"></a>

- <h4>onExecute</h4>

- <div class="summary">

-

- <span class="subdued">chrome.fileBrowserHandler.</span><span>onExecute</span><span class="subdued">.addListener</span>(function(<span>string id, FileHandlerExecuteEventDetails details</span>) <span class="subdued">{...}</span><span></span>);

- </div>

- <div class="description">

- <p>Fired when file system action is executed from ChromeOS file browser.</p>

-

- <div>

- <h4>Listener parameters</h4>

- <dl>

- <div>

- <dt>

- <var>id</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>string</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>File browser action id as specified in the listener component's manifest.</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>details</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <a href="fileBrowserHandler.html#type-FileHandlerExecuteEventDetails">FileHandlerExecuteEventDetails</a>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>File handler execute event details.</dd>

-

-

-

-

- </div>

- </dl>

- </div>

-

-

- <dl>

- </dl>

- </div>

-

- </div>

- </div>

-

- <div class="apiGroup">

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

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

-

- <div class="apiItem">

- <a name="type-FileHandlerExecuteEventDetails"></a>

- <h4>FileHandlerExecuteEventDetails</h4>

- <div>

- <dt>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- <span>object</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Event details payload for fileBrowserHandler.onExecute event.</dd>

-

- <dd>

- <dl>

- <div>

- <dt>

- <var>entries</var>

- <em>

-

- <div style="display:inline">

- (

- <span id="typeTemplate">

- <span>

- array of <span><span>

- <span>

- <span>any</span>

- </span>

- </span></span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>Array of Entry instances representing files that are targets of this action (selected in ChromeOS file browser).</dd>

-

-

-

-

- </div>

- </div><div>

- <div>

- <dt>

- <var>tab_id</var>

- <em>

-

- <div style="display:inline">

- (

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

- <span id="typeTemplate">

- <span>

- <span>integer</span>

- </span>

- )

- </div>

- </em>

- </dt>

- <dd>The ID of the tab that raised this event. Tab IDs are unique within a browser session.</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/faq.html ('k') | chrome/common/extensions/docs/fileSystem.html » ('j') | no next file with comments »