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

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

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

Powered by Google App Engine
This is Rietveld 408576698