Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(454)

Side by Side Diff: third_party/closure_compiler/externs/file_manager_private.js

Issue 2297043002: Web expose FileSystemFileEntry, FileSystemDirectoryEntry and friends (Closed)
Patch Set: Rebased Created 4 years, 1 month 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 unified diff | Download patch
OLDNEW
1 // Copyright 2014 The Chromium Authors. All rights reserved. 1 // Copyright 2016 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 // This file was generated by:
6 // tools/json_schema_compiler/compiler.py.
7 // NOTE: The format of types has changed. 'FooType' is now
8 // 'chrome.fileManagerPrivate.FooType'.
9 // Please run the closure compiler before committing changes.
10 // See https://chromium.googlesource.com/chromium/src/+/master/docs/closure_comp ilation.md
11
5 /** @fileoverview Externs generated from namespace: fileManagerPrivate */ 12 /** @fileoverview Externs generated from namespace: fileManagerPrivate */
6 13
7 /** 14 /**
15 * @const
16 */
17 chrome.fileManagerPrivate = {};
18
19 /**
20 * @enum {string}
21 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-VolumeTy pe
22 */
23 chrome.fileManagerPrivate.VolumeType = {
24 DRIVE: 'drive',
25 DOWNLOADS: 'downloads',
26 REMOVABLE: 'removable',
27 ARCHIVE: 'archive',
28 PROVIDED: 'provided',
29 MTP: 'mtp',
30 TESTING: 'testing',
31 };
32
33 /**
34 * @enum {string}
35 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DeviceTy pe
36 */
37 chrome.fileManagerPrivate.DeviceType = {
38 USB: 'usb',
39 SD: 'sd',
40 OPTICAL: 'optical',
41 MOBILE: 'mobile',
42 UNKNOWN: 'unknown',
43 };
44
45 /**
46 * @enum {string}
47 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountCon dition
48 */
49 chrome.fileManagerPrivate.MountCondition = {
50 UNKNOWN: 'unknown',
51 UNSUPPORTED: 'unsupported',
52 };
53
54 /**
55 * @enum {string}
56 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountCon text
57 */
58 chrome.fileManagerPrivate.MountContext = {
59 USER: 'user',
60 AUTO: 'auto',
61 };
62
63 /**
64 * @enum {string}
65 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountCom pletedEventType
66 */
67 chrome.fileManagerPrivate.MountCompletedEventType = {
68 MOUNT: 'mount',
69 UNMOUNT: 'unmount',
70 };
71
72 /**
73 * @enum {string}
74 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountCom pletedStatus
75 */
76 chrome.fileManagerPrivate.MountCompletedStatus = {
77 SUCCESS: 'success',
78 ERROR_UNKNOWN: 'error_unknown',
79 ERROR_INTERNAL: 'error_internal',
80 ERROR_INVALID_ARGUMENT: 'error_invalid_argument',
81 ERROR_INVALID_PATH: 'error_invalid_path',
82 ERROR_PATH_ALREADY_MOUNTED: 'error_path_already_mounted',
83 ERROR_PATH_NOT_MOUNTED: 'error_path_not_mounted',
84 ERROR_DIRECTORY_CREATION_FAILED: 'error_directory_creation_failed',
85 ERROR_INVALID_MOUNT_OPTIONS: 'error_invalid_mount_options',
86 ERROR_INVALID_UNMOUNT_OPTIONS: 'error_invalid_unmount_options',
87 ERROR_INSUFFICIENT_PERMISSIONS: 'error_insufficient_permissions',
88 ERROR_MOUNT_PROGRAM_NOT_FOUND: 'error_mount_program_not_found',
89 ERROR_MOUNT_PROGRAM_FAILED: 'error_mount_program_failed',
90 ERROR_INVALID_DEVICE_PATH: 'error_invalid_device_path',
91 ERROR_UNKNOWN_FILESYSTEM: 'error_unknown_filesystem',
92 ERROR_UNSUPPORTED_FILESYSTEM: 'error_unsupported_filesystem',
93 ERROR_INVALID_ARCHIVE: 'error_invalid_archive',
94 ERROR_AUTHENTICATION: 'error_authentication',
95 ERROR_PATH_UNMOUNTED: 'error_path_unmounted',
96 };
97
98 /**
99 * @enum {string}
100 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Transfer State
101 */
102 chrome.fileManagerPrivate.TransferState = {
103 IN_PROGRESS: 'in_progress',
104 COMPLETED: 'completed',
105 FAILED: 'failed',
106 };
107
108 /**
109 * @enum {string}
110 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Transfer Type
111 */
112 chrome.fileManagerPrivate.TransferType = {
113 UPLOAD: 'upload',
114 DOWNLOAD: 'download',
115 };
116
117 /**
118 * @enum {string}
119 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-CopyProg ressStatusType
120 */
121 chrome.fileManagerPrivate.CopyProgressStatusType = {
122 BEGIN_COPY_ENTRY: 'begin_copy_entry',
123 END_COPY_ENTRY: 'end_copy_entry',
124 PROGRESS: 'progress',
125 SUCCESS: 'success',
126 ERROR: 'error',
127 };
128
129 /**
130 * @enum {string}
131 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-FileWatc hEventType
132 */
133 chrome.fileManagerPrivate.FileWatchEventType = {
134 CHANGED: 'changed',
135 ERROR: 'error',
136 };
137
138 /**
139 * @enum {string}
140 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-ChangeTy pe
141 */
142 chrome.fileManagerPrivate.ChangeType = {
143 ADD_OR_UPDATE: 'add_or_update',
144 DELETE: 'delete',
145 };
146
147 /**
148 * @enum {string}
149 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-SearchTy pe
150 */
151 chrome.fileManagerPrivate.SearchType = {
152 EXCLUDE_DIRECTORIES: 'EXCLUDE_DIRECTORIES',
153 SHARED_WITH_ME: 'SHARED_WITH_ME',
154 OFFLINE: 'OFFLINE',
155 ALL: 'ALL',
156 };
157
158 /**
159 * @enum {string}
160 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-ZoomOper ationType
161 */
162 chrome.fileManagerPrivate.ZoomOperationType = {
163 IN: 'in',
164 OUT: 'out',
165 RESET: 'reset',
166 };
167
168 /**
169 * @enum {string}
170 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Inspecti onType
171 */
172 chrome.fileManagerPrivate.InspectionType = {
173 NORMAL: 'normal',
174 CONSOLE: 'console',
175 ELEMENT: 'element',
176 BACKGROUND: 'background',
177 };
178
179 /**
180 * @enum {string}
181 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DeviceEv entType
182 */
183 chrome.fileManagerPrivate.DeviceEventType = {
184 DISABLED: 'disabled',
185 REMOVED: 'removed',
186 HARD_UNPLUGGED: 'hard_unplugged',
187 FORMAT_START: 'format_start',
188 FORMAT_SUCCESS: 'format_success',
189 FORMAT_FAIL: 'format_fail',
190 };
191
192 /**
193 * @enum {string}
194 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DriveSyn cErrorType
195 */
196 chrome.fileManagerPrivate.DriveSyncErrorType = {
197 DELETE_WITHOUT_PERMISSION: 'delete_without_permission',
198 SERVICE_UNAVAILABLE: 'service_unavailable',
199 NO_SERVER_SPACE: 'no_server_space',
200 MISC: 'misc',
201 };
202
203 /**
204 * @enum {string}
205 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-TaskResu lt
206 */
207 chrome.fileManagerPrivate.TaskResult = {
208 OPENED: 'opened',
209 MESSAGE_SENT: 'message_sent',
210 FAILED: 'failed',
211 EMPTY: 'empty',
212 };
213
214 /**
215 * @enum {string}
216 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DriveSha reType
217 */
218 chrome.fileManagerPrivate.DriveShareType = {
219 CAN_EDIT: 'can_edit',
220 CAN_COMMENT: 'can_comment',
221 CAN_VIEW: 'can_view',
222 };
223
224 /**
225 * @enum {string}
226 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-EntryPro pertyName
227 */
228 chrome.fileManagerPrivate.EntryPropertyName = {
229 SIZE: 'size',
230 MODIFICATION_TIME: 'modificationTime',
231 THUMBNAIL_URL: 'thumbnailUrl',
232 CROPPED_THUMBNAIL_URL: 'croppedThumbnailUrl',
233 IMAGE_WIDTH: 'imageWidth',
234 IMAGE_HEIGHT: 'imageHeight',
235 IMAGE_ROTATION: 'imageRotation',
236 PINNED: 'pinned',
237 PRESENT: 'present',
238 HOSTED: 'hosted',
239 AVAILABLE_OFFLINE: 'availableOffline',
240 AVAILABLE_WHEN_METERED: 'availableWhenMetered',
241 DIRTY: 'dirty',
242 CUSTOM_ICON_URL: 'customIconUrl',
243 CONTENT_MIME_TYPE: 'contentMimeType',
244 SHARED_WITH_ME: 'sharedWithMe',
245 SHARED: 'shared',
246 STARRED: 'starred',
247 EXTERNAL_FILE_URL: 'externalFileUrl',
248 };
249
250 /**
251 * @enum {string}
252 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-EntryTag Visibility
253 */
254 chrome.fileManagerPrivate.EntryTagVisibility = {
255 PRIVATE: 'private',
256 PUBLIC: 'public',
257 };
258
259 /**
260 * @enum {string}
261 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Source
262 */
263 chrome.fileManagerPrivate.Source = {
264 FILE: 'file',
265 DEVICE: 'device',
266 NETWORK: 'network',
267 SYSTEM: 'system',
268 };
269
270 /**
271 * @enum {string}
272 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Verb
273 */
274 chrome.fileManagerPrivate.Verb = {
275 OPEN_WITH: 'open_with',
276 ADD_TO: 'add_to',
277 PACK_WITH: 'pack_with',
278 SHARE_WITH: 'share_with',
279 };
280
281 /**
8 * @typedef {{ 282 * @typedef {{
9 * taskId: string, 283 * taskId: string,
10 * title: string, 284 * title: string,
285 * verb: (!chrome.fileManagerPrivate.Verb|undefined),
11 * iconUrl: string, 286 * iconUrl: string,
12 * isDefault: boolean 287 * isDefault: boolean,
288 * isGenericFileHandler: boolean
13 * }} 289 * }}
14 */ 290 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-FileTask
15 var FileTask; 291 */
292 chrome.fileManagerPrivate.FileTask;
16 293
17 /** 294 /**
18 * @typedef {{ 295 * @typedef {{
19 * size: (number|undefined), 296 * size: (number|undefined),
20 * modificationTime: (number|undefined), 297 * modificationTime: (number|undefined),
21 * thumbnailUrl: (string|undefined), 298 * thumbnailUrl: (string|undefined),
22 * croppedThumbnailUrl: (string|undefined), 299 * croppedThumbnailUrl: (string|undefined),
23 * externalFileUrl: (string|undefined),
24 * imageWidth: (number|undefined), 300 * imageWidth: (number|undefined),
25 * imageHeight: (number|undefined), 301 * imageHeight: (number|undefined),
26 * imageRotation: (number|undefined), 302 * imageRotation: (number|undefined),
27 * pinned: (boolean|undefined), 303 * pinned: (boolean|undefined),
28 * present: (boolean|undefined), 304 * present: (boolean|undefined),
29 * hosted: (boolean|undefined), 305 * hosted: (boolean|undefined),
30 * dirty: (boolean|undefined),
31 * availableOffline: (boolean|undefined), 306 * availableOffline: (boolean|undefined),
32 * availableWhenMetered: (boolean|undefined), 307 * availableWhenMetered: (boolean|undefined),
308 * dirty: (boolean|undefined),
33 * customIconUrl: (string|undefined), 309 * customIconUrl: (string|undefined),
34 * contentMimeType: (string|undefined), 310 * contentMimeType: (string|undefined),
35 * sharedWithMe: (boolean|undefined), 311 * sharedWithMe: (boolean|undefined),
36 * shared: (boolean|undefined) 312 * shared: (boolean|undefined),
313 * starred: (boolean|undefined),
314 * externalFileUrl: (string|undefined)
37 * }} 315 * }}
316 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-EntryPro perties
38 */ 317 */
39 var EntryProperties; 318 chrome.fileManagerPrivate.EntryProperties;
40 319
41 /** 320 /**
42 * @typedef {{ 321 * @typedef {{
43 * totalSize: number, 322 * totalSize: number,
44 * remainingSize: number 323 * remainingSize: number
45 * }} 324 * }}
325 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountPoi ntSizeStats
46 */ 326 */
47 var MountPointSizeStats; 327 chrome.fileManagerPrivate.MountPointSizeStats;
48 328
49 /** 329 /**
50 * @typedef {{ 330 * @typedef {{
51 * profileId: string, 331 * profileId: string,
52 * displayName: string, 332 * displayName: string,
53 * isCurrentProfile: boolean 333 * isCurrentProfile: boolean
54 * }} 334 * }}
335 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-ProfileI nfo
55 */ 336 */
56 var ProfileInfo; 337 chrome.fileManagerPrivate.ProfileInfo;
57 338
58 /** 339 /**
59 * @typedef {{ 340 * @typedef {{
60 * volumeId: string, 341 * volumeId: string,
61 * fileSystemId: (string|undefined), 342 * fileSystemId: (string|undefined),
62 * extensionId: (string|undefined), 343 * extensionId: (string|undefined),
63 * source: string, 344 * source: !chrome.fileManagerPrivate.Source,
64 * volumeLabel: (string|undefined), 345 * volumeLabel: (string|undefined),
65 * profile: ProfileInfo, 346 * profile: !chrome.fileManagerPrivate.ProfileInfo,
66 * sourcePath: (string|undefined), 347 * sourcePath: (string|undefined),
67 * volumeType: string, 348 * volumeType: !chrome.fileManagerPrivate.VolumeType,
68 * deviceType: (string|undefined), 349 * deviceType: (!chrome.fileManagerPrivate.DeviceType|undefined),
69 * devicePath: (string|undefined), 350 * devicePath: (string|undefined),
70 * isParentDevice: (boolean|undefined), 351 * isParentDevice: (boolean|undefined),
71 * isReadOnly: boolean, 352 * isReadOnly: boolean,
72 * isReadOnlyRemovableDevice: boolean, 353 * isReadOnlyRemovableDevice: boolean,
73 * hasMedia: boolean, 354 * hasMedia: boolean,
74 * configurable: boolean, 355 * configurable: boolean,
75 * watchable: boolean, 356 * watchable: boolean,
76 * mountCondition: (string|undefined), 357 * mountCondition: (!chrome.fileManagerPrivate.MountCondition|undefined),
77 * mountContext: (string|undefined) 358 * mountContext: (!chrome.fileManagerPrivate.MountContext|undefined)
78 * }} 359 * }}
360 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-VolumeMe tadata
79 */ 361 */
80 var VolumeMetadata; 362 chrome.fileManagerPrivate.VolumeMetadata;
81 363
82 /** 364 /**
83 * @typedef {{ 365 * @typedef {{
84 * eventType: string, 366 * eventType: !chrome.fileManagerPrivate.MountCompletedEventType,
85 * status: string, 367 * status: !chrome.fileManagerPrivate.MountCompletedStatus,
86 * volumeMetadata: VolumeMetadata, 368 * volumeMetadata: !chrome.fileManagerPrivate.VolumeMetadata,
87 * shouldNotify: boolean 369 * shouldNotify: boolean
88 * }} 370 * }}
371 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-MountCom pletedEvent
89 */ 372 */
90 var MountCompletedEvent; 373 chrome.fileManagerPrivate.MountCompletedEvent;
91 374
92 /** 375 /**
93 * @typedef {{ 376 * @typedef {{
94 * fileUrl: string, 377 * fileUrl: string,
95 * transferState: string, 378 * transferState: !chrome.fileManagerPrivate.TransferState,
96 * transferType: string, 379 * transferType: !chrome.fileManagerPrivate.TransferType,
97 * processed: number, 380 * processed: number,
98 * total: number, 381 * total: number,
99 * num_total_jobs: number 382 * num_total_jobs: number
100 * }} 383 * }}
384 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-FileTran sferStatus
101 */ 385 */
102 var FileTransferStatus; 386 chrome.fileManagerPrivate.FileTransferStatus;
103 387
104 /** 388 /**
105 * @typedef {{ 389 * @typedef {{
106 * type: string, 390 * type: !chrome.fileManagerPrivate.DriveSyncErrorType,
107 * fileUrl: string 391 * fileUrl: string
108 * }} 392 * }}
393 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DriveSyn cErrorEvent
109 */ 394 */
110 var DriveSyncErrorEvent; 395 chrome.fileManagerPrivate.DriveSyncErrorEvent;
111 396
112 /** 397 /**
113 * @typedef {{ 398 * @typedef {{
114 * type: string, 399 * type: !chrome.fileManagerPrivate.CopyProgressStatusType,
115 * sourceUrl: (string|undefined), 400 * sourceUrl: (string|undefined),
116 * destinationUrl: (string|undefined), 401 * destinationUrl: (string|undefined),
117 * size: (number|undefined), 402 * size: (number|undefined),
118 * error: (string|undefined) 403 * error: (string|undefined)
119 * }} 404 * }}
405 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-CopyProg ressStatus
120 */ 406 */
121 var CopyProgressStatus; 407 chrome.fileManagerPrivate.CopyProgressStatus;
122 408
123 /** 409 /**
124 * @typedef {{ 410 * @typedef {{
125 * url: string, 411 * url: string,
126 * changes: Array 412 * changes: !Array<!chrome.fileManagerPrivate.ChangeType>
127 * }} 413 * }}
414 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-FileChan ge
128 */ 415 */
129 var FileChange; 416 chrome.fileManagerPrivate.FileChange;
130 417
131 /** 418 /**
132 * @typedef {{ 419 * @typedef {{
133 * eventType: string, 420 * eventType: !chrome.fileManagerPrivate.FileWatchEventType,
134 * entry: Object, 421 * entry: Object,
135 * changedFiles: (Array|undefined) 422 * changedFiles: (!Array<!chrome.fileManagerPrivate.FileChange>|undefined)
136 * }} 423 * }}
424 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-FileWatc hEvent
137 */ 425 */
138 var FileWatchEvent; 426 chrome.fileManagerPrivate.FileWatchEvent;
139 427
140 /** 428 /**
141 * @typedef {{ 429 * @typedef {{
142 * driveEnabled: boolean, 430 * driveEnabled: boolean,
143 * cellularDisabled: boolean, 431 * cellularDisabled: boolean,
144 * hostedFilesDisabled: boolean, 432 * hostedFilesDisabled: boolean,
145 * searchSuggestEnabled: boolean, 433 * searchSuggestEnabled: boolean,
146 * use24hourClock: boolean, 434 * use24hourClock: boolean,
147 * allowRedeemOffers: boolean, 435 * allowRedeemOffers: boolean,
148 * timezone: string 436 * timezone: string
149 * }} 437 * }}
438 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Preferen ces
150 */ 439 */
151 var Preferences; 440 chrome.fileManagerPrivate.Preferences;
152 441
153 /** 442 /**
154 * @typedef {{ 443 * @typedef {{
155 * cellularDisabled: (boolean|undefined), 444 * cellularDisabled: (boolean|undefined),
156 * hostedFilesDisabled: (boolean|undefined) 445 * hostedFilesDisabled: (boolean|undefined)
157 * }} 446 * }}
447 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Preferen cesChange
158 */ 448 */
159 var PreferencesChange; 449 chrome.fileManagerPrivate.PreferencesChange;
160 450
161 /** 451 /**
162 * @typedef {{ 452 * @typedef {{
163 * query: string, 453 * query: string,
164 * nextFeed: string 454 * nextFeed: string
165 * }} 455 * }}
456 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-SearchPa rams
166 */ 457 */
167 var SearchParams; 458 chrome.fileManagerPrivate.SearchParams;
168 459
169 /** 460 /**
170 * @typedef {{ 461 * @typedef {{
171 * query: string, 462 * query: string,
172 * types: string, 463 * types: !chrome.fileManagerPrivate.SearchType,
173 * maxResults: number 464 * maxResults: number
174 * }} 465 * }}
466 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-SearchMe tadataParams
175 */ 467 */
176 var SearchMetadataParams; 468 chrome.fileManagerPrivate.SearchMetadataParams;
177 469
178 /** 470 /**
179 * @typedef {{ 471 * @typedef {{
180 * entry: Object, 472 * entry: Object,
181 * highlightedBaseName: string 473 * highlightedBaseName: string
182 * }} 474 * }}
475 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-SearchRe sult
183 */ 476 */
184 var SearchResult; 477 chrome.fileManagerPrivate.SearchResult;
185 478
186 /** 479 /**
187 * @typedef {{ 480 * @typedef {{
188 * type: string, 481 * type: string,
189 * reason: (string|undefined) 482 * reason: (string|undefined),
483 * hasCellularNetworkAccess: boolean
190 * }} 484 * }}
485 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DriveCon nectionState
191 */ 486 */
192 var DriveConnectionState; 487 chrome.fileManagerPrivate.DriveConnectionState;
193 488
194 /** 489 /**
195 * @typedef {{ 490 * @typedef {{
196 * type: string, 491 * type: !chrome.fileManagerPrivate.DeviceEventType,
197 * devicePath: string 492 * devicePath: string
198 * }} 493 * }}
494 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-DeviceEv ent
199 */ 495 */
200 var DeviceEvent; 496 chrome.fileManagerPrivate.DeviceEvent;
201 497
202 /** 498 /**
203 * @typedef {{ 499 * @typedef {{
204 * extensionId: string, 500 * extensionId: string,
205 * name: string, 501 * name: string,
206 * configurable: boolean, 502 * configurable: boolean,
207 * watchable: boolean, 503 * watchable: boolean,
208 * multipleMounts: boolean, 504 * multipleMounts: boolean,
209 * source: string 505 * source: !chrome.fileManagerPrivate.manifestTypes.FileSystemProviderSource
210 * }} 506 * }}
507 * @see https://developer.chrome.com/extensions/fileManagerPrivate#type-Providin gExtension
211 */ 508 */
212 var ProvidingExtension; 509 chrome.fileManagerPrivate.ProvidingExtension;
213
214 /**
215 * @typedef {{
216 * id: string,
217 * title: (string|undefined)
218 * }}
219 */
220 var EntryAction;
221
222 /**
223 * @const
224 */
225 chrome.fileManagerPrivate = {};
226 510
227 /** 511 /**
228 * Logout the current user for navigating to the re-authentication screen for 512 * Logout the current user for navigating to the re-authentication screen for
229 * the Google account. 513 * the Google account.
514 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-logout UserForReauthentication
230 */ 515 */
231 chrome.fileManagerPrivate.logoutUserForReauthentication = function() {}; 516 chrome.fileManagerPrivate.logoutUserForReauthentication = function() {};
232 517
233 /** 518 /**
234 * Cancels file selection. 519 * Cancels file selection.
520 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-cancel Dialog
235 */ 521 */
236 chrome.fileManagerPrivate.cancelDialog = function() {}; 522 chrome.fileManagerPrivate.cancelDialog = function() {};
237 523
238 /** 524 /**
239 * Executes file browser task over selected files. |taskId| The unique 525 * Executes file browser task over selected files. |taskId| The unique
240 * identifier of task to execute. |entries| Array of file entries |callback| 526 * identifier of task to execute. |entries| Array of entries |callback|
241 * @param {string} taskId 527 * @param {string} taskId
242 * @param {!Array<!Entry>} entries 528 * @param {!Array<Object>} entries
243 * @param {function((boolean|undefined))} callback |result| Result of the task 529 * @param {function(!chrome.fileManagerPrivate.TaskResult):void} callback
244 * execution. 530 * |result| Result of the task execution.
531 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-execut eTask
245 */ 532 */
246 chrome.fileManagerPrivate.executeTask = function(taskId, entries, callback) {}; 533 chrome.fileManagerPrivate.executeTask = function(taskId, entries, callback) {};
247 534
248 /** 535 /**
249 * Sets the default task for the supplied MIME types and path extensions. 536 * Sets the default task for the supplied MIME types and path extensions. Lists
250 * Lists of MIME types and entries may contain duplicates. 537 * of MIME types and URLs may contain duplicates. Additionally, the list of MIME
251 * |taskId| The unique identifier of task to mark as default. |entries| Array 538 * types can be empty. |taskId| The unique identifier of task to mark as
252 * of selected file entries to extract path extensions from. |mimeTypes| Array 539 * default. |entries| Array of selected entries to extract path extensions from.
253 * of selected file MIME types. |callback| 540 * |mimeTypes| Array of selected file MIME types. |callback|
254 * @param {string} taskId 541 * @param {string} taskId
255 * @param {!Array<!Entry>} entries 542 * @param {!Array<Object>} entries
256 * @param {!Array<string>} mimeTypes 543 * @param {!Array<string>} mimeTypes
257 * @param {!function()} callback Callback that does not take arguments. 544 * @param {function():void} callback Callback that does not take arguments.
545 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-setDef aultTask
258 */ 546 */
259 chrome.fileManagerPrivate.setDefaultTask = function(taskId, entries, mimeTypes, 547 chrome.fileManagerPrivate.setDefaultTask = function(taskId, entries, mimeTypes, callback) {};
260 callback) {};
261 548
262 /** 549 /**
263 * Gets the list of tasks that can be performed over selected files. |entries| 550 * Gets the list of tasks that can be performed over selected files. |entries|
264 * Array of selected entries |callback| 551 * Array of selected entries |callback|
265 * @param {!Array<!Entry>} entries 552 * @param {!Array<Object>} entries
266 * @param {function((!Array<!FileTask>|undefined))} callback |tasks| The list of 553 * @param {function(!Array<!chrome.fileManagerPrivate.FileTask>):void} callback
267 * matched file entries for this task. 554 * |tasks| The list of matched file entries for this task.
555 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getFil eTasks
268 */ 556 */
269 chrome.fileManagerPrivate.getFileTasks = function(entries, callback) {}; 557 chrome.fileManagerPrivate.getFileTasks = function(entries, callback) {};
270 558
271 /** 559 /**
560 * Gets the MIME type of a file. |entry| Entry to be checked. |callback|
561 * @param {Object} entry
562 * @param {function(string):void} callback |result| Mime type of the file.
563 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getMim eType
564 */
565 chrome.fileManagerPrivate.getMimeType = function(entry, callback) {};
566
567 /**
272 * Gets localized strings and initialization data. |callback| 568 * Gets localized strings and initialization data. |callback|
273 * @param {function((!Object|undefined))} callback |result| Hash containing the 569 * @param {function(Object):void} callback |result| Hash containing the string
274 * string assets. 570 * assets.
571 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getStr ings
275 */ 572 */
276 chrome.fileManagerPrivate.getStrings = function(callback) {}; 573 chrome.fileManagerPrivate.getStrings = function(callback) {};
277 574
278 /** 575 /**
279 * Adds file watch. |entry| Entry of file to watch |callback| 576 * Adds file watch. |entry| Entry to watch |callback|
280 * @param {!Entry} entry 577 * @param {Object} entry
281 * @param {function((boolean|undefined))} callback |success| True when file 578 * @param {function(boolean):void} callback |success| True when file watch is
282 * watch is successfully added. 579 * successfully added.
580 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-addFil eWatch
283 */ 581 */
284 chrome.fileManagerPrivate.addFileWatch = function(entry, callback) {}; 582 chrome.fileManagerPrivate.addFileWatch = function(entry, callback) {};
285 583
286 /** 584 /**
287 * Removes file watch. |entry| Entry of watched file to remove |callback| 585 * Removes file watch. |entry| Watched entry |callback|
288 * @param {!Entry} entry 586 * @param {Object} entry
289 * @param {function((boolean|undefined))} callback |success| True when file 587 * @param {function(boolean):void} callback |success| True when file watch is
290 * watch is successfully 588 * successfully removed.
291 * removed. 589 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-remove FileWatch
292 */ 590 */
293 chrome.fileManagerPrivate.removeFileWatch = function(entry, callback) {}; 591 chrome.fileManagerPrivate.removeFileWatch = function(entry, callback) {};
294 592
295 /** 593 /**
296 * Enables the extenal file scheme necessary to initiate drags to the browser 594 * Enables the extenal file scheme necessary to initiate drags to the browser
297 * window for files on the external backend. 595 * window for files on the external backend.
596 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-enable ExternalFileScheme
298 */ 597 */
299 chrome.fileManagerPrivate.enableExternalFileScheme = function() {}; 598 chrome.fileManagerPrivate.enableExternalFileScheme = function() {};
300 599
301 /** 600 /**
302 * Requests R/W access to the specified entries as |entryUrls|. Note, that only 601 * Requests granting R/W permissions for the passed entries. It's a best effort
303 * files backed by external file system backend will be granted the access. 602 * operation. Some files may not be granted access if the url is invalid or not
603 * backed by the external file system. |entryUrls| Urls for the entries to be
604 * accessed. |callback|
304 * @param {!Array<string>} entryUrls 605 * @param {!Array<string>} entryUrls
305 * @param {function()} callback Completion callback. 606 * @param {function():void} callback Callback that does not take arguments.
607 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-grantA ccess
306 */ 608 */
307 chrome.fileManagerPrivate.grantAccess = function(entryUrls, callback) {}; 609 chrome.fileManagerPrivate.grantAccess = function(entryUrls, callback) {};
308 610
309 /** 611 /**
310 * Selects multiple files. |selectedPaths| Array of selected paths 612 * Selects multiple files. |selectedPaths| Array of selected paths
311 * |shouldReturnLocalPath| true if paths need to be resolved to local paths. 613 * |shouldReturnLocalPath| true if paths need to be resolved to local paths.
312 * |callback| 614 * |callback|
313 * @param {!Array<string>} selectedPaths 615 * @param {!Array<string>} selectedPaths
314 * @param {boolean} shouldReturnLocalPath 616 * @param {boolean} shouldReturnLocalPath
315 * @param {function()} callback Callback that does not take arguments. 617 * @param {function():void} callback Callback that does not take arguments.
618 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-select Files
316 */ 619 */
317 chrome.fileManagerPrivate.selectFiles = function(selectedPaths, 620 chrome.fileManagerPrivate.selectFiles = function(selectedPaths, shouldReturnLoca lPath, callback) {};
318 shouldReturnLocalPath, callback) {};
319 621
320 /** 622 /**
321 * Selects a file. |selectedPath| A selected path |index| Index of Filter 623 * Selects a file. |selectedPath| A selected path |index| Index of Filter
322 * |forOpening| true if paths are selected for opening. false if for saving. 624 * |forOpening| true if paths are selected for opening. false if for saving.
323 * |shouldReturnLocalPath| true if paths need to be resolved to local paths. 625 * |shouldReturnLocalPath| true if paths need to be resolved to local paths.
324 * |callback| 626 * |callback|
325 * @param {string} selectedPath 627 * @param {string} selectedPath
326 * @param {number} index 628 * @param {number} index
327 * @param {boolean} forOpening 629 * @param {boolean} forOpening
328 * @param {boolean} shouldReturnLocalPath 630 * @param {boolean} shouldReturnLocalPath
329 * @param {function()} callback Callback that does not take arguments. 631 * @param {function():void} callback Callback that does not take arguments.
632 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-select File
330 */ 633 */
331 chrome.fileManagerPrivate.selectFile = function(selectedPath, index, forOpening, 634 chrome.fileManagerPrivate.selectFile = function(selectedPath, index, forOpening, shouldReturnLocalPath, callback) {};
332 shouldReturnLocalPath, callback) {};
333 635
334 /** 636 /**
335 * Requests additional properties for files. |entries| list of entries of files 637 * Requests additional properties for files. |entries| list of entries |names|
336 * |callback| 638 * list of requested properties by their names. |callback| Completion callback.
337 * @param {!Array<!Entry>} entries 639 * May return less than requested properties if some are not available. In
338 * @param {!Array<string>} names 640 * the same time, it can return properties which were not requested (if it's
339 * @param {function((!Array<!EntryProperties>|undefined))} callback 641 * cheap to compute them).
340 * |entryProperties| A dictionary containing properties of the requested 642 * @param {!Array<Object>} entries
341 * entries. 643 * @param {!Array<!chrome.fileManagerPrivate.EntryPropertyName>} names
644 * @param {function(!Array<!chrome.fileManagerPrivate.EntryProperties>):void}
645 * callback |entryProperties| A dictionary containing properties of the
646 * requested entries.
647 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getEnt ryProperties
342 */ 648 */
343 chrome.fileManagerPrivate.getEntryProperties = function(entries, names, 649 chrome.fileManagerPrivate.getEntryProperties = function(entries, names, callback ) {};
344 callback) {};
345 650
346 /** 651 /**
347 * Pins/unpins a Drive file in the cache. |entry| Entry of a file to pin/unpin. 652 * Pins/unpins a Drive file in the cache. |entry| Entry to pin/unpin. |pin| Pass
348 * |pin| Pass true to pin the file. |callback| Completion callback. 653 * true to pin the file. |callback| Completion callback.
349 * $(ref:runtime.lastError) will be set if there was an error. 654 * $(ref:runtime.lastError) will be set if there was an error.
350 * @param {!Entry} entry 655 * @param {Object} entry
351 * @param {boolean} pin 656 * @param {boolean} pin
352 * @param {function()} callback Callback that does not take arguments. 657 * @param {function():void} callback Callback that does not take arguments.
658 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-pinDri veFile
353 */ 659 */
354 chrome.fileManagerPrivate.pinDriveFile = function(entry, pin, callback) {}; 660 chrome.fileManagerPrivate.pinDriveFile = function(entry, pin, callback) {};
355 661
356 /** 662 /**
357 * Resolves file entries in the isolated file system and returns corresponding 663 * Resolves entries in the isolated file system and returns corresponding
358 * entries in the external file system mounted to Chrome OS file manager 664 * entries in the external file system mounted to Chrome OS file manager
359 * backend. If resolving entry fails, the entry will be just ignored and the 665 * backend. If resolving entry fails, the entry will be just ignored and the
360 * corresponding entry does not appear in the result. 666 * corresponding entry does not appear in the result.
361 * @param {!Array<!Entry>} entries 667 * @param {!Array<Object>} entries
362 * @param {function((!Array<!Entry>|undefined))} callback Completion callback 668 * @param {function(!Array<Object>):void} callback |entries| External entries.
363 * with resolved entries. 669 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-resolv eIsolatedEntries
364 */ 670 */
365 chrome.fileManagerPrivate.resolveIsolatedEntries = function(entries, 671 chrome.fileManagerPrivate.resolveIsolatedEntries = function(entries, callback) { };
366 callback) {};
367 672
368 /** 673 /**
369 * Mount a resource or a file. |source| Mount point source. For compressed 674 * Mount a resource or a file. |source| Mount point source. For compressed files
370 * files it is relative file path within external file system |callback| 675 * it is relative file path within external file system |callback|
371 * @param {string} source 676 * @param {string} source
372 * @param {function((string|undefined))} callback Callback with source path of 677 * @param {function(string):void} callback |sourcePath| Source path of the
373 * the mount. 678 * mount.
679 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-addMou nt
374 */ 680 */
375 chrome.fileManagerPrivate.addMount = function(source, callback) {}; 681 chrome.fileManagerPrivate.addMount = function(source, callback) {};
376 682
377 /** 683 /**
378 * Unmounts a mounted resource. |volumeId| An ID of the volume. 684 * Unmounts a mounted resource. |volumeId| An ID of the volume.
379 * @param {string} volumeId 685 * @param {string} volumeId
686 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-remove Mount
380 */ 687 */
381 chrome.fileManagerPrivate.removeMount = function(volumeId) {}; 688 chrome.fileManagerPrivate.removeMount = function(volumeId) {};
382 689
383 /** 690 /**
384 * Get the list of mounted volumes. |callback| 691 * Get the list of mounted volumes. |callback|
385 * @param {function((!Array<!VolumeMetadata>|undefined))} callback Callback with 692 * @param {function(!Array<!chrome.fileManagerPrivate.VolumeMetadata>):void}
386 * the list of VolumeMetadata representing mounted volumes. 693 * callback |volumeMetadataList| The list of VolumeMetadata representing
694 * mounted volumes.
695 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getVol umeMetadataList
387 */ 696 */
388 chrome.fileManagerPrivate.getVolumeMetadataList = function(callback) {}; 697 chrome.fileManagerPrivate.getVolumeMetadataList = function(callback) {};
389 698
390 /** 699 /**
391 * Cancels ongoing file transfers for selected files. |entries| Array of files 700 * Cancels ongoing file transfers for selected files. |entries| Array of files
392 * for which ongoing transfer should be canceled. 701 * for which ongoing transfer should be canceled. |callback| Completion callback
393 * @param {!Array<!FileEntry>} entries 702 * of the cancel.
394 * @param {function()} callback 703 * @param {!Array<Object>} entries
704 * @param {function():void} callback Callback that does not take arguments.
705 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-cancel FileTransfers
395 */ 706 */
396 chrome.fileManagerPrivate.cancelFileTransfers = function(entries, callback) {}; 707 chrome.fileManagerPrivate.cancelFileTransfers = function(entries, callback) {};
397 708
398 /** 709 /**
399 * Cancels all ongoing file transfers. 710 * Cancels all ongoing file transfers. |callback| Completion callback of the
400 * @param {function()} callback 711 * cancel.
712 * @param {function():void} callback Callback that does not take arguments.
713 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-cancel AllFileTransfers
401 */ 714 */
402 chrome.fileManagerPrivate.cancelAllFileTransfers = function(callback) {}; 715 chrome.fileManagerPrivate.cancelAllFileTransfers = function(callback) {};
403 716
404 /** 717 /**
405 * Starts to copy an entry. If the source is a directory, the copy is done 718 * Starts to copy an entry. If the source is a directory, the copy is done
406 * recursively. |entry| Entry of the source entry to be copied. |parent| Entry 719 * recursively. |entry| Entry of the source entry to be copied. |parentEntry|
407 * of the destination directory. |newName| Name of the new entry. It must not 720 * Entry for the destination (parent) directory. |newName| Name of the new
408 * contain '/'. |callback| Completion callback. 721 * entry. It must not contain '/'. |callback| Completion callback.
409 * @param {!Entry} entry 722 * @param {Object} entry
410 * @param {!DirectoryEntry} parentEntry 723 * @param {Object} parentEntry
411 * @param {string} newName 724 * @param {string} newName
412 * @param {function((number|undefined))} callback |copyId| ID of the copy task. 725 * @param {function(number):void} callback |copyId| ID of the copy task. Can be
413 * Can be used to identify the progress, and to cancel the task. 726 * used to identify the progress, and to cancel the task.
727 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-startC opy
414 */ 728 */
415 chrome.fileManagerPrivate.startCopy = function(entry, parentEntry, newName, 729 chrome.fileManagerPrivate.startCopy = function(entry, parentEntry, newName, call back) {};
416 callback) {};
417 730
418 /** 731 /**
419 * Cancels the running copy task. |copyId| ID of the copy task to be cancelled. 732 * Cancels the running copy task. |copyId| ID of the copy task to be cancelled.
420 * |callback| Completion callback of the cancel. 733 * |callback| Completion callback of the cancel.
421 * @param {number} copyId 734 * @param {number} copyId
422 * @param {function()} callback Callback that does not take arguments. 735 * @param {function():void} callback Callback that does not take arguments.
736 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-cancel Copy
423 */ 737 */
424 chrome.fileManagerPrivate.cancelCopy = function(copyId, callback) {}; 738 chrome.fileManagerPrivate.cancelCopy = function(copyId, callback) {};
425 739
426 /** 740 /**
427 * Retrieves total and remaining size of a mount point. |volumeId| ID of the 741 * Retrieves total and remaining size of a mount point. |volumeId| ID of the
428 * volume to be checked. |callback| 742 * volume to be checked. |callback|
429 * @param {string} volumeId 743 * @param {string} volumeId
430 * @param {function((!MountPointSizeStats|undefined))} callback Name/value pairs 744 * @param {function(!chrome.fileManagerPrivate.MountPointSizeStats):void}
431 * of size stats. Will be undefined if stats could not be determined. 745 * callback |sizeStats| Name/value pairs of size stats. Will be undefined if
746 * stats could not be determined.
747 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getSiz eStats
432 */ 748 */
433 chrome.fileManagerPrivate.getSizeStats = function(volumeId, callback) {}; 749 chrome.fileManagerPrivate.getSizeStats = function(volumeId, callback) {};
434 750
435 /** 751 /**
436 * Formats a mounted volume. |volumeId| ID of the volume to be formatted. 752 * Formats a mounted volume. |volumeId| ID of the volume to be formatted.
437 * @param {string} volumeId 753 * @param {string} volumeId
754 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-format Volume
438 */ 755 */
439 chrome.fileManagerPrivate.formatVolume = function(volumeId) {}; 756 chrome.fileManagerPrivate.formatVolume = function(volumeId) {};
440 757
441 /** 758 /**
442 * Retrieves file manager preferences. |callback| 759 * Retrieves file manager preferences. |callback|
443 * @param {function((!Preferences|undefined))} callback 760 * @param {function(!chrome.fileManagerPrivate.Preferences):void} callback
761 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getPre ferences
444 */ 762 */
445 chrome.fileManagerPrivate.getPreferences = function(callback) {}; 763 chrome.fileManagerPrivate.getPreferences = function(callback) {};
446 764
447 /** 765 /**
448 * Sets file manager preferences. |changeInfo| 766 * Sets file manager preferences. |changeInfo|
449 * @param {PreferencesChange} changeInfo 767 * @param {!chrome.fileManagerPrivate.PreferencesChange} changeInfo
768 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-setPre ferences
450 */ 769 */
451 chrome.fileManagerPrivate.setPreferences = function(changeInfo) {}; 770 chrome.fileManagerPrivate.setPreferences = function(changeInfo) {};
452 771
453 /** 772 /**
454 * Performs drive content search. |searchParams| |callback| 773 * Performs drive content search. |searchParams| |callback|
455 * @param {SearchParams} searchParams 774 * @param {!chrome.fileManagerPrivate.SearchParams} searchParams
456 * @param {function((!Array<Entry>|undefined), (string|undefined))} callback 775 * @param {function(!Array<Object>, string):void} callback |entries| |nextFeed|
457 * Entries and ID of the feed that contains next chunk of the search result. 776 * ID of the feed that contains next chunk of the search result. Should
458 * Should be sent to the next searchDrive request to perform incremental search. 777 * be sent to the next searchDrive request to perform incremental
778 * search.
779 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-search Drive
459 */ 780 */
460 chrome.fileManagerPrivate.searchDrive = function(searchParams, callback) {}; 781 chrome.fileManagerPrivate.searchDrive = function(searchParams, callback) {};
461 782
462 /** 783 /**
463 * Performs drive metadata search. |searchParams| |callback| 784 * Performs drive metadata search. |searchParams| |callback|
464 * @param {SearchMetadataParams} searchParams 785 * @param {!chrome.fileManagerPrivate.SearchMetadataParams} searchParams
465 * @param {function((!Array<!SearchResult>|undefined))} callback 786 * @param {function(!Array<!chrome.fileManagerPrivate.SearchResult>):void}
787 * callback
788 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-search DriveMetadata
466 */ 789 */
467 chrome.fileManagerPrivate.searchDriveMetadata = function(searchParams, 790 chrome.fileManagerPrivate.searchDriveMetadata = function(searchParams, callback) {};
468 callback) {};
469 791
470 /** 792 /**
471 * Search for files in the given volume, whose content hash matches the list of 793 * Search files in the volume having |volumeId| by using |hashList|.
472 * given hashes. 794 * sub-directories) the given |targetDirectoryUrl|.
473 * @param {string} volumeId 795 * @param {string} volumeId
474 * @param {!Array<string>} hashes 796 * @param {!Array<string>} hashList
475 * @param {function((!Object<string, !Array<string>>|undefined))} callback 797 * @param {function(Object):void} callback |urls| The map of hash and array of
798 * FileEntry's URL. The array can be empty if the corresponding file is not
799 * found.
800 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-search FilesByHashes
476 */ 801 */
477 chrome.fileManagerPrivate.searchFilesByHashes = function(volumeId, hashes, 802 chrome.fileManagerPrivate.searchFilesByHashes = function(volumeId, hashList, cal lback) {};
478 callback) {};
479 803
480 /** 804 /**
481 * Create a zip file for the selected files. |parentEntry| Entry of the 805 * Create a zip file for the selected files. |parentEntry| Entry of the
482 * directory containing the selected files. |entries| Selected entries. 806 * directory containing the selected files. |entries| Entries of the selected
483 * The files must be under the directory specified by |parentEntry|. |destName| 807 * files. The files must be under the directory specified by |parentEntry|.
484 * Name of the destination zip file. The zip file will be created under the 808 * |destName| Name of the destination zip file. The zip file will be created
485 * directory specified by |parentEntry|. 809 * under the directory specified by |parentEntry|. |callback| TODO(mtomasz):
486 * @param {!DirectoryEntry} parentEntry 810 * Swap order of |entries| and |parentEntry|.
487 * @param {!Array<!Entry>} entries 811 * @param {Object} parentEntry
812 * @param {!Array<Object>} entries
488 * @param {string} destName 813 * @param {string} destName
489 * @param {function((boolean|undefined))} callback 814 * @param {function(boolean):void} callback
815 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-zipSel ection
490 */ 816 */
491 chrome.fileManagerPrivate.zipSelection = function(parentEntry, entries, 817 chrome.fileManagerPrivate.zipSelection = function(parentEntry, entries, destName , callback) {};
492 destName, callback) {};
493 818
494 /** 819 /**
495 * Retrieves the state of the current drive connection. |callback| 820 * Retrieves the state of the current drive connection. |callback|
496 * @param {function((!DriveConnectionState|undefined))} callback 821 * @param {function(!chrome.fileManagerPrivate.DriveConnectionState):void}
822 * callback
823 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getDri veConnectionState
497 */ 824 */
498 chrome.fileManagerPrivate.getDriveConnectionState = function(callback) {}; 825 chrome.fileManagerPrivate.getDriveConnectionState = function(callback) {};
499 826
500 /** 827 /**
501 * Checks whether the path name length fits in the limit of the filesystem. 828 * Checks whether the path name length fits in the limit of the filesystem.
502 * |parentEntry| The parent directory entry. |name| The name of the file. 829 * |parentEntry| The entry of the parent directory entry. |name| The name of the
503 * |callback| Called back when the check is finished. 830 * file. |callback| Called back when the check is finished.
504 * @param {!DirectoryEntry} parentEntry 831 * @param {Object} parentEntry
505 * @param {string} name 832 * @param {string} name
506 * @param {function((boolean|undefined))} callback |result| true if the length 833 * @param {function(boolean):void} callback |result| true if the length is in
507 * is in the valid range, false otherwise. 834 * the valid range, false otherwise.
835 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-valida tePathNameLength
508 */ 836 */
509 chrome.fileManagerPrivate.validatePathNameLength = function( 837 chrome.fileManagerPrivate.validatePathNameLength = function(parentEntry, name, c allback) {};
510 parentEntry, name, callback) {};
511 838
512 /** 839 /**
513 * Changes the zoom factor of the Files.app. |operation| Zooming mode. 840 * Changes the zoom factor of the Files.app. |operation| Zooming mode.
514 * @param {string} operation 841 * @param {!chrome.fileManagerPrivate.ZoomOperationType} operation
842 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-zoom
515 */ 843 */
516 chrome.fileManagerPrivate.zoom = function(operation) {}; 844 chrome.fileManagerPrivate.zoom = function(operation) {};
517 845
518 /** 846 /**
519 * Requests a Drive API OAuth2 access token. |refresh| Whether the token should 847 * Requests a Drive API OAuth2 access token. |refresh| Whether the token should
520 * be refetched instead of using the cached one. |callback| 848 * be refetched instead of using the cached one. |callback|
521 * @param {boolean} refresh 849 * @param {boolean} refresh
522 * @param {function((string|undefined))} callback |accessToken| OAuth2 access 850 * @param {function(string):void} callback |accessToken| OAuth2 access token, or
523 * token, or an empty string if failed to fetch. 851 * an empty string if failed to fetch.
852 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-reques tAccessToken
524 */ 853 */
525 chrome.fileManagerPrivate.requestAccessToken = function(refresh, callback) {}; 854 chrome.fileManagerPrivate.requestAccessToken = function(refresh, callback) {};
526 855
527 /** 856 /**
528 * Requests a Webstore API OAuth2 access token. |callback| 857 * Requests a Webstore API OAuth2 access token. |callback|
529 * @param {function((string|undefined))} callback |accessToken| OAuth2 access 858 * @param {function(string):void} callback |accessToken| OAuth2 access token, or
530 * token, or an empty string if failed to fetch. 859 * an empty string if failed to fetch.
860 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-reques tWebStoreAccessToken
531 */ 861 */
532 chrome.fileManagerPrivate.requestWebStoreAccessToken = function(callback) {}; 862 chrome.fileManagerPrivate.requestWebStoreAccessToken = function(callback) {};
533 863
534 /** 864 /**
535 * Requests a share dialog url for the specified file. 865 * Requests a share dialog url for the specified file. |entry| The entry to
536 * @param {!Entry} entry 866 * share. |callback|
537 * @param {function((string|undefined))} callback Callback with the result url. 867 * @param {Object} entry
868 * @param {function(string):void} callback |url| Result url.
869 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getSha reUrl
538 */ 870 */
539 chrome.fileManagerPrivate.getShareUrl = function(entry, callback) {}; 871 chrome.fileManagerPrivate.getShareUrl = function(entry, callback) {};
540 872
541 /** 873 /**
542 * Requests a download url to download the file contents. 874 * Requests a download url to download the file contents. |entry| The entry to
543 * @param {!Entry} entry 875 * download. |callback|
544 * @param {function((string|undefined))} callback Callback with the result url. 876 * @param {Object} entry
877 * @param {function(string):void} callback |url| Result url.
878 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getDow nloadUrl
545 */ 879 */
546 chrome.fileManagerPrivate.getDownloadUrl = function(entry, callback) {}; 880 chrome.fileManagerPrivate.getDownloadUrl = function(entry, callback) {};
547 881
548 /** 882 /**
549 * Requests to share drive files. 883 * Requests to share drive files. |entry| Entry to be shared. |shareType| Type
550 * @param {!Entry} entry 884 * of access that is getting granted.
551 * @param {string} shareType 885 * @param {Object} entry
552 * @param {function()} callback Callback that does not take arguments. 886 * @param {!chrome.fileManagerPrivate.DriveShareType} shareType
553 */ 887 * @param {function():void} callback Callback that does not take arguments.
554 chrome.fileManagerPrivate.requestDriveShare = function(entry, shareType, 888 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-reques tDriveShare
555 callback) {}; 889 */
556 890 chrome.fileManagerPrivate.requestDriveShare = function(entry, shareType, callbac k) {};
557 /**
558 * Requests to install a webstore item. |item_id| The id of the item to
559 * install. |silentInstallation| False to show installation prompt. True not to
560 * show. |callback|
561 * @param {string} itemId
562 * @param {boolean} silentInstallation
563 * @param {function()} callback Callback that does not take arguments.
564 */
565 chrome.fileManagerPrivate.installWebstoreItem = function(itemId,
566 silentInstallation, callback) {};
567 891
568 /** 892 /**
569 * Obtains a list of profiles that are logged-in. 893 * Obtains a list of profiles that are logged-in.
570 * @param {function((!Array<!ProfileInfo>|undefined), (string|undefined), 894 * @param {function(!Array<!chrome.fileManagerPrivate.ProfileInfo>, string, stri ng):void}
571 * (string|undefined))} callback Callback with list of profile information, 895 * callback |profiles| List of profile information. |runningProfile| ID of
572 * |runningProfile| ID of the profile that runs the application instance. 896 * the profile that runs the application instance. |showingProfile| ID of
573 * |showingProfile| ID of the profile that shows the application window. 897 * the profile that shows the application window.
898 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getPro files
574 */ 899 */
575 chrome.fileManagerPrivate.getProfiles = function(callback) {}; 900 chrome.fileManagerPrivate.getProfiles = function(callback) {};
576 901
577 /** 902 /**
578 * Opens inspector window. |type| InspectionType which specifies how to open 903 * Opens inspector window. |type| InspectionType which specifies how to open
579 * inspector. 904 * inspector.
580 * @param {string} type 905 * @param {!chrome.fileManagerPrivate.InspectionType} type
906 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-openIn spector
581 */ 907 */
582 chrome.fileManagerPrivate.openInspector = function(type) {}; 908 chrome.fileManagerPrivate.openInspector = function(type) {};
583 909
584 /** 910 /**
585 * Computes an MD5 checksum for the given file. 911 * Computes an MD5 checksum for the given file. |entry| The entry of the file to
586 * @param {!Entry} entry 912 * checksum. |callback|
587 * @param {function((string|undefined))} callback 913 * @param {Object} entry
914 * @param {function(string):void} callback |checksum| Result checksum.
915 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-comput eChecksum
588 */ 916 */
589 chrome.fileManagerPrivate.computeChecksum = function(entry, callback) {}; 917 chrome.fileManagerPrivate.computeChecksum = function(entry, callback) {};
590 918
591 /** 919 /**
592 * Gets the MIME type of a file. 920 * Is UMA enabled?
593 * @param {!Entry} entry 921 * @param {function(boolean):void} callback |result| Boolean result returned by
594 * @param {function((string|undefined))} callback Callback that MIME type of the 922 * the invoked function.
595 * file is passed. 923 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-isUMAE nabled
596 */
597 chrome.fileManagerPrivate.getMimeType = function(entry, callback) {};
598
599 /**
600 * Gets a flag indicating whether user metrics reporting is enabled.
601 * @param {function((boolean|undefined))} callback
602 */ 924 */
603 chrome.fileManagerPrivate.isUMAEnabled = function(callback) {}; 925 chrome.fileManagerPrivate.isUMAEnabled = function(callback) {};
604 926
605 /** 927 /**
606 * Sets a tag on a file or a directory. Only Drive files are supported. 928 * Sets a tag on a file or a directory. Only Drive files are supported.
607 * @param {!Entry} entry 929 * @param {Object} entry
608 * @param {string} visibility 'private' or 'public' 930 * @param {!chrome.fileManagerPrivate.EntryTagVisibility} visibility
609 * @param {string} key 931 * @param {string} key
610 * @param {string} value 932 * @param {string} value
611 * @param {function()} callback 933 * @param {function():void} callback Callback that does not take arguments.
612 */ 934 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-setEnt ryTag
613 chrome.fileManagerPrivate.setEntryTag = function(entry, visibility, key, 935 */
614 value, callback) {}; 936 chrome.fileManagerPrivate.setEntryTag = function(entry, visibility, key, value, callback) {};
615 937
616 /** 938 /**
617 * Gets a flag indicating whether PiexLoader is enabled. 939 * Returns if Piex loader is enabled.
618 * @param {function((boolean|undefined))} callback 940 * @param {function(boolean):void} callback |result| Boolean result returned by
941 * the invoked function.
942 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-isPiex LoaderEnabled
619 */ 943 */
620 chrome.fileManagerPrivate.isPiexLoaderEnabled = function(callback) {}; 944 chrome.fileManagerPrivate.isPiexLoaderEnabled = function(callback) {};
621 945
622 /** 946 /**
623 * Returns list of available providing extensions. 947 * Returns list of available providing extensions.
624 * @param {function((!Array<!ProvidingExtension>|undefined))} callback 948 * @param {function(!Array<!chrome.fileManagerPrivate.ProvidingExtension>):void}
949 * callback |extensions| List of providing extensions.
950 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getPro vidingExtensions
625 */ 951 */
626 chrome.fileManagerPrivate.getProvidingExtensions = function(callback) {}; 952 chrome.fileManagerPrivate.getProvidingExtensions = function(callback) {};
627 953
628 /** 954 /**
629 * Requests adding a new provided file system. If not possible, then an error 955 * Requests adding a new provided file system. If not possible, then an error
630 * via chrome.runtime.lastError is returned. 956 * via chrome.runtime.lastError is returned.
631 * @param {string} extensionId 957 * @param {string} extension_id
632 * @param {function()} callback 958 * @param {function():void} callback Callback that does not take arguments.
633 */ 959 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-addPro videdFileSystem
634 chrome.fileManagerPrivate.addProvidedFileSystem = 960 */
635 function(extensionId, callback) {}; 961 chrome.fileManagerPrivate.addProvidedFileSystem = function(extension_id, callbac k) {};
636 962
637 /** 963 /**
638 * Requests configuring an existing file system. If not possible, then returns 964 * Requests configuring an existing volume. If not possible, then returns an
639 * an error via chrome.runtime.lastError. 965 * error via chrome.runtime.lastError.
640 * @param {string} volumeId 966 * @param {string} volumeId
641 * @param {function()} callback 967 * @param {function():void} callback Callback that does not take arguments.
968 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-config ureVolume
642 */ 969 */
643 chrome.fileManagerPrivate.configureVolume = function(volumeId, callback) {}; 970 chrome.fileManagerPrivate.configureVolume = function(volumeId, callback) {};
644 971
645 /** 972 /**
646 * Requests fetching list of actions for the specified set of entries. If not 973 * Requests list of custom actions for the specified entries. If not possible,
647 * possible, then returns an error via chrome.runtime.lastError. 974 * then an error via chrome.runtime.lastError is returned.
648 * @param {!Array<!Entry>} entries 975 * @param {!Array<Object>} entries
649 * @param {function((!Array<!EntryAction>|undefined))} callback 976 * @param {function(!Array<!chrome.fileManagerPrivate.fileSystemProvider.Action> ):void}
977 * callback |actions| List of actions.
978 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getCus tomActions
650 */ 979 */
651 chrome.fileManagerPrivate.getCustomActions = function(entries, callback) {}; 980 chrome.fileManagerPrivate.getCustomActions = function(entries, callback) {};
652 981
653 /** 982 /**
983 * Executes a custom action for a set of entries. If not possible, then an error
984 * via chrome.runtime.lastError is returned.
985 * @param {!Array<Object>} entries
986 * @param {string} actionId
987 * @param {function():void} callback Callback that does not take arguments.
988 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-execut eCustomAction
989 */
990 chrome.fileManagerPrivate.executeCustomAction = function(entries, actionId, call back) {};
991
992 /**
654 * Get the total size of a directory. |entry| Entry of the target directory. 993 * Get the total size of a directory. |entry| Entry of the target directory.
655 * |callback| 994 * |callback|
656 * @param {!DirectoryEntry} entry 995 * @param {Object} entry
657 * @param {function(number)} callback 996 * @param {function(number):void} callback |size| result size.
997 * @see https://developer.chrome.com/extensions/fileManagerPrivate#method-getDir ectorySize
658 */ 998 */
659 chrome.fileManagerPrivate.getDirectorySize = function(entry, callback) {}; 999 chrome.fileManagerPrivate.getDirectorySize = function(entry, callback) {};
660 1000
661 /** 1001 /**
662 * Executes the action on the specified set of entries. If not possible, then 1002 * @type {!ChromeEvent}
663 * returns an error via chrome.runtime.lastError. 1003 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onMount Completed
664 * @param {!Array<!Entry>} entries 1004 */
665 * @param {string} actionId
666 * @param {function()} callback
667 */
668 chrome.fileManagerPrivate.executeCustomAction = function(
669 entries, actionId, callback) {};
670
671 /** @type {!ChromeEvent} */
672 chrome.fileManagerPrivate.onMountCompleted; 1005 chrome.fileManagerPrivate.onMountCompleted;
673 1006
674 /** @type {!ChromeEvent} */ 1007 /**
1008 * @type {!ChromeEvent}
1009 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onFileT ransfersUpdated
1010 */
675 chrome.fileManagerPrivate.onFileTransfersUpdated; 1011 chrome.fileManagerPrivate.onFileTransfersUpdated;
676 1012
677 /** @type {!ChromeEvent} */ 1013 /**
1014 * @type {!ChromeEvent}
1015 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onCopyP rogress
1016 */
678 chrome.fileManagerPrivate.onCopyProgress; 1017 chrome.fileManagerPrivate.onCopyProgress;
679 1018
680 /** @type {!ChromeEvent} */ 1019 /**
1020 * @type {!ChromeEvent}
1021 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onDirec toryChanged
1022 */
681 chrome.fileManagerPrivate.onDirectoryChanged; 1023 chrome.fileManagerPrivate.onDirectoryChanged;
682 1024
683 /** @type {!ChromeEvent} */ 1025 /**
1026 * @type {!ChromeEvent}
1027 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onPrefe rencesChanged
1028 */
684 chrome.fileManagerPrivate.onPreferencesChanged; 1029 chrome.fileManagerPrivate.onPreferencesChanged;
685 1030
686 /** @type {!ChromeEvent} */ 1031 /**
1032 * @type {!ChromeEvent}
1033 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onDrive ConnectionStatusChanged
1034 */
687 chrome.fileManagerPrivate.onDriveConnectionStatusChanged; 1035 chrome.fileManagerPrivate.onDriveConnectionStatusChanged;
688 1036
689 /** @type {!ChromeEvent} */ 1037 /**
1038 * @type {!ChromeEvent}
1039 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onDevic eChanged
1040 */
690 chrome.fileManagerPrivate.onDeviceChanged; 1041 chrome.fileManagerPrivate.onDeviceChanged;
691 1042
692 /** @type {!ChromeEvent} */ 1043 /**
1044 * @type {!ChromeEvent}
1045 * @see https://developer.chrome.com/extensions/fileManagerPrivate#event-onDrive SyncError
1046 */
693 chrome.fileManagerPrivate.onDriveSyncError; 1047 chrome.fileManagerPrivate.onDriveSyncError;
694
695 /** @enum {string} */
696 chrome.fileManagerPrivate.Verb = {
697 OPEN_WITH: 'open_with',
698 ADD_TO: 'add_to',
699 PACK_WITH: 'pack_with',
700 SHARE_WITH: 'share_with',
701 };
OLDNEW
« no previous file with comments | « third_party/WebKit/public/web/WebDOMFileSystem.h ('k') | tools/json_schema_compiler/idl_schema.py » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698