OLD | NEW |
| (Empty) |
1 // Copyright (c) 2012 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 [ | |
6 { | |
7 "namespace":"fileBrowserPrivate", | |
8 "nodoc": "true", | |
9 "types": [ | |
10 { | |
11 "id": "FileBrowserTask", | |
12 "type": "object", | |
13 "description": "Represents information about available browser tasks. A
task is an abstraction of an operation that the file browser can perform over a
selected file set.", | |
14 "properties": { | |
15 "taskId": {"type": "string", "description": "The unique identifier of
the task."}, | |
16 "title": {"type": "string", "description": "Task title."}, | |
17 "iconUrl": {"type": "string", "description": "Task icon url (from chro
me://extension-icon/...)"}, | |
18 "patterns": { | |
19 "type": "array", | |
20 "items": { "type": "string" }, | |
21 "description": "The list of URL patterns supported by the task that
matched at least one file." | |
22 } | |
23 } | |
24 }, | |
25 { | |
26 "id": "VolumeInfo", | |
27 "type": "object", | |
28 "description": "Mounted disk volume information.", | |
29 "properties": { | |
30 "mountPath": { | |
31 "type": "string", | |
32 "description": "Disk volume mount point path. The value corresponds
to its Entry.fullPath in File API." | |
33 }, | |
34 "devicePath": { | |
35 "type": "string", | |
36 "description": "Disk volume device path." | |
37 }, | |
38 "label": { | |
39 "type": "string", | |
40 "description": "Volume label." | |
41 }, | |
42 "deviceType": { | |
43 "type": "string", | |
44 "enum": ["sd", "usb", "optical", "mobile", "unknown"], | |
45 "description": "Device type." | |
46 }, | |
47 "readOnly": { | |
48 "type": "boolean", | |
49 "description": "Flag that specifies if volume is mounted in read-onl
y mode." | |
50 }, | |
51 "totalSizeKB": { | |
52 "type": "integer", | |
53 "description": "Total disk volume size in KBs" | |
54 } | |
55 } | |
56 }, | |
57 { | |
58 "id": "DriveWebApp", | |
59 "type": "object", | |
60 "description": "GData WebApp properties.", | |
61 "properties": { | |
62 "appId": { | |
63 "type": "string", | |
64 "description": "WebApp ID." | |
65 }, | |
66 "appName": { | |
67 "type": "string", | |
68 "description": "WebApp name." | |
69 }, | |
70 "objectType": { | |
71 "type": "string", | |
72 "description": "Object (file) type description." | |
73 }, | |
74 "isPrimary": { | |
75 "type": "boolean", | |
76 "description": "True if this WebApp is the primary (default) open ac
tion for this file." | |
77 } | |
78 } | |
79 }, | |
80 { | |
81 "id": "GDataFileProperties", | |
82 "type": "object", | |
83 "description": "GData file properties.", | |
84 "properties": { | |
85 "fileUrl": { | |
86 "type": "string", | |
87 "optional": true, | |
88 "description": "the URL given for this file." | |
89 }, | |
90 "thumbnailUrl": { | |
91 "type": "string", | |
92 "optional": true, | |
93 "description": "URL to the GData thumbnail image for this file." | |
94 }, | |
95 "contentUrl": { | |
96 "type": "string", | |
97 "optional": true, | |
98 "description": "GData URL to the content for this file." | |
99 }, | |
100 "editUrl": { | |
101 "type": "string", | |
102 "optional": true, | |
103 "description": "GData edit URL for this file." | |
104 }, | |
105 "contentUrl": { | |
106 "type": "string", | |
107 "optional": true, | |
108 "description": "GData content URL for this file." | |
109 }, | |
110 "isPinned": { | |
111 "type": "boolean", | |
112 "optional": true, | |
113 "description": "True if the file is pinned in GData cache." | |
114 }, | |
115 "isPresent": { | |
116 "type": "boolean", | |
117 "optional": true, | |
118 "description": "True if the file is present in GData cache." | |
119 }, | |
120 "isDirty": { | |
121 "type": "boolean", | |
122 "optional": true, | |
123 "description": "True if the file is awaiting upload in GData cache." | |
124 }, | |
125 "isHosted": { | |
126 "type": "boolean", | |
127 "optional": true, | |
128 "description": "True if the file is hosted on a GData server instead
of local." | |
129 }, | |
130 "errorCode": { | |
131 "type": "integer", | |
132 "optional": true, | |
133 "description": "The error code (from base::PlatformFileError) if fet
ching the properties for this file had an error." | |
134 }, | |
135 "driveApps" : { | |
136 "type": "array", | |
137 "optional": true, | |
138 "items": {"$ref": "DriveWebApp"}, | |
139 "description": "An array of WebApps capable of opening this file." | |
140 } | |
141 } | |
142 }, | |
143 { | |
144 "id": "MountPointInfo", | |
145 "type": "object", | |
146 "description": "Mounted point information.", | |
147 "properties": { | |
148 "mountPath": { | |
149 "type": "string", | |
150 "optional": true, | |
151 "description": "Disk volume mount point path. The value corresponds
to its Entry.fullPath in File API." | |
152 }, | |
153 "sourcePath": { | |
154 "type": "string", | |
155 "description": "The path to the mounted device, archive file or netw
ork resource." | |
156 }, | |
157 "mountType": { | |
158 "type": "string", | |
159 "enum": ["device", "file", "network"], | |
160 "description": "Type of the mount." | |
161 }, | |
162 "mountCondition": { | |
163 "type": "string", | |
164 "description": "Additional data about mount, for example, that the f
ilesystem is not supported." | |
165 } | |
166 } | |
167 }, | |
168 { | |
169 "id": "MountPointSizeStats", | |
170 "type": "object", | |
171 "description": "Information about total and remaining size on the mount
point.", | |
172 "properties": { | |
173 "totalSizeKB": { | |
174 "type": "integer", | |
175 "description": "Total available size on the mount point." | |
176 }, | |
177 "remainingSizeKB": { | |
178 "type": "integer", | |
179 "description": "Remaining available size on the mount point." | |
180 } | |
181 } | |
182 }, | |
183 { | |
184 "id": "VolumeMetadata", | |
185 "type": "object", | |
186 "description": "Mounted disk volume metadata.", | |
187 "properties": { | |
188 "mountPath": { | |
189 "type": "string", | |
190 "description": "Disk volume mount point path." | |
191 }, | |
192 "devicePath": { | |
193 "type": "string", | |
194 "description": "Disk volume device path." | |
195 }, | |
196 "systemPath": { | |
197 "type": "string", | |
198 "description": "Disk volume system path." | |
199 }, | |
200 "filePath": { | |
201 "type": "string", | |
202 "description": "Disk volume file path." | |
203 }, | |
204 "deviceLabel": { | |
205 "type": "string", | |
206 "description": "Volume label." | |
207 }, | |
208 "driveLabel": { | |
209 "type": "string", | |
210 "description": "Volume's disk label." | |
211 }, | |
212 "deviceType": { | |
213 "type": "string", | |
214 "enum": ["usb", "sd", "optical", "mobile", "unknown"], | |
215 "description": "Device type." | |
216 }, | |
217 "isParent": { | |
218 "type": "boolean", | |
219 "description": "Flag that specifies if volume is a parent device." | |
220 }, | |
221 "isReadOnly": { | |
222 "type": "boolean", | |
223 "description": "Flag that specifies if volume is mounted in read-onl
y mode." | |
224 }, | |
225 "hasMedia": { | |
226 "type": "boolean", | |
227 "description": "Flag that specifies if volume has any media." | |
228 }, | |
229 "isOnBootDevice": { | |
230 "type": "boolean", | |
231 "description": "Flag that specifies if volume is on boot device." | |
232 }, | |
233 "totalSize": { | |
234 "type": "integer", | |
235 "description": "Total disk volume size." | |
236 } | |
237 } | |
238 }, | |
239 { | |
240 "id": "MountEvent", | |
241 "type": "object", | |
242 "description": "Payload data for disk mount / unmount event.", | |
243 "properties": { | |
244 "eventType": { | |
245 "type": "string", | |
246 "enum": ["added", "removed"], | |
247 "description": "Event type that tells listeners which disk volume ev
en was raised." | |
248 }, | |
249 "volumeInfo": { | |
250 "$ref": "VolumeInfo", | |
251 "description":"Volume information that this mount event applies to." | |
252 } | |
253 } | |
254 }, | |
255 { | |
256 "id": "MountCompletedEvent", | |
257 "type": "object", | |
258 "description": "Payload data for mount event.", | |
259 "properties": { | |
260 "eventType": { | |
261 "type": "string", | |
262 "enum": ["mount", "unmount"], | |
263 "description": "Is the event raised for mounting or unmounting." | |
264 }, | |
265 "status": { | |
266 "type": "string", | |
267 "enum": ["success", "error_unknown", "error_internal", | |
268 "error_unknown_filesystem", "error_unsuported_filesystem", | |
269 "error_invalid_archive", "error_libcros_missing", | |
270 "error_authentication", "error_network", | |
271 "error_path_unmounted"], | |
272 "description": "Event type that tells listeners if mount was success
ful or an error occurred. It also specifies the error." | |
273 }, | |
274 "sourcePath": { | |
275 "type": "string", | |
276 "description": "Path that has been mounted." | |
277 }, | |
278 "mountPath": { | |
279 "type": "string", | |
280 "optional": true, | |
281 "description": "Path that sourcePath was mounted to." | |
282 }, | |
283 "mountType": { | |
284 "type": "string", | |
285 "enum": ["device", "file", "network", "gdata"], | |
286 "description": "Type of the mount." | |
287 } | |
288 } | |
289 }, | |
290 { | |
291 "id": "FileTransferStatus", | |
292 "type": "object", | |
293 "description": "Payload data for file transfer status updates.", | |
294 "properties": { | |
295 "fileUrl": { | |
296 "type": "string", | |
297 "description": "URL of file that is being transfered." | |
298 }, | |
299 "transferState": { | |
300 "type": "string", | |
301 "enum": ["started", "in_progress", "completed", "failed"], | |
302 "description": "File transfer progress state." | |
303 }, | |
304 "transferType": { | |
305 "type": "string", | |
306 "enum": ["upload", "download"], | |
307 "description": "Defines file transfer direction." | |
308 }, | |
309 "processed": { | |
310 "type": "integer", | |
311 "optional": true, | |
312 "description": "Completed portion of the transfer operation." | |
313 }, | |
314 "total": { | |
315 "type": "integer", | |
316 "optional": true, | |
317 "description": "Total size (cost) of transfer operation." | |
318 } | |
319 } | |
320 }, | |
321 { | |
322 "id": "FileTransferCancelStatus", | |
323 "type": "object", | |
324 "description": "Payload data for file transfer cancel response.", | |
325 "properties": { | |
326 "fileUrl": { | |
327 "type": "string", | |
328 "description": "URL of file that is being transfered." | |
329 }, | |
330 "canceled": { | |
331 "type": "boolean", | |
332 "description": "True if ongoing transfer operation was found and can
celed." | |
333 } | |
334 } | |
335 }, | |
336 { | |
337 "id": "FileWatchEvent", | |
338 "type": "object", | |
339 "description": "Payload data for disk mount / unmount event.", | |
340 "properties": { | |
341 "eventType": { | |
342 "type": "string", | |
343 "enum": ["changed", "error"], | |
344 "description": "Specifies type of event that is raised." | |
345 }, | |
346 "fileUrl": { | |
347 "type": "string", | |
348 "description":"URL of watched file" | |
349 } | |
350 } | |
351 } | |
352 ], | |
353 "functions": [ | |
354 { | |
355 "name": "cancelDialog", | |
356 "type": "function", | |
357 "description": "Cancels file selection.", | |
358 "parameters": [] | |
359 }, | |
360 { | |
361 "name": "executeTask", | |
362 "description": "Executes file browser task over selected files", | |
363 "parameters": [ | |
364 { | |
365 "name": "taskId", | |
366 "type": "string", | |
367 "description": "The unique identifier of task to execute." | |
368 }, | |
369 { | |
370 "name": "fileURLs", | |
371 "type": "array", | |
372 "description": "Array of file URLs", | |
373 "items": { "type": "string" } | |
374 }, | |
375 { | |
376 "name": "callback", | |
377 "type": "function", | |
378 "optional": true, | |
379 "parameters": [ | |
380 { | |
381 "name": "success", | |
382 "type": "boolean", | |
383 "optional": true, | |
384 "description": "True of task execution was successfully initiate
d." | |
385 } | |
386 ] | |
387 } | |
388 ] | |
389 }, | |
390 { | |
391 "name": "getFileTasks", | |
392 "description": "Gets the list of tasks that can be performed over select
ed files.", | |
393 "parameters": [ | |
394 { | |
395 "name": "fileURLs", | |
396 "type": "array", | |
397 "description": "Array of selected file URLs", | |
398 "items": { "type": "string" } | |
399 }, | |
400 { | |
401 "name": "callback", | |
402 "type": "function", | |
403 "parameters": [ | |
404 { | |
405 "name": "tasks", | |
406 "type": "array", | |
407 "items": {"$ref": "FileBrowserTask"}, | |
408 "description": "The list of matched file URL patterns for this t
ask." | |
409 } | |
410 ] | |
411 } | |
412 ] | |
413 }, | |
414 { | |
415 "name": "getStrings", | |
416 "type": "function", | |
417 "description": "Gets Strings.", | |
418 "parameters": [ | |
419 { | |
420 "type": "function", | |
421 "name": "callback", | |
422 "parameters": [ | |
423 { | |
424 "name": "result", | |
425 "type": "object", | |
426 "additionalProperties": {"type": "string"} | |
427 } | |
428 ] | |
429 } | |
430 ] | |
431 }, | |
432 { | |
433 "name": "addFileWatch", | |
434 "description": "Adds file watch.", | |
435 "parameters": [ | |
436 { | |
437 "name": "fileUrl", | |
438 "type": "string", | |
439 "description": "URL of file to watch" | |
440 }, | |
441 { | |
442 "name": "callback", | |
443 "type": "function", | |
444 "parameters": [ | |
445 { | |
446 "name" : "success", | |
447 "type": "boolean", | |
448 "optional": true, | |
449 "description": "True when file watch is successfully added." | |
450 } | |
451 ] | |
452 } | |
453 ] | |
454 }, | |
455 { | |
456 "name": "removeFileWatch", | |
457 "description": "Removes file watch.", | |
458 "parameters": [ | |
459 { | |
460 "name": "fileUrl", | |
461 "type": "string", | |
462 "description": "URL of watched file to remove" | |
463 }, | |
464 { | |
465 "name": "callback", | |
466 "type": "function", | |
467 "parameters": [ | |
468 { | |
469 "name" : "success", | |
470 "type": "boolean", | |
471 "optional": true, | |
472 "description": "True when file watch is successfully removed." | |
473 } | |
474 ] | |
475 } | |
476 ] | |
477 }, | |
478 { | |
479 "name": "requestLocalFileSystem", | |
480 "description": "Requests access to local file system", | |
481 "parameters": [ | |
482 { | |
483 "name": "callback", | |
484 "type": "function", | |
485 "parameters": [ | |
486 { | |
487 "name" : "fileSystem", | |
488 "type": "object", | |
489 "optional": true, | |
490 "description": "A DOMFileSystem instance for local file system a
ccess. null if the caller has no appropriate permissions." | |
491 } | |
492 ] | |
493 } | |
494 ] | |
495 }, | |
496 { | |
497 "name": "selectFiles", | |
498 "type": "function", | |
499 "description": "Selects multiple files.", | |
500 "parameters": [ | |
501 { | |
502 "name": "selectedPaths", | |
503 "type": "array", | |
504 "description": "Array of selected paths", | |
505 "items": {"type": "string"} | |
506 } | |
507 ] | |
508 }, | |
509 { | |
510 "name": "selectFile", | |
511 "type": "function", | |
512 "description": "Selects a file.", | |
513 "parameters": [ | |
514 { | |
515 "name": "selectedPath", | |
516 "type": "string", | |
517 "description": "A selected path" | |
518 }, | |
519 { | |
520 "name": "index", | |
521 "type": "integer", | |
522 "description": "Index of Filter" | |
523 } | |
524 ] | |
525 }, | |
526 { | |
527 "name": "viewFiles", | |
528 "type": "function", | |
529 "description": "Views multiple files.", | |
530 "parameters": [ | |
531 { | |
532 "name": "fileUrls", | |
533 "type": "array", | |
534 "description": "Array of selected paths", | |
535 "items": {"type": "string"} | |
536 }, | |
537 { | |
538 "name": "id", | |
539 "type": "string", | |
540 "description": "File browser handler id as for internal tasks." | |
541 }, | |
542 { | |
543 "name": "callback", | |
544 "type": "function", | |
545 "parameters": [ | |
546 { | |
547 "name" : "success", | |
548 "type": "boolean", | |
549 "description": "True if the selected files can be viewed by the
browser." | |
550 } | |
551 ] | |
552 } | |
553 ] | |
554 }, | |
555 { | |
556 "name": "getGDataFileProperties", | |
557 "description": "Requests GData file properties for a list of files", | |
558 "parameters": [ | |
559 { | |
560 "name": "fileUrls", | |
561 "type": "array", | |
562 "description": "Array of file URLs to fetch properties for." | |
563 }, | |
564 { | |
565 "name": "callback", | |
566 "type": "function", | |
567 "parameters": [ | |
568 { | |
569 "name" : "fileProperties", | |
570 "type": "array", | |
571 "items": {"$ref": "GDataFileProperties"}, | |
572 "description": "An array of the requested file properties, one e
ntry for each file in fileUrls." | |
573 } | |
574 ] | |
575 } | |
576 ] | |
577 }, | |
578 { | |
579 "name": "pinGDataFile", | |
580 "description": "Pins/unpins a GData file in the cache", | |
581 "parameters": [ | |
582 { | |
583 "name": "fileUrls", | |
584 "type": "array", | |
585 "description": "Array of file URLs to pin/unpin." | |
586 }, | |
587 { | |
588 "name": "pin", | |
589 "type": "boolean", | |
590 "description": "Pass true to pin the files listed." | |
591 }, | |
592 { | |
593 "name": "callback", | |
594 "type": "function", | |
595 "parameters": [ | |
596 { | |
597 "name" : "fileProperties", | |
598 "type": "array", | |
599 "items": {"$ref": "GDataFileProperties"}, | |
600 "description": "An array of the pinned properties after pinning/
unpinning the requested files, one entry for each file in fileUrls." | |
601 } | |
602 ] | |
603 } | |
604 ] | |
605 }, | |
606 { | |
607 "name": "getFileLocations", | |
608 "description": "Get file locations", | |
609 "parameters": [ | |
610 { | |
611 "name": "fileUrls", | |
612 "type": "array", | |
613 "description": "Array of file URLs to check.", | |
614 "items": { "type": "string" } | |
615 }, | |
616 { | |
617 "name": "callback", | |
618 "type": "function", | |
619 "parameters": [ | |
620 { | |
621 "name" : "locations", | |
622 "type": "array", | |
623 "items": {"type": "string"}, | |
624 "description": "An array of the file locations for the requested
files, one entry for each file in fileUrls." | |
625 } | |
626 ] | |
627 } | |
628 ] | |
629 }, | |
630 { | |
631 "name": "getGDataFiles", | |
632 "description": "Get GData files", | |
633 "parameters": [ | |
634 { | |
635 "name": "fileUrls", | |
636 "type": "array", | |
637 "description": "Array of gdata file URLs to get.", | |
638 "items": { "type": "string" } | |
639 }, | |
640 { | |
641 "name": "callback", | |
642 "type": "function", | |
643 "parameters": [ | |
644 { | |
645 "name" : "localFilePaths", | |
646 "type": "array", | |
647 "items": {"type": "string"}, | |
648 "description": "An array of the local file paths for the request
ed files, one entry for each file in fileUrls." | |
649 } | |
650 ] | |
651 } | |
652 ] | |
653 }, | |
654 { | |
655 "name": "getVolumeMetadata", | |
656 "description": "Requests volume's metadata", | |
657 "parameters": [ | |
658 { | |
659 "name": "mountUrl", | |
660 "type": "string", | |
661 "description": "Mount url of the volume." | |
662 }, | |
663 { | |
664 "name": "callback", | |
665 "type": "function", | |
666 "parameters": [ | |
667 { | |
668 "name" : "volumeMetadata", | |
669 "$ref": "VolumeMetadata", | |
670 "optional": true, | |
671 "description": "A requested metadata dictionary object. undefine
d if there is no volume with selected devicePath" | |
672 } | |
673 ] | |
674 } | |
675 ] | |
676 }, | |
677 { | |
678 "name": "addMount", | |
679 "description": "Mount a resource or a file.", | |
680 "parameters": [ | |
681 { | |
682 "name": "source", | |
683 "type": "string", | |
684 "description": "Mount point source. For compressed files it is relat
ive file path within external file system" | |
685 }, | |
686 { | |
687 "name": "mountType", | |
688 "type": "string", | |
689 "enum": ["device", "file", "network", "gdata"], | |
690 "description": "Mount point type. 'file' for compressed files" | |
691 }, | |
692 { | |
693 "name": "options", | |
694 "type": "object", | |
695 "description": "Name/value pairs for source specific options" | |
696 }, | |
697 { | |
698 "name": "callback", | |
699 "type": "function", | |
700 "parameters": [ | |
701 { | |
702 "name": "sourcePath", | |
703 "type": "string", | |
704 "description": "Source path of the mount." | |
705 } | |
706 ] | |
707 } | |
708 ] | |
709 }, | |
710 { | |
711 "name": "removeMount", | |
712 "description": "Unmounts a mounted resource.", | |
713 "parameters": [ | |
714 { | |
715 "name": "mountPath", | |
716 "type": "string", | |
717 "description": "A path of the mount." | |
718 } | |
719 ] | |
720 }, | |
721 { | |
722 "name": "getMountPoints", | |
723 "description": "Get the list of mount points.", | |
724 "parameters": [ | |
725 { | |
726 "name": "callback", | |
727 "type": "function", | |
728 "parameters": [ | |
729 { | |
730 "name" : "mountPoints", | |
731 "type": "array", | |
732 "items": {"$ref": "MountPointInfo"}, | |
733 "description": "The list of MountPointInfo representing mounted
devices." | |
734 } | |
735 ] | |
736 } | |
737 ] | |
738 }, | |
739 { | |
740 "name": "getFileTransfers", | |
741 "description": "Get the list of ongoing file transfer operations.", | |
742 "parameters": [ | |
743 { | |
744 "name": "callback", | |
745 "type": "function", | |
746 "parameters": [ | |
747 { | |
748 "name" : "fileTransfers", | |
749 "type": "array", | |
750 "items": {"$ref": "FileTransferStatus"}, | |
751 "description": "The list of FileTransferStatus representing ongo
ing file transfers." | |
752 } | |
753 ] | |
754 } | |
755 ] | |
756 }, | |
757 { | |
758 "name": "transferFile", | |
759 "description": "Transfers file from local to remote file system.", | |
760 "parameters": [ | |
761 { | |
762 "name": "sourceFileUrl", | |
763 "type": "string", | |
764 "description": "Source file from the local file system." | |
765 }, | |
766 { | |
767 "name": "destinationFileUrl", | |
768 "type": "string", | |
769 "description": "Destination file on the remote file system." | |
770 }, | |
771 { | |
772 "name": "callback", | |
773 "type": "function", | |
774 "optional": true, | |
775 "description": "Completion callback. chrome.extension.lastError will
be set if there was an error.", | |
776 "parameters": [] | |
777 } | |
778 ] | |
779 }, | |
780 { | |
781 "name": "cancelFileTransfers", | |
782 "description": "Cancels ongoing file transfers for selected files.", | |
783 "parameters": [ | |
784 { | |
785 "name": "fileUrls", | |
786 "type": "array", | |
787 "description": "Array of files for which ongoing transfer should be
canceled.", | |
788 "items": {"type": "string"} | |
789 }, | |
790 { | |
791 "name": "callback", | |
792 "type": "function", | |
793 "parameters": [ | |
794 { | |
795 "name" : "fileTransferCancelStatuses", | |
796 "type": "array", | |
797 "items": {"$ref": "FileTransferCancelStatus"}, | |
798 "description": "The list of FileTransferCancelStatus." | |
799 } | |
800 ] | |
801 } | |
802 ] | |
803 }, | |
804 { | |
805 "name": "getSizeStats", | |
806 "description": "Retrieves total and remaining size of a mount point.", | |
807 "parameters": [ | |
808 { | |
809 "name": "mountPath", | |
810 "type": "string", | |
811 "description": "Mount point path." | |
812 }, | |
813 { | |
814 "name": "callback", | |
815 "type": "function", | |
816 "parameters": [ | |
817 { | |
818 "name" : "sizeStats", | |
819 "$ref": "MountPointSizeStats", | |
820 "description": "Name/value pairs of size stats." | |
821 } | |
822 ] | |
823 } | |
824 ] | |
825 }, | |
826 { | |
827 "name": "formatDevice", | |
828 "description": "Formats a mounted device", | |
829 "parameters": [ | |
830 { | |
831 "name": "mountPath", | |
832 "type": "string", | |
833 "description": "Device's mount path." | |
834 } | |
835 ] | |
836 }, | |
837 { | |
838 "name": "toggleFullscreen", | |
839 "description": "Switches fullscreen mode on/off for the File Browser.", | |
840 "parameters": [] | |
841 }, | |
842 { | |
843 "name": "isFullscreen", | |
844 "description": "Checks if the browser is in fullscreen mode.", | |
845 "parameters": [ | |
846 { | |
847 "name": "callback", | |
848 "type": "function", | |
849 "parameters": [ | |
850 { | |
851 "name" : "result", | |
852 "type": "boolean", | |
853 "description": "Whether the browser is in fullscreen mode." | |
854 } | |
855 ] | |
856 } | |
857 ] | |
858 }, | |
859 { | |
860 "name": "getGDataPreferences", | |
861 "description": "Retrieves GData-related preferences .", | |
862 "parameters": [ | |
863 { | |
864 "name": "callback", | |
865 "type": "function", | |
866 "parameters": [ | |
867 { | |
868 "name": "result", | |
869 "type": "object", | |
870 "properties": { | |
871 "cellularDisabled": {"type":"boolean"}, | |
872 "hostedFilesDisabled": {"type":"boolean"} | |
873 } | |
874 } | |
875 ] | |
876 } | |
877 ] | |
878 }, | |
879 { | |
880 "name": "setGDataPreferences", | |
881 "description": "Sets GData-related preferences.", | |
882 "parameters": [ | |
883 { | |
884 "name": "changeInfo", | |
885 "type": "object", | |
886 "properties": { | |
887 "cellularDisabled": {"type":"boolean", "optional":true}, | |
888 "hostedFilesDisabled": {"type":"boolean", "optional":true} | |
889 } | |
890 } | |
891 ] | |
892 }, | |
893 { | |
894 "name": "getPathForDriveSearchResult", | |
895 "description": "Gets file path for a given drive search result filesyste
m url.", | |
896 "parameters": [ | |
897 { | |
898 "name": "fileURL", | |
899 "type": "string", | |
900 "description": "Url of the drive search result" | |
901 }, | |
902 { | |
903 "name": "callback", | |
904 "type": "function", | |
905 "parameters": [ | |
906 { | |
907 "name": "filePath", | |
908 "type": "string", | |
909 "description": "File path of the search result" | |
910 } | |
911 ] | |
912 } | |
913 ] | |
914 }, | |
915 { | |
916 "name": "getNetworkConnectionState", | |
917 "description": "Retrieves the state of the currently active network conn
ection.", | |
918 "parameters": [ | |
919 { | |
920 "name": "callback", | |
921 "type": "function", | |
922 "parameters": [ | |
923 { | |
924 "name": "result", | |
925 "type": "object", | |
926 "properties": { | |
927 "type": {"type": "string"}, | |
928 "online": {"type": "boolean"} | |
929 } | |
930 } | |
931 ] | |
932 } | |
933 ] | |
934 } | |
935 ], | |
936 "events": [ | |
937 { | |
938 "name": "onDiskChanged", | |
939 "type": "function", | |
940 "description": "Fired when disk mount/unmount event is detected.", | |
941 "parameters": [ | |
942 { | |
943 "$ref": "MountEvent", | |
944 "name": "event", | |
945 "description": "Mount event information." | |
946 } | |
947 ] | |
948 }, | |
949 { | |
950 "name": "onMountCompleted", | |
951 "type": "function", | |
952 "description": "Fired when mount event is detected.", | |
953 "parameters": [ | |
954 { | |
955 "$ref": "MountCompletedEvent", | |
956 "name": "event", | |
957 "description": "MountCompleted event information." | |
958 } | |
959 ] | |
960 }, | |
961 { | |
962 "name": "onFileTransfersUpdated", | |
963 "type": "function", | |
964 "description": "Fired when file transfers with remote file system are in
progress.", | |
965 "parameters": [ | |
966 { | |
967 "type": "array", | |
968 "items": {"$ref": "FileTransferStatus"}, | |
969 "name": "event", | |
970 "description": "List of ongoing file statuses for ongoing transfer o
perations." | |
971 } | |
972 ] | |
973 }, | |
974 { | |
975 "name": "onFileChanged", | |
976 "type": "function", | |
977 "description": "Fired when watched file change event is detected.", | |
978 "parameters": [ | |
979 { | |
980 "$ref": "FileWatchEvent", | |
981 "name": "event", | |
982 "description": "File watch event information." | |
983 } | |
984 ] | |
985 }, | |
986 { | |
987 "name": "onDocumentFeedFetched", | |
988 "type": "function", | |
989 "description": "Fired when a document feed is fetched.", | |
990 "parameters": [ | |
991 { | |
992 "type": "integer", | |
993 "name": "entriesFetched", | |
994 "description": "Number of entries fetched so far." | |
995 } | |
996 ] | |
997 }, | |
998 { | |
999 "name": "onGDataPreferencesChanged", | |
1000 "type": "function", | |
1001 "description": "Fired when GData-related preferences change. The prefere
nces can be retrieved via 'getGDataPreferences'.", | |
1002 "parameters": [] | |
1003 }, | |
1004 { | |
1005 "name": "onNetworkConnectionChanged", | |
1006 "type": "function", | |
1007 "description": "Fired when the active network connection state changes.
The network connection state can be retrieved via 'getNetworkConnectionState'.", | |
1008 "parameters": [] | |
1009 } | |
1010 ] | |
1011 } | |
1012 ] | |
OLD | NEW |