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"],
+            "description": "The type of the progress event. BEGIN_ENTRY_COPY is fired for each entry before starting the copy operation, END_ENTRY_COPY is fired for each entry after ending the copy operation. PROGRESS is fired periodically during copy. SUCCESS is fired after all entries are copied. ERROR is fired when an error occurs."

[satorux1, 2013/08/29 08:32:32]

Some clarification:

BEGIN_ENTRY_COPY is fired for each entry (file or directory)

PROGRESS is fired periodically to report progress of a file copy (not directory)

[hidehiko, 2013/08/29 09:00:58]

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/directory in that directory is now being copied."
+          },
+          "size": {
+            "type": "number",
+            "optional": true,
+            "description": "Number of processed bytes for the file currently being copied. 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/29 08:32:32]

for the file (not directory)

it's redundant but a bit of redundancy would help 

[hidehiko, 2013/08/29 09:00:58]

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

[satorux1, 2013/08/29 08:32:32]

Starts to copy an entry to another directory

[hidehiko, 2013/08/29 09:00:58]

The destination directory can be same. E.g. copy to a/b.txt to a/c.txt.

+        "parameters": [
+          {
+            "name": "sourceUrl",
+            "type": "string",
+            "description": "URL of the source entry to be copied."
+          },
+          {
+            "name": "targetUrl",
+            "type": "string",
+            "description": "URL of the destination location."

[satorux1, 2013/08/29 08:32:32]

URL of the destination directory.

(to make it clear the destination should be a directory)

[hidehiko, 2013/08/29 09:00:58]

Per offline discussion, I split the url into two;
parent: the url of the destination directory.
newName: the name of the new entry.
The purpose is:
1) to avoid creating a URL which doesn't yet exist.
2) to follow the FileSystem API copyTo's manner.

+          },
+          {
+            "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."

[satorux1, 2013/08/29 08:32:32]

I thought it's canceled but cancelled seems to be slightly more popular inside
chrome tree:

% git grep -w cancelled |wc -l
782
% git grep -w canceled |wc -l 
634

[hidehiko, 2013/08/29 09:00:58]

IIRC, cancelled for UK and canceled for US. I actually grep'ed to choose more
popular one.

+          },
+          {
+            "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 344 matching lines @@
         "description": "Fired when file transfers with remote file system are in progress.",
         "parameters": [
           {
             "type": "array",
             "items": {"$ref": "FileTransferStatus"},
             "name": "event",
             "description": "List of ongoing file statuses for ongoing transfer operations."
           }
         ]
       },
+      // Here is an example of onCopyProgress:
+      // Suppose a/b/c.txt (100bytes) and a/b/d.txt (200bytes), and trying to
+      // copy a/ to x/ recursively. The events will be:

[satorux1, 2013/08/29 08:32:32]

remoe the trailing /? to be precise, the trailing / shouldn't be part of the
canonical path.

a/ -> a 
x/ -> x

[hidehiko, 2013/08/29 09:00:58]

Done.

+      // BEGIN_ENTRY_COPY a/
+      // <create empty directory x/a/>
+      // END_ENTRY_COPY a/

[satorux1, 2013/08/29 08:32:32]

add a blank line between each entry?

[hidehiko, 2013/08/29 09:00:58]

Done.

+      // BEGIN_ENTRY_COPY a/b/
+      // <create empty directory 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/
+      {
+        "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": []
       }
     ]
   }
 ]