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

Unified Diff: chrome/common/extensions/api/file_system_provider.idl

Issue 1151763007: Add the boilerplate for actions to File System Provider API. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Fixed. Created 5 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 side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/chrome_tests_unit.gypi ('k') | chrome/common/extensions/api/file_system_provider_internal.idl » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: chrome/common/extensions/api/file_system_provider.idl
diff --git a/chrome/common/extensions/api/file_system_provider.idl b/chrome/common/extensions/api/file_system_provider.idl
index 80986b6761b73acd9afcd38b7c8d3b4cee0d46ac..dedbb2a0793023c9993a6187a4a4d009a9ac50cf 100644
--- a/chrome/common/extensions/api/file_system_provider.idl
+++ b/chrome/common/extensions/api/file_system_provider.idl
@@ -8,7 +8,7 @@
namespace fileSystemProvider {
// Error codes used by providing extensions in response to requests as well
// as in case of errors when calling methods of the API. For success,
- // <code>OK</code> must be used.
+ // <code>"OK"</code> must be used.
enum ProviderError {
OK,
FAILED,
@@ -41,6 +41,17 @@ namespace fileSystemProvider {
DELETED
};
+ // List of common actions. <code>"SHARE"</code> is for sharing files with
+ // others. <code>"SAVE_FOR_OFFLINE"</code> for pinning (saving for offline
+ // access). <code>"OFFLINE_NOT_NECESSARY"</code> for notifying that the file
+ // doesn't need to be stored for offline access anymore.
+ // Used by $(ref:onGetActionsRequested) and $(ref:onExecuteActionRequested).
+ enum CommonActionId {
+ SAVE_FOR_OFFLINE,
+ OFFLINE_NOT_NECESSARY,
+ SHARE
+ };
+
// Represents metadata of a file or a directory.
dictionary EntryMetadata {
// True if it is a directory.
@@ -169,6 +180,18 @@ namespace fileSystemProvider {
boolean thumbnail;
};
+ // Options for the $(ref:onGetActionsRequested) event.
+ dictionary GetActionsRequestedOptions {
+ // The identifier of the file system related to this operation.
+ DOMString fileSystemId;
+
+ // The unique identifier of this request.
+ long requestId;
benwells 2015/06/23 06:29:38 Why is there a requestId?
mtomasz 2015/06/23 06:34:25 All FSP requests (file system related events wired
benwells 2015/06/23 06:51:06 ok makes sense.
+
+ // The path of the entry to return the list of actions for.
+ DOMString entryPath;
+ };
+
// Options for the $(ref:onReadDirectoryRequested) event.
dictionary ReadDirectoryRequestedOptions {
// The identifier of the file system related to this operation.
@@ -375,6 +398,31 @@ namespace fileSystemProvider {
boolean recursive;
};
+ // Information about an action for an entry.
+ dictionary Action {
+ // The identifier of the action. Any string or $(ref:CommonActionId) for
+ // common actions.
+ DOMString id;
+
+ // The title of the action. It may be ignored for common actions.
+ DOMString? title;
+ };
+
+ // Options for the $(ref:onExecuteActionRequested) event.
+ dictionary ExecuteActionRequestedOptions {
+ // The identifier of the file system related to this operation.
+ DOMString fileSystemId;
+
+ // The unique identifier of this request.
+ long requestId;
+
+ // The path of the entry to be used for the action.
+ DOMString entryPath;
+
+ // The identifier of the action to be executed.
+ DOMString actionId;
+ };
+
// Information about a change happened to an entry within the observed
// directory (including the entry itself).
dictionary Change {
@@ -434,8 +482,10 @@ namespace fileSystemProvider {
[nocompile] callback ProviderErrorCallback = void(ProviderError error);
// Success callback for the $(ref:onGetMetadataRequested) event.
- [nocompile] callback MetadataCallback = void(
- EntryMetadata metadata);
+ [nocompile] callback MetadataCallback = void(EntryMetadata metadata);
+
+ // Success callback for the $(ref:onGetActionsRequested) event.
+ [nocompile, nodoc] callback ActionsCallback = void(Action[] actions);
// Success callback for the $(ref:onReadDirectoryRequested) event. If more
// entries will be returned, then <code>hasMore</code> must be true, and it
@@ -537,6 +587,15 @@ namespace fileSystemProvider {
MetadataCallback successCallback,
ProviderErrorCallback errorCallback);
+ // Raised when list of actions for of a file or a directory at
+ // <code>entryPath</code>s requested. The actions must be returned with the
+ // <code>successCallback</code> call. In case of an error,
+ // <code>errorCallback</code> must be called.
+ [maxListeners=1, nodoc] static void onGetActionsRequested(
+ GetActionsRequestedOptions options,
+ ActionsCallback successCallback,
+ ProviderErrorCallback errorCallback);
+
// Raised when contents of a directory at <code>directoryPath</code> are
// requested. The results must be returned in chunks by calling the
// <code>successCallback</code> several times. In case of an error,
@@ -667,6 +726,14 @@ namespace fileSystemProvider {
RemoveWatcherRequestedOptions options,
ProviderSuccessCallback successCallback,
ProviderErrorCallback errorCallback);
+
+ // Raised when executing an action for a file or a directory is requested.
+ // After the action is completed, <code>successCallback</code> must be
+ // called. On error, <code>errorCallback</code> must be called.
+ [maxListeners=1, nodoc] static void onExecuteActionRequested(
+ ExecuteActionRequestedOptions options,
+ ProviderSuccessCallback successCallback,
+ ProviderErrorCallback errorCallback);
};
};
« no previous file with comments | « chrome/chrome_tests_unit.gypi ('k') | chrome/common/extensions/api/file_system_provider_internal.idl » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698