Adds new private API manifest for Files.app copy.

chrome/common/extensions/api/file_browser_private.json

Index: chrome/common/extensions/api/file_browser_private.json
diff --git a/chrome/common/extensions/api/file_browser_private.json b/chrome/common/extensions/api/file_browser_private.json
index 98fb729224ec85660984670e94cf192f1b20e66a..4c59e5eccf1994e254386ecce40eb59f23c058f1 100644
--- a/chrome/common/extensions/api/file_browser_private.json
+++ b/chrome/common/extensions/api/file_browser_private.json
@@ -343,6 +343,33 @@
         }
       },
       {
+        "id": "CopyProgressStatus",
+        "type": "object",
+        "description": "Payload data for copy status progress updates.",
+        "properties": {
+          "type": {
+            "type": "string",
+            "enum": ["BEGIN_ENTRY_COPY", "END_ENTRY_COPY", "PROGRESS", "SUCCESS", "ERROR"],
+            "description": "The type of the progress event. BEGIN_ENTRY_COPY is called before for each entry copy, END_ENTRY_COPY is called after for each entry copy. PROGRESS is called periodically during copy. SUCCESS is called after all copy is completed. ERROR is called when an error is found."
+          },
+          "url": {
+            "type": "string",
+            "optional": true,
+            "description": "URL for the entry. Available only for BEGIN_ENTRY_COPY, END_ENTRY_COPY, PROGRESS and SUCCESS."

[satorux1, 2013/08/27 06:09:41]

If a directory copy is initiated with startCopy(), this field tells what file in
that  directory is now being copied, right? Then maybe:

"URL for the entry currently being copied. This field is particularly useful
when a directory copy is initiated with startCopy(). The field tells what file
in that directory is now being copied"

[hidehiko, 2013/08/27 06:32:18]

Done.

+          },
+          "size": {

[satorux1, 2013/08/27 06:09:41]

size -> num_bytes_copied ? see below

[hidehiko, 2013/08/27 06:32:18]

Will address in the next cycle. Please see also my reply below...

+            "type": "number",
+            "optional": true,
+            "description": "Number of processed bytes for each entry copy. Available only for PROGRESS event."

[satorux1, 2013/08/27 06:09:41]

What does this mean for a directory copy? I'm guessing this is the total number
of bytes copied so far for multiple files (sizes of copied files + copied bytes
of the file currently being copied), rather than just for the file currently
being copied.

To show a progress bar using the data, the client needs to pre-compute the total
number of bytes of all files. Would be nice to document it here.

[hidehiko, 2013/08/27 06:32:18]

No, this won't be cumulative, but just num of copied bytes for each file. I'm
thinking that;
suppose a/b/{c.txt (100bytes), d.txt (200bytes)} and trying copy a/ to x/
recursively, the event sequence will be:

BEGIN_ENTRY_COPY a/
<create x/a/>
END_ENTRY_COPY a/
BEGIN_ENTRY_COPY a/b/
<create x/a/b/>
END_ENTRY_COPY a/b/
BEGIN_ENTRY_COPY a/b/c.txt
PROGRESS a/b/c.txt 0
PROGRESS a/b/c.txt 10
  :
PROGRESS a/b/c.txt 100
END_ENTRY_COPY a/b/c.txt
BEGIN_ENTRY_COPY a/b/d.txt
PROGRESS a/b/d.txt 0
PROGRESS a/b/d.txt 10
  :
PROGRESS a/b/d.txt 200
END_ENTRY_COPY a/b/d.txt
SUCCESS x/a/

Added a comment that pre-compute the total bytes will be needed to show progress
bar.

[satorux1, 2013/08/27 06:57:26]

Ah this explains a lot.

+          },
+          "error": {
+            "type": "integer",
+            "optional": true,
+            "description": "Error code of the error. Available only for ERROR event."

[satorux1, 2013/08/27 06:09:41]

What error code? Shouldn't we define enum codes for this?

[hidehiko, 2013/08/27 06:32:18]

Clarified it is FileError's code.
(FileError is being deprecated, but Files.app still uses it).

+          }
+        }
+      },
+      {
         "id": "FileTransferCancelStatus",
         "type": "object",
         "description": "Payload data for file transfer cancel response.",
@@ -837,6 +864,52 @@
         ]
       },
       {
+        "name": "startCopy",
+        "description": "Starts to copy an entry. If the source is directory, the copy is done recursively.",
+        "parameters": [
+          {
+            "name": "sourceUrl",
+            "type": "string",
+            "description": "URL of the source entry to be copied."
+          },
+          {
+            "name": "targetUrl",
+            "type": "string",
+            "description": "URL of the destination location."
+          },
+          {
+            "name": "callback",
+            "type": "function",
+            "description": "Completion callback.",
+            "parameters": [
+              {
+                "name": "copyId",
+                "type": "integer",
+                "description": "ID of the copy task. Can be used to identify the progress, and to cancel the task."
+              }
+            ]
+          }
+        ]
+      },
+      {
+        "name": "cancelCopy",
+        "description": "Cancels the running copy task.",
+        "parameters": [
+          {
+            "name": "copyId",
+            "type": "integer",
+            "description": "ID of the copy task to be cancelled."
+          },
+          {
+            "name": "callback",
+            "type": "function",
+            "optional": true,
+            "description": "Completion callback of the cancel.",
+            "parameters": []
+          }
+        ]
+      },
+      {
         "name": "setLastModified",
         "description": "Updates last modified to specified time in seconds",
         "parameters": [
@@ -1202,6 +1275,23 @@
         ]
       },
       {
+        "name": "onCopyProgress",
+        "type": "function",
+        "description": "Periodically called during a copy task to notify its progress update.",

[satorux1, 2013/08/27 06:09:41]

events are not something "called". Maybe:

"The event is periodically raised during a copy task to report progress update
of the copy task.

[hidehiko, 2013/08/27 06:32:18]

I see. Then how about "fired" as other event's descriptions use it?

[satorux1, 2013/08/27 06:57:26]

fired sgtm

+        "parameters": [
+          {
+            "type": "integer",
+            "name": "copyId",
+            "description": "Id of the copy task of this progress update."
+          },
+          {
+            "$ref": "CopyProgressStatus",
+            "name": "status",
+            "description": "Progress update status."
+          }
+        ]
+      },
+      {
         "name": "onDirectoryChanged",
         "type": "function",
         "description": "Fired when watched file change event is detected in a watched directory.",