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

Side by Side Diff: chrome/common/extensions/api/file_system_provider.idl

Issue 356463002: [fsp] Add documentation for the File System Provider API. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src
Patch Set: Cleaned up. Created 6 years, 6 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 | Annotate | Revision Log
OLDNEW
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 [platforms=("chromeos"), 7 [platforms=("chromeos"),
8 implemented_in="chrome/browser/chromeos/extensions/file_system_provider/file_sy stem_provider_api.h"] 8 implemented_in="chrome/browser/chromeos/extensions/file_system_provider/file_sy stem_provider_api.h"]
9 namespace fileSystemProvider { 9 namespace fileSystemProvider {
10 // Error codes used by providing extensions in response to requests. For 10 // Error codes used by providing extensions in response to requests. For
(...skipping 110 matching lines...) Expand 10 before | Expand all | Expand 10 after
121 // Callback to handle an error raised from the browser. 121 // Callback to handle an error raised from the browser.
122 [nocompile] callback ErrorCallback = void([instanceOf=DOMError] object error); 122 [nocompile] callback ErrorCallback = void([instanceOf=DOMError] object error);
123 123
124 // Success callback for the <code>onGetMetadataRequested</code> event. 124 // Success callback for the <code>onGetMetadataRequested</code> event.
125 callback MetadataCallback = void(EntryMetadata metadata); 125 callback MetadataCallback = void(EntryMetadata metadata);
126 126
127 // Success callback for the <code>onReadDirectoryRequested</code> event. If 127 // Success callback for the <code>onReadDirectoryRequested</code> event. If
128 // more entries will be returned, then <code>hasMore</code> must be true, and 128 // more entries will be returned, then <code>hasMore</code> must be true, and
129 // it has to be called again with additional entries. If no more entries are 129 // it has to be called again with additional entries. If no more entries are
130 // available, then <code>hasMore</code> must be set to false. 130 // available, then <code>hasMore</code> must be set to false.
131 callback EntriesCallback = void(ResourceEntry[] entries, bool hasMore); 131 callback EntriesCallback = void(EntryMetadata[] entries, boolean hasMore);
132 132
133 // Success callback for the <code>onReadFileRequested</code> event. If more 133 // Success callback for the <code>onReadFileRequested</code> event. If more
134 // data will be returned, then <code>hasMore</code> must be true, and it 134 // data will be returned, then <code>hasMore</code> must be true, and it
135 // has to be called again with additional entries. If no more data is 135 // has to be called again with additional entries. If no more data is
136 // available, then <code>hasMore</code> must be set to false. 136 // available, then <code>hasMore</code> must be set to false.
137 callback FileDataCallback = void(ArrayBuffer data, bool hasMore); 137 callback FileDataCallback = void(ArrayBuffer data, boolean hasMore);
138 138
139 interface Functions { 139 interface Functions {
140 // Mounts a file system with the given <code>fileSystemId</code> and <code> 140 // Mounts a file system with the given <code>fileSystemId</code> and <code>
141 // displayName</code>. <code>displayName</code> will be shown in the left 141 // displayName</code>. <code>displayName</code> will be shown in the left
142 // panel of Files.app. <code>displayName</code> can contain any characters 142 // panel of Files.app. <code>displayName</code> can contain any characters
143 // including '/', but cannot be an empty string. <code>displayName</code> 143 // including '/', but cannot be an empty string. <code>displayName</code>
144 // should be descriptive but doesn't have to be unique. Duplicate display 144 // should be descriptive but doesn't have to be unique. Duplicate display
145 // names are uniquified by adding suffix like "(1)" in the Files app UI. 145 // names are uniquified by adding suffix like "(1)" in the Files app UI.
146 // 146 //
147 // If a file system with the passed <code>fileSystemId</code> is already 147 // If a file system with the passed <code>fileSystemId</code> is already
(...skipping 63 matching lines...) Expand 10 before | Expand all | Expand 10 after
211 // </code>. The results should be returned in chunks by calling <code> 211 // </code>. The results should be returned in chunks by calling <code>
212 // successCallback</code> several times. In case of an error, <code> 212 // successCallback</code> several times. In case of an error, <code>
213 // errorCallback</code> must be called. 213 // errorCallback</code> must be called.
214 [maxListeners=1] static void onReadFileRequested( 214 [maxListeners=1] static void onReadFileRequested(
215 ReadFileRequestedOptions options, 215 ReadFileRequestedOptions options,
216 FileDataCallback successCallback, 216 FileDataCallback successCallback,
217 ProviderErrorCallback errorCallback); 217 ProviderErrorCallback errorCallback);
218 }; 218 };
219 }; 219 };
220 220
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698