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

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

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

Powered by Google App Engine
This is Rietveld 408576698