Adds new private API manifest for Files.app copy.

chrome/common/extensions/api/file_browser_private.json

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 [
   {
     "namespace":"fileBrowserPrivate",
     "description": "none",
     "types": [
       {
@@ skipping 325 matching lines @@
             "description": "Approximated completed portion of the transfer operation."
           },
           "total": {
             "type": "number",
             "optional": true,
             "description": "Approximated total size of transfer operation."
           }
         }
       },
       {
+        "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"],

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

Why BEGIN_ENTRY_COPY instead of BEGIN_FILE_COPY? I'm guessing that "ENTRY" means
either of a file or a directory. How to report a directory copy? How will the
"size" field look like?

If we are to copy a directory with thousands of sub directories + one very big
file, how to show a progress bar nicely?

[hidehiko, 2013/08/27 07:52:07]

Yes, {BEGIN_END}_ENTRY_COPY are fired not only for files but also for
directories.
Files.app can assign some size to the directory virtually, so that it can show a
smoother progress bar, as directory creation is notified to it by
END_ENTRY_COPY.
However, assigning the virtual size sounds a kind of hack to show the UI nicer,
so IMHO we should avoid to introduce such stuff in backend/private API layer.

+            "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."

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

nits:

s/called/fired/ as this is an event.

"BEGIN_ENTRY_COPY is called before for each entry copy" -> BEFORE_ENTRY_COPY is
fired for each entry before starting the copy operation"


"an error is found." -> "an error occurred"

"SUCCESS is called after all copy is completed" -> "SUCCESS is fired after all
entries are copied" 

[hidehiko, 2013/08/27 07:52:07]

Done.

+          },
+          "url": {
+            "type": "string",
+            "optional": true,
+            "description": "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."
+          },
+          "size": {
+            "type": "number",
+            "optional": true,
+            "description": "Number of processed bytes for each entry copy. Available only for PROGRESS event. To show the progress bar, a caller needs to pre-compute the size of files being copied."

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

Maybe:
Number of processed bytes for each entry copy.
->
Number of processed bytes for the entry currently being copied.

[hidehiko, 2013/08/27 07:52:07]

Done.

+          },
+          "error": {
+            "type": "integer",
+            "optional": true,
+            "description": "FileError's code of the error. Available only for ERROR event."
+          }
+        }
+      },
+      {
         "id": "FileTransferCancelStatus",
         "type": "object",
         "description": "Payload data for file transfer cancel response.",
         "properties": {
           "fileUrl": {
             "type": "string",
             "description": "URL of file that is being transfered."
           },
           "canceled": {
             "type": "boolean",
@@ skipping 474 matching lines @@
                 "name" : "fileTransferCancelStatuses",
                 "type": "array",
                 "items": {"$ref": "FileTransferCancelStatus"},
                 "description": "The list of FileTransferCancelStatus."
               }
             ]
           }
         ]
       },
       {
+        "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": [
           {
             "name": "fileUrl",
             "type": "string",
             "description": "File url from the local file system."
           },
           {
             "name": "lastModified",
@@ skipping 345 matching lines @@
         "parameters": [
           {
             "type": "array",
             "items": {"$ref": "FileTransferStatus"},
             "name": "event",
             "description": "List of ongoing file statuses for ongoing transfer operations."
           }
         ]
       },
       {
+        "name": "onCopyProgress",
+        "type": "function",
+        "description": "Periodically fired during a copy task to report its progress update.",
+        "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.",
         "parameters": [
           {
             "$ref": "FileWatchEvent",
             "name": "event",
             "description": "File watch event information."
           }
         ]
       },
       {
         "name": "onPreferencesChanged",
         "type": "function",
         "description": "Fired when file manager preferences change. The preferences can be retrieved via 'getPreferences'.",
         "parameters": []
       },
       {
         "name": "onDriveConnectionStatusChanged",
         "type": "function",
         "description": "Fired when the active network connection state changes. The network connection state can be retrieved via 'getDriveConnectionState'.",
         "parameters": []
       }
     ]
   }
 ]