Media Galleries: Add chrome.mediaGalleries.addUserSelectedFolder().

chrome/common/extensions/api/media_galleries.idl

 // 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.
 
 // Use the <code>chrome.mediaGalleries</code> API to access media files (images,
 // video, audio) from the user's local disks (with the user's consent).
 namespace mediaGalleries {
 
   [inline_doc] enum GetMediaFileSystemsInteractivity {
     // Do not act interactively.
     no,
     // Ask the user to manage permitted media galleries.
     yes,
     // Ask the user to manage permitted galleries only if the return set would
     // otherwise be empty.
     if_needed
   };
 
   [inline_doc] dictionary MediaFileSystemsDetails {
+    // [Deprecated] use manageMediaLocations and ManageRequestDetails instead.
+    //
     // Whether to prompt the user for permission to additional media galleries
     // before returning the permitted set. Default is silent.  If the value
     // 'yes' is passed, or if the application has not been granted access to
     // any media galleries and the value 'if_needed' is passed, then the
     // media gallery configuration dialog will be displayed.
     GetMediaFileSystemsInteractivity? interactive;
   };
 
   callback MediaFileSystemsCallback =
-      void ([instanceOf=DOMFileSystem] optional object[] mediaFileSystems);
+      void ([instanceOf=DOMFileSystem] object[] mediaFileSystems);
+
+  [inline_doc] enum ManageRequestType {
+    // Ask the user to manage permitted media galleries.
+    manage,
+
+    // Present a directory picker to the user and add access to the directory
+    // the user selects.
+    directory_prompt
+  };
+
+  [inline_doc] dictionary ManageRequestDetails {
+    // Specify the management action to take.
+    ManageRequestType type;
+  };
+
+  [inline_doc] dictionary ManageRequestResults {

[vandebo (ex-Chrome), 2013/12/02 18:01:30]

This is inconsistent with MediaFileSystemsCallback.  What do we gain?

[Lei Zhang, 2013/12/03 03:33:23]

Flexibility. You can add new key/value pairs in the results dictionary to
indicate whatever other status you haven't thought of yet.

In your scanning proposal CL, you had the callback as (bool, DOMFileSystem[]),
with the bool indicating success. However, we don't know what the scanning
interface will look like in the end, so I'm leaving this open.

+    // The returned file systems. Null on failure.
+    [instanceOf=DOMFileSystem] object[] media_file_systems;
+  };
+
+  callback ManageMediaLocationsCallback = void (ManageRequestResults results);

[vandebo (ex-Chrome), 2013/12/02 18:01:30]

It doesn't seem like there is a way to know if a 'directory_prompt' request was
successful?

[Lei Zhang, 2013/12/03 03:33:23]

|media_file_systems| has multiple states. As mentioned on line 48, it's NULL on
failure. On success, it's an array of size N, where N can be 0. I'll add more
comments.

[vandebo (ex-Chrome), 2013/12/03 21:08:02]

I don't like this interface because it introduces special values and input
dependant results.  I think it would be an easier interface to deal with if it
always returns all the file systems, and also returns a value indicating
directory-add success/failure.

[Lei Zhang, 2013/12/05 05:52:15]

Done. I did what I said I would do from yesterday's in-person discussion.

 
   [inline_doc] dictionary MediaFileSystemMetadata {
     // The name of the file system.
     DOMString name;
 
     // A unique and persistent id for the media gallery.
     DOMString galleryId;
 
     // If the media gallery is on a removable device, a unique id for the
     // device while the device is online.
@@ skipping 12 matching lines @@
 
   callback MediaGalleriesMetadataCallback =
       void (MediaFileSystemMetadata[] metadata);
 
   interface Functions {
     // Get the media galleries configured in this user agent. If none are
     // configured or available, the callback will receive an empty array.
     static void getMediaFileSystems(optional MediaFileSystemsDetails details,
                                     MediaFileSystemsCallback callback);
 
+    // Manage existing media location or request access to new media locations.
+    // In all cases the user will be prompted. The callback will be called
+    // when the user is done and will include all media galleries.
+    static void manageMediaLocations(ManageRequestDetails details,
+                                     ManageMediaLocationsCallback callback);
+
     // Get metadata about a specific media file system.
     [nocompile] static MediaFileSystemMetadata getMediaFileSystemMetadata(
         [instanceOf=DOMFileSystem] object mediaFileSystem);
 
     // Get metadata for all available media galleries.
     static void getAllMediaFileSystemMetadata(
         MediaGalleriesMetadataCallback callback);
   };
 
 };