OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 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 // Use the <code>chrome.fileSystemProvider</code> API to create file systems, | 5 // Use the <code>chrome.fileSystemProvider</code> API to create file systems, |
6 // that can be accessible from the file manager on Chrome OS. | 6 // that can be accessible from the file manager on Chrome OS. |
7 [implemented_in="chrome/browser/chromeos/extensions/file_system_provider/file_sy
stem_provider_api.h"] | 7 [implemented_in="chrome/browser/chromeos/extensions/file_system_provider/file_sy
stem_provider_api.h"] |
8 namespace fileSystemProvider { | 8 namespace fileSystemProvider { |
9 // Error codes used by providing extensions in response to requests as well | 9 // Error codes used by providing extensions in response to requests as well |
10 // as in case of errors when calling methods of the API. For success, | 10 // as in case of errors when calling methods of the API. For success, |
(...skipping 526 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
537 // <code>fileSystemId</code>. | 537 // <code>fileSystemId</code>. |
538 static void get(DOMString fileSystemId, GetCallback callback); | 538 static void get(DOMString fileSystemId, GetCallback callback); |
539 | 539 |
540 // Notifies about changes in the watched directory at | 540 // Notifies about changes in the watched directory at |
541 // <code>observedPath</code> in <code>recursive</code> mode. If the file | 541 // <code>observedPath</code> in <code>recursive</code> mode. If the file |
542 // system is mounted with <code>supportsNofityTag</code>, then | 542 // system is mounted with <code>supportsNofityTag</code>, then |
543 // <code>tag</code> must be provided, and all changes since the last | 543 // <code>tag</code> must be provided, and all changes since the last |
544 // notification always reported, even if the system was shutdown. The last | 544 // notification always reported, even if the system was shutdown. The last |
545 // tag can be obtained with $(ref:getAll). | 545 // tag can be obtained with $(ref:getAll). |
546 // | 546 // |
| 547 // To use, the <code>file_system_provider.notify</code> manifest option |
| 548 // must be set to true. |
| 549 // |
547 // Value of <code>tag</code> can be any string which is unique per call, | 550 // Value of <code>tag</code> can be any string which is unique per call, |
548 // so it's possible to identify the last registered notification. Eg. if | 551 // so it's possible to identify the last registered notification. Eg. if |
549 // the providing extension starts after a reboot, and the last registered | 552 // the providing extension starts after a reboot, and the last registered |
550 // notification's tag is equal to "123", then it should call $(ref:notify) | 553 // notification's tag is equal to "123", then it should call $(ref:notify) |
551 // for all changes which happened since the change tagged as "123". It | 554 // for all changes which happened since the change tagged as "123". It |
552 // cannot be an empty string. | 555 // cannot be an empty string. |
553 // | 556 // |
554 // Not all providers are able to provide a tag, but if the file system has | 557 // Not all providers are able to provide a tag, but if the file system has |
555 // a changelog, then the tag can be eg. a change number, or a revision | 558 // a changelog, then the tag can be eg. a change number, or a revision |
556 // number. | 559 // number. |
(...skipping 173 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
730 // Raised when executing an action for a file or a directory is requested. | 733 // Raised when executing an action for a file or a directory is requested. |
731 // After the action is completed, <code>successCallback</code> must be | 734 // After the action is completed, <code>successCallback</code> must be |
732 // called. On error, <code>errorCallback</code> must be called. | 735 // called. On error, <code>errorCallback</code> must be called. |
733 [maxListeners=1, nodoc] static void onExecuteActionRequested( | 736 [maxListeners=1, nodoc] static void onExecuteActionRequested( |
734 ExecuteActionRequestedOptions options, | 737 ExecuteActionRequestedOptions options, |
735 ProviderSuccessCallback successCallback, | 738 ProviderSuccessCallback successCallback, |
736 ProviderErrorCallback errorCallback); | 739 ProviderErrorCallback errorCallback); |
737 }; | 740 }; |
738 }; | 741 }; |
739 | 742 |
OLD | NEW |