OLD | NEW |
| (Empty) |
1 <!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc.
Note: | |
2 1) The <head> information in this page is significant, should be uniform | |
3 across api docs and should be edited only with knowledge of the | |
4 templating mechanism. | |
5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a | |
6 browser, it will be re-generated from the template, json schema and | |
7 authored overview content. | |
8 4) The <body>.innerHTML is also generated by an offline step so that this | |
9 page may easily be indexed by search engines. | |
10 --><html xmlns="http://www.w3.org/1999/xhtml"><head> | |
11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> | |
12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> | |
13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> | |
14 <script type="text/javascript" src="../../../third_party/jstemplate/jstempla
te_compiled.js"> | |
15 </script> | |
16 <script type="text/javascript" src="../../../../third_party/json_minify/mini
fy-sans-regexp.js"> | |
17 </script> | |
18 <script type="text/javascript" src="js/api_page_generator.js"></script> | |
19 <script type="text/javascript" src="js/bootstrap.js"></script> | |
20 <script type="text/javascript" src="js/sidebar.js"></script> | |
21 <meta name="description" content="Documentation for the chrome.fileBrowserHand
ler module, which is part of the Google Chrome extension APIs."><title>chrome.f
ileBrowserHandler - Google Chrome Extensions - Google Code</title></head> | |
22 <body> <div id="devModeWarning" class="displayModeWarning"> | |
23 You are viewing extension docs in chrome via the 'file:' scheme: are you exp
ecting to see local changes when you refresh? You'll need run chrome with --allo
w-file-access-from-files. | |
24 </div> | |
25 <div id="branchWarning" class="displayModeWarning"> | |
26 <span>WARNING: This is the <span id="branchName">BETA</span> documentation. | |
27 It may not work with the stable release of Chrome.</span> | |
28 <select id="branchChooser"> | |
29 <option>Choose a different version... | |
30 </option><option value="">Stable | |
31 </option><option value="beta">Beta | |
32 </option><option value="dev">Dev | |
33 </option><option value="trunk">Trunk | |
34 </option></select> | |
35 </div> | |
36 <div id="unofficialWarning" class="displayModeWarning"> | |
37 <span>WARNING: This is unofficial documentation. It may not work with the | |
38 current release of Chrome.</span> | |
39 <button id="goToOfficialDocs">Go to the official docs</button> | |
40 </div> | |
41 <div id="gc-container" class="labs"> | |
42 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> | |
43 <!-- In particular, sub-templates that recurse, must be used by allowing | |
44 jstemplate to make a copy of the template in this section which | |
45 are not operated on by way of the jsskip="true" --> | |
46 <!-- /SUBTEMPLATES --> | |
47 <a id="top"></a> | |
48 <div id="skipto"> | |
49 <a href="#gc-pagecontent">Skip to page content</a> | |
50 <a href="#gc-toc">Skip to main navigation</a> | |
51 </div> | |
52 <!-- API HEADER --> | |
53 <table id="header" width="100%" cellspacing="0" border="0"> | |
54 <tbody><tr> | |
55 <td valign="middle"><a href="http://code.google.com/"><img src="images/c
ode_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:
0; margin:0;"></a></td> | |
56 <td valign="middle" width="100%" style="padding-left:0.6em;"> | |
57 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.
5em"> | |
58 <div id="gsc-search-box"> | |
59 <input type="hidden" name="cx" value="002967670403910741006:61_cvz
fqtno"> | |
60 <input type="hidden" name="ie" value="UTF-8"> | |
61 <input type="text" name="q" value="" size="55"> | |
62 <input class="gsc-search-button" type="submit" name="sa" value="Se
arch"> | |
63 <br> | |
64 <span class="greytext">e.g. "page action" or "tabs"</span> | |
65 </div> | |
66 </form> | |
67 <script type="text/javascript" src="https://www.google.com/jsapi"></sc
ript> | |
68 <script type="text/javascript">google.load("elements", "1", {packages:
"transliteration"});</script> | |
69 <script type="text/javascript" src="https://www.google.com/coop/cse/t1
3n?form=cse&t13n_langs=en"></script> | |
70 <script type="text/javascript" src="https://www.google.com/coop/cse/br
and?form=cse&lang=en"></script> | |
71 </td> | |
72 </tr> | |
73 </tbody></table> | |
74 <div id="codesiteContent" class=""> | |
75 <a id="gc-topnav-anchor"></a> | |
76 <div id="gc-topnav"> | |
77 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Lab
s</a>)</h1> | |
78 <ul id="home" class="gc-topnav-tabs"> | |
79 <li id="home_link"> | |
80 <a href="index.html" title="Google Chrome Extensions home page">Home
</a> | |
81 </li> | |
82 <li id="docs_link"> | |
83 <a href="docs.html" title="Official Google Chrome Extensions documen
tation">Docs</a> | |
84 </li> | |
85 <li id="faq_link"> | |
86 <a href="faq.html" title="Answers to frequently asked questions abou
t Google Chrome Extensions">FAQ</a> | |
87 </li> | |
88 <li id="samples_link"> | |
89 <a href="samples.html" title="Sample extensions (with source code)">
Samples</a> | |
90 </li> | |
91 <li id="group_link"> | |
92 <a href="http://groups.google.com/a/chromium.org/group/chromium-exte
nsions" title="Google Chrome Extensions developer forum">Group</a> | |
93 </li> | |
94 <li id="so_link"> | |
95 <a href="http://stackoverflow.com/questions/tagged/google-chrome-ext
ension" title="[google-chrome-extension] tag on Stack Overflow">Questions?</a> | |
96 </li> | |
97 </ul> | |
98 </div> <!-- end gc-topnav --> | |
99 <div class="g-section g-tpl-170"> | |
100 <!-- SIDENAV --> | |
101 <div class="g-unit g-first" id="gc-toc"> | |
102 <ul> | |
103 <li><a href="getstarted.html">Getting Started</a></li> | |
104 <li><a href="overview.html">Overview</a></li> | |
105 <li><a href="whats_new.html">What's New?</a></li> | |
106 <li><h2><a href="devguide.html">Developer's Guide</a></h2> | |
107 <ul> | |
108 <li>Browser UI | |
109 <ul> | |
110 <li><a href="browserAction.html">Browser Actions</a></li> | |
111 <li><a href="contextMenus.html">Context Menus</a></li> | |
112 <li><a href="notifications.html">Desktop Notifications</a></li
> | |
113 <li><a href="omnibox.html">Omnibox</a></li> | |
114 <li><a href="options.html">Options Pages</a></li> | |
115 <li><a href="override.html">Override Pages</a></li> | |
116 <li><a href="pageAction.html">Page Actions</a></li> | |
117 </ul> | |
118 </li> | |
119 <li>Browser Interaction | |
120 <ul> | |
121 <li><a href="bookmarks.html">Bookmarks</a></li> | |
122 <li><a href="cookies.html">Cookies</a></li> | |
123 <li><a href="devtools.html">Developer Tools</a></li> | |
124 <li><a href="events.html">Events</a></li> | |
125 <li><a href="history.html">History</a></li> | |
126 <li><a href="management.html">Management</a></li> | |
127 <li><a href="tabs.html">Tabs</a></li> | |
128 <li><a href="windows.html">Windows</a></li> | |
129 </ul> | |
130 </li> | |
131 <li>Implementation | |
132 <ul> | |
133 <li><a href="a11y.html">Accessibility</a></li> | |
134 <li><a href="background_pages.html">Background Pages</a></li> | |
135 <li><a href="content_scripts.html">Content Scripts</a></li> | |
136 <li><a href="xhr.html">Cross-Origin XHR</a></li> | |
137 <li><a href="i18n.html">Internationalization</a></li> | |
138 <li><a href="messaging.html">Message Passing</a></li> | |
139 <li><a href="permissions.html">Optional Permissions</a></li> | |
140 <li><a href="npapi.html">NPAPI Plugins</a></li> | |
141 </ul> | |
142 </li> | |
143 <li>Finishing | |
144 <ul> | |
145 <li><a href="hosting.html">Hosting</a></li> | |
146 <li><a href="external_extensions.html">Other Deployment Option
s</a></li> | |
147 </ul> | |
148 </li> | |
149 </ul> | |
150 </li> | |
151 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> | |
152 <li><h2><a href="tutorials.html">Tutorials</a></h2> | |
153 <ul> | |
154 <li><a href="tut_debugging.html">Debugging</a></li> | |
155 <li><a href="tut_analytics.html">Google Analytics</a></li> | |
156 <li><a href="tut_oauth.html">OAuth</a></li> | |
157 </ul> | |
158 </li> | |
159 <li><h2>Reference</h2> | |
160 <ul> | |
161 <li>Formats | |
162 <ul> | |
163 <li><a href="manifest.html">Manifest Files</a></li> | |
164 <li><a href="match_patterns.html">Match Patterns</a></li> | |
165 </ul> | |
166 </li> | |
167 <li><a href="permission_warnings.html">Permission Warnings</a></li
> | |
168 <li><a href="api_index.html">chrome.* APIs</a></li> | |
169 <li><a href="api_other.html">Other APIs</a></li> | |
170 </ul> | |
171 </li> | |
172 <li><h2><a href="samples.html">Samples</a></h2></li> | |
173 <div class="line"> </div> | |
174 <li><h2>More</h2> | |
175 <ul> | |
176 <li><a href="http://code.google.com/chrome/webstore/docs/index.htm
l">Chrome Web Store</a></li> | |
177 <li><a href="http://code.google.com/chrome/apps/docs/developers_gu
ide.html">Hosted Apps</a></li> | |
178 <li><a href="themes.html">Themes</a></li> | |
179 </ul> | |
180 </li> | |
181 </ul> | |
182 </div> | |
183 <script> | |
184 initToggles(); | |
185 </script> | |
186 <div class="g-unit" id="gc-pagecontent"> | |
187 <div id="pageTitle"> | |
188 <h1 class="page_title">chrome.fileBrowserHandler</h1> | |
189 </div> | |
190 <!-- TABLE OF CONTENTS --> | |
191 <div id="toc"> | |
192 <h2>Contents</h2> | |
193 <ol> | |
194 <li> | |
195 <a href="#manifest">Manifest</a> | |
196 <ol> | |
197 </ol> | |
198 </li><li> | |
199 <a href="#code">Implementing a file browser handler</a> | |
200 <ol> | |
201 </ol> | |
202 </li> | |
203 <li> | |
204 <a href="#apiReference">API reference: chrome.fileBrowserHandler
</a> | |
205 <ol> | |
206 <li> | |
207 <a href="#global-methods">Methods</a> | |
208 <ol> | |
209 <li> | |
210 <a href="#method-selectFile">selectFile</a> | |
211 </li> | |
212 </ol> | |
213 </li> | |
214 <li> | |
215 <a href="#global-events">Events</a> | |
216 <ol> | |
217 <li> | |
218 <a href="#event-onExecute">onExecute</a> | |
219 </li> | |
220 </ol> | |
221 </li> | |
222 <li> | |
223 <a href="#types">Types</a> | |
224 <ol> | |
225 <li> | |
226 <a href="#type-FileHandlerExecuteEventDetails">FileHandlerExecut
eEventDetails</a> | |
227 <ol> | |
228 </ol> | |
229 </li> | |
230 </ol> | |
231 </li> | |
232 </ol> | |
233 </li> | |
234 </ol> | |
235 </div> | |
236 <!-- /TABLE OF CONTENTS --> | |
237 <!-- Standard content lead-in for experimental API pages --> | |
238 <!-- STATIC CONTENT PLACEHOLDER --> | |
239 <div id="static"><!-- BEGIN AUTHORED CONTENT --> | |
240 <p id="classSummary"> | |
241 Use the <code>chrome.fileBrowserHandler</code> module to | |
242 extend the Chrome OS file browser. | |
243 For example, you can use this API | |
244 to enable users to upload files to your website. | |
245 </p> | |
246 <p class="caution"> | |
247 <b>Important:</b> | |
248 This API works <b>only on Chrome OS</b>. | |
249 </p> | |
250 <p> | |
251 The Chrome OS file browser comes up when | |
252 the user either presses Ctrl+M | |
253 or connects an external storage device, | |
254 such as an SD card, USB key, external drive, or digital camera. | |
255 Besides showing the files on external devices, | |
256 the file browser can also display files | |
257 that the user has previously saved to the system. | |
258 </p> | |
259 <p> | |
260 When the user selects one or more files, | |
261 the file browser adds buttons | |
262 representing the valid handlers for those files. | |
263 For example, in the following screenshot, | |
264 selecting a file with a ".jpg" suffix | |
265 results in an "Upload to Picasa" button that the user can click. | |
266 </p> | |
267 <p> | |
268 <img src="images/filebrowserhandler.png" width="640" height="400" alt="file brow
ser screenshot"> | |
269 </p> | |
270 <h2 id="manifest">Manifest</h2> | |
271 <p> | |
272 You must declare the "fileBrowserHandler" permission | |
273 in the <a href="manifest.html">extension manifest</a>, | |
274 and you must use the "file_browser_handlers" field | |
275 to register the extension as a handler of at least one file type. | |
276 You should also provide a 16x16 icon | |
277 to be displayed on the button. | |
278 For example: | |
279 </p> | |
280 <pre>{ | |
281 "name": "My extension", | |
282 ... | |
283 <b>"file_browser_handlers"</b>: [ | |
284 { | |
285 <b>"id"</b>: "upload", | |
286 <b>"default_title"</b>: "Save to Gallery", <em>// What the button will dis
play</em> | |
287 <b>"file_filters"</b>: [ | |
288 "filesystem:*.jpg", <em>// To match all files, use "filesystem:*.*"</em> | |
289 "filesystem:*.jpeg", | |
290 "filesystem:*.png" | |
291 ] | |
292 } | |
293 ], | |
294 "permissions" : [ | |
295 <b>"fileBrowserHandler"</b> | |
296 ], | |
297 "icons": { <b>"16"</b>: "icon16.png", | |
298 "48": "icon48.png", | |
299 "128": "icon128.png" }, | |
300 ... | |
301 }</pre> | |
302 <p class="note"> | |
303 <b>Note:</b> | |
304 You can specify locale-specific strings for the value of "default_title". | |
305 See <a href="i18n.html">Internationalization (i18n)</a> for details. | |
306 </p> | |
307 <h2 id="code">Implementing a file browser handler</h2> | |
308 <p> | |
309 To use this API, | |
310 you must implement a function that handles the <code>onExecute</code> event | |
311 of <code>chrome.fileBrowserHandler</code>. | |
312 Your function will be called whenever the user clicks the button | |
313 that represents your file browser handler. | |
314 In your function, use the HTML5 | |
315 <a href="http://www.html5rocks.com/tutorials/file/filesystem/">FileSystem API</a
> | |
316 to get access to the file contents. | |
317 Here is an example: | |
318 </p> | |
319 <pre><em>//In background.html:</em> | |
320 chrome.fileBrowserHandler.onExecute.addListener(function(id, details) { | |
321 if (id == 'upload') { | |
322 var fileEntries = details.entries; | |
323 for (var i = 0, entry; entry = fileEntries[i]; ++i) { | |
324 entry.file(function(file) { | |
325 <em>// send file somewhere</em> | |
326 }); | |
327 } | |
328 } | |
329 }); | |
330 </pre> | |
331 <p> | |
332 Your event handler is passed two arguments: | |
333 </p> | |
334 <dl> | |
335 <dt> id </dt> | |
336 <dd> The "id" value from the manifest file. | |
337 If your extension implements multiple handlers, | |
338 you can check the <code>id</code> value | |
339 to see which handler has been triggered. | |
340 </dd> | |
341 <dt> details </dt> | |
342 <dd> An object describing the event. | |
343 You can get the file or files that the user has selected | |
344 from the <code>entries</code> field of this object, | |
345 which is an array of | |
346 FileSystem <code>Entry</code> objects. | |
347 </dd> | |
348 <p></p> | |
349 <!-- | |
350 <h2 id="manifest_details">Manifest details</h2> | |
351 <p class="authornote"> | |
352 {PENDING: give details about "id" and "default_title". | |
353 It should be unique within your extension -- don't worry about other extensions. | |
354 "default_title" implies that you can change the title, | |
355 but you can't aside from internationalizing it. | |
356 </p> | |
357 <p class="authornote"> | |
358 {PENDING: give details about the file_filters entry. | |
359 File filters are currently case-sensitive, but we plan to change that. | |
360 Mention <code>filesystem:*.*</code>. | |
361 </p> | |
362 --> | |
363 <!-- | |
364 <h2 id="examples">Examples</h2> | |
365 <p> | |
366 For examples of using this API, see ... | |
367 For other examples and for help in viewing the source code, see | |
368 <a href="samples.html">Samples</a>. | |
369 </p> | |
370 --> | |
371 <!-- END AUTHORED CONTENT --> | |
372 </dl></div> | |
373 <!-- API PAGE --> | |
374 <div class="apiPage"> | |
375 <a name="apiReference"></a> | |
376 <h2>API reference: chrome.fileBrowserHandler</h2> | |
377 <!-- PROPERTIES --> | |
378 <!-- /apiGroup --> | |
379 <!-- METHODS --> | |
380 <div id="methodsTemplate" class="apiGroup"> | |
381 <a name="global-methods"></a> | |
382 <h3>Methods</h3> | |
383 <!-- iterates over all functions --> | |
384 <div class="apiItem"> | |
385 <a name="method-selectFile"></a> <!-- method-anchor --> | |
386 <h4>selectFile</h4> | |
387 <div class="summary"> | |
388 <!-- Note: intentionally longer 80 columns --> | |
389 <span>chrome.fileBrowserHandler.selectFile</span>(<span class=
"null"><span>object</span> | |
390 <var><span>selectionParams</span></var></span><span class=
"null"><span>, </span><span>function</span> | |
391 <var><span>callback</span></var></span>)</div> | |
392 <div class="description"> | |
393 <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> | |
394 <!-- PARAMETERS --> | |
395 <h4>Parameters</h4> | |
396 <dl> | |
397 <div> | |
398 <div> | |
399 <dt> | |
400 <var>selectionParams</var> | |
401 <em> | |
402 <!-- TYPE --> | |
403 <div style="display:inline"> | |
404 ( | |
405 <span id="typeTemplate"> | |
406 <span> | |
407 <span>object</span> | |
408 </span> | |
409 </span> | |
410 ) | |
411 </div> | |
412 </em> | |
413 </dt> | |
414 <dd>Parameters that will be used to create a new file.</dd> | |
415 <!-- OBJECT PROPERTIES --> | |
416 <dd> | |
417 <dl> | |
418 <div> | |
419 <div> | |
420 <dt> | |
421 <var>suggestedName</var> | |
422 <em> | |
423 <!-- TYPE --> | |
424 <div style="display:inline"> | |
425 ( | |
426 <span id="typeTemplate"> | |
427 <span> | |
428 <span>string</span> | |
429 </span> | |
430 </span> | |
431 ) | |
432 </div> | |
433 </em> | |
434 </dt> | |
435 <dd>Suggested name for the new file.</dd> | |
436 <!-- OBJECT PROPERTIES --> | |
437 <!-- OBJECT METHODS --> | |
438 <!-- OBJECT EVENT FIELDS --> | |
439 <!-- FUNCTION PARAMETERS --> | |
440 </div> | |
441 </div> | |
442 </dl> | |
443 </dd> | |
444 <!-- OBJECT METHODS --> | |
445 <!-- OBJECT EVENT FIELDS --> | |
446 <!-- FUNCTION PARAMETERS --> | |
447 </div> | |
448 </div><div> | |
449 <div> | |
450 <dt> | |
451 <var>callback</var> | |
452 <em> | |
453 <!-- TYPE --> | |
454 <div style="display:inline"> | |
455 ( | |
456 <span id="typeTemplate"> | |
457 <span> | |
458 <span>function</span> | |
459 </span> | |
460 </span> | |
461 ) | |
462 </div> | |
463 </em> | |
464 </dt> | |
465 <dd>Function called upon completion.</dd> | |
466 <!-- OBJECT PROPERTIES --> | |
467 <!-- OBJECT METHODS --> | |
468 <!-- OBJECT EVENT FIELDS --> | |
469 <!-- FUNCTION PARAMETERS --> | |
470 </div> | |
471 </div> | |
472 </dl> | |
473 <!-- RETURNS --> | |
474 <dl> | |
475 </dl> | |
476 <!-- CALLBACK --> | |
477 <div> | |
478 <div> | |
479 <h4>Callback function</h4> | |
480 <p> | |
481 The <em>callback</em> parameter should specify a function | |
482 that looks like this: | |
483 </p> | |
484 <!-- Note: intentionally longer 80 columns --> | |
485 <pre>function(<span>object result</span>) <span class="subdued
">{...}</span>;</pre> | |
486 <dl> | |
487 <div> | |
488 <div> | |
489 <dt> | |
490 <var>result</var> | |
491 <em> | |
492 <!-- TYPE --> | |
493 <div style="display:inline"> | |
494 ( | |
495 <span id="typeTemplate"> | |
496 <span> | |
497 <span>object</span> | |
498 </span> | |
499 </span> | |
500 ) | |
501 </div> | |
502 </em> | |
503 </dt> | |
504 <dd>Result of the method.</dd> | |
505 <!-- OBJECT PROPERTIES --> | |
506 <dd> | |
507 <dl> | |
508 <div> | |
509 <div> | |
510 <dt> | |
511 <var>success</var> | |
512 <em> | |
513 <!-- TYPE --> | |
514 <div style="display:inline"> | |
515 ( | |
516 <span id="typeTemplate"> | |
517 <span> | |
518 <span>boolean</span> | |
519 </span> | |
520 </span> | |
521 ) | |
522 </div> | |
523 </em> | |
524 </dt> | |
525 <dd>Has the file been selected.</dd> | |
526 <!-- OBJECT PROPERTIES --> | |
527 <!-- OBJECT METHODS --> | |
528 <!-- OBJECT EVENT FIELDS --> | |
529 <!-- FUNCTION PARAMETERS --> | |
530 </div> | |
531 </div><div> | |
532 <div> | |
533 <dt> | |
534 <var>entry</var> | |
535 <em> | |
536 <!-- TYPE --> | |
537 <div style="display:inline"> | |
538 ( | |
539 <span class="optional">optional</span> | |
540 <span id="typeTemplate"> | |
541 <span> | |
542 <span>object</span> | |
543 </span> | |
544 </span> | |
545 ) | |
546 </div> | |
547 </em> | |
548 </dt> | |
549 <dd>Selected file entry. It will be null if a file hasn't been selecte
d.</dd> | |
550 <!-- OBJECT PROPERTIES --> | |
551 <!-- OBJECT METHODS --> | |
552 <!-- OBJECT EVENT FIELDS --> | |
553 <!-- FUNCTION PARAMETERS --> | |
554 </div> | |
555 </div> | |
556 </dl> | |
557 </dd> | |
558 <!-- OBJECT METHODS --> | |
559 <!-- OBJECT EVENT FIELDS --> | |
560 <!-- FUNCTION PARAMETERS --> | |
561 </div> | |
562 </div> | |
563 </dl> | |
564 </div> | |
565 </div> | |
566 <!-- MIN_VERSION --> | |
567 </div> <!-- /description --> | |
568 </div> <!-- /apiItem --> | |
569 </div> <!-- /apiGroup --> | |
570 <!-- EVENTS --> | |
571 <div id="eventsTemplate" class="apiGroup"> | |
572 <a name="global-events"></a> | |
573 <h3>Events</h3> | |
574 <!-- iterates over all events --> | |
575 <div class="apiItem"> | |
576 <a name="event-onExecute"></a> | |
577 <h4>onExecute</h4> | |
578 <div class="summary"> | |
579 <!-- Note: intentionally longer 80 columns --> | |
580 <span class="subdued">chrome.fileBrowserHandler.</span><span>onE
xecute</span><span class="subdued">.addListener</span>(function(<span>string id,
FileHandlerExecuteEventDetails details</span>) <span class="subdued">{...}</spa
n><span></span>); | |
581 </div> | |
582 <div class="description"> | |
583 <p>Fired when file system action is executed from ChromeOS file
browser.</p> | |
584 <!-- LISTENER PARAMETERS --> | |
585 <div> | |
586 <h4>Listener parameters</h4> | |
587 <dl> | |
588 <div> | |
589 <div> | |
590 <dt> | |
591 <var>id</var> | |
592 <em> | |
593 <!-- TYPE --> | |
594 <div style="display:inline"> | |
595 ( | |
596 <span id="typeTemplate"> | |
597 <span> | |
598 <span>string</span> | |
599 </span> | |
600 </span> | |
601 ) | |
602 </div> | |
603 </em> | |
604 </dt> | |
605 <dd>File browser action id as specified in the listener component's ma
nifest.</dd> | |
606 <!-- OBJECT PROPERTIES --> | |
607 <!-- OBJECT METHODS --> | |
608 <!-- OBJECT EVENT FIELDS --> | |
609 <!-- FUNCTION PARAMETERS --> | |
610 </div> | |
611 </div><div> | |
612 <div> | |
613 <dt> | |
614 <var>details</var> | |
615 <em> | |
616 <!-- TYPE --> | |
617 <div style="display:inline"> | |
618 ( | |
619 <span id="typeTemplate"> | |
620 <span> | |
621 <a href="fileBrowserHandler.html#type-FileHandlerExecute
EventDetails">FileHandlerExecuteEventDetails</a> | |
622 </span> | |
623 </span> | |
624 ) | |
625 </div> | |
626 </em> | |
627 </dt> | |
628 <dd>File handler execute event details.</dd> | |
629 <!-- OBJECT PROPERTIES --> | |
630 <!-- OBJECT METHODS --> | |
631 <!-- OBJECT EVENT FIELDS --> | |
632 <!-- FUNCTION PARAMETERS --> | |
633 </div> | |
634 </div> | |
635 </dl> | |
636 </div> | |
637 <!-- EXTRA PARAMETERS --> | |
638 <!-- LISTENER RETURN VALUE --> | |
639 <dl> | |
640 </dl> | |
641 </div> <!-- /description --> | |
642 <!-- /description --> | |
643 </div> <!-- /apiItem --> | |
644 </div> <!-- /apiGroup --> | |
645 <!-- TYPES --> | |
646 <div class="apiGroup"> | |
647 <a name="types"></a> | |
648 <h3 id="types">Types</h3> | |
649 <!-- iterates over all types --> | |
650 <div class="apiItem"> | |
651 <a name="type-FileHandlerExecuteEventDetails"></a> | |
652 <h4>FileHandlerExecuteEventDetails</h4> | |
653 <div> | |
654 <dt> | |
655 <em> | |
656 <!-- TYPE --> | |
657 <div style="display:inline"> | |
658 ( | |
659 <span id="typeTemplate"> | |
660 <span> | |
661 <span>object</span> | |
662 </span> | |
663 </span> | |
664 ) | |
665 </div> | |
666 </em> | |
667 </dt> | |
668 <dd>Event details payload for fileBrowserHandler.onExecute event.</dd> | |
669 <!-- OBJECT PROPERTIES --> | |
670 <dd> | |
671 <dl> | |
672 <div> | |
673 <div> | |
674 <dt> | |
675 <var>entries</var> | |
676 <em> | |
677 <!-- TYPE --> | |
678 <div style="display:inline"> | |
679 ( | |
680 <span id="typeTemplate"> | |
681 <span> | |
682 <span> | |
683 array of <span><span> | |
684 <span> | |
685 <span>any</span> | |
686 </span> | |
687 </span></span> | |
688 </span> | |
689 </span> | |
690 </span> | |
691 ) | |
692 </div> | |
693 </em> | |
694 </dt> | |
695 <dd>Array of Entry instances representing files that are targets of th
is action (selected in ChromeOS file browser).</dd> | |
696 <!-- OBJECT PROPERTIES --> | |
697 <!-- OBJECT METHODS --> | |
698 <!-- OBJECT EVENT FIELDS --> | |
699 <!-- FUNCTION PARAMETERS --> | |
700 </div> | |
701 </div><div> | |
702 <div> | |
703 <dt> | |
704 <var>tab_id</var> | |
705 <em> | |
706 <!-- TYPE --> | |
707 <div style="display:inline"> | |
708 ( | |
709 <span class="optional">optional</span> | |
710 <span id="typeTemplate"> | |
711 <span> | |
712 <span>integer</span> | |
713 </span> | |
714 </span> | |
715 ) | |
716 </div> | |
717 </em> | |
718 </dt> | |
719 <dd>The ID of the tab that raised this event. Tab IDs are unique withi
n a browser session.</dd> | |
720 <!-- OBJECT PROPERTIES --> | |
721 <!-- OBJECT METHODS --> | |
722 <!-- OBJECT EVENT FIELDS --> | |
723 <!-- FUNCTION PARAMETERS --> | |
724 </div> | |
725 </div> | |
726 </dl> | |
727 </dd> | |
728 <!-- OBJECT METHODS --> | |
729 <!-- OBJECT EVENT FIELDS --> | |
730 <!-- FUNCTION PARAMETERS --> | |
731 </div> | |
732 </div> <!-- /apiItem --> | |
733 </div> <!-- /apiGroup --> | |
734 </div> <!-- /apiPage --> | |
735 </div> <!-- /gc-pagecontent --> | |
736 </div> <!-- /g-section --> | |
737 </div> <!-- /codesiteContent --> | |
738 <div id="gc-footer" --=""> | |
739 <div class="text"> | |
740 <p> | |
741 Except as otherwise <a href="http://code.google.com/policies.html#restrictions
">noted</a>, | |
742 the content of this page is licensed under the <a rel="license" href="http://c
reativecommons.org/licenses/by/3.0/">Creative Commons | |
743 Attribution 3.0 License</a>, and code samples are licensed under the | |
744 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD Lic
ense</a>. | |
745 </p> | |
746 <p> | |
747 ©2011 Google | |
748 </p> | |
749 <!-- begin analytics --> | |
750 <script src="https://www.google-analytics.com/urchin.js" type="text/javascript">
</script> | |
751 <script src="https://www.google-analytics.com/ga.js" type="text/javascript"></sc
ript> | |
752 <script type="text/javascript"> | |
753 // chrome doc tracking | |
754 try { | |
755 var engdocs = _gat._getTracker("YT-10763712-2"); | |
756 engdocs._trackPageview(); | |
757 } catch(err) {} | |
758 // code.google.com site-wide tracking | |
759 try { | |
760 _uacct="UA-18071-1"; | |
761 _uanchor=1; | |
762 _uff=0; | |
763 urchinTracker(); | |
764 } | |
765 catch(e) {/* urchinTracker not available. */} | |
766 </script> | |
767 <!-- end analytics --> | |
768 </div> | |
769 </div> <!-- /gc-footer --> | |
770 </div> <!-- /gc-container --> | |
771 </body></html> | |
OLD | NEW |