Media Galleries Partial Deprecation: Remove scan functionality.

chrome/common/extensions/api/media_galleries.idl

Index: chrome/common/extensions/api/media_galleries.idl
diff --git a/chrome/common/extensions/api/media_galleries.idl b/chrome/common/extensions/api/media_galleries.idl
index 959267367a2649b174c7b708dce771fbfff96a79..8c257c4e96f4b95116278ccf04eaf97dfd2a6cc6 100644
--- a/chrome/common/extensions/api/media_galleries.idl
+++ b/chrome/common/extensions/api/media_galleries.idl
@@ -33,7 +33,7 @@ namespace mediaGalleries {
     mimeTypeOnly
   };
 
-  [inline_doc] enum ScanProgressType {
+  [nodefine, inline_doc] enum ScanProgressType {

[Devlin, 2016/02/29 20:37:24]

Have you checked locally that this does the right thing both on the docserver
and in compilation?

[tommycli, 2016/02/29 21:53:30]

Yes, I have checked manually via server2/preview.py. chrome-apps-doc.appspot.com
is unfortunately broken (500 error).

One more question: Didn't we used to be able to access the beta/dev/trunk
channel docs via https://developer.chrome.com/beta/apps/mediaGalleries ? That
doesn't seem to work anymore. I'm trying to verify the Deprecated Since Chrome
XX is correct, since the version number is not determined when you run server2
locally.

I have also checked that these structs are omitted from the generated
media_galleries.h file.

[Devlin, 2016/02/29 22:10:44]

I don't think we ever had beta/dev/trunk docs.  We have APIs that are only
available in certain channels, but only one version of the documentation.  The
server constructs the "deprecated since chrome XX" by looking at the commit
history, IIRC.

[tommycli, 2016/02/29 22:49:03]

Yes, reading the code that looks correct.

     // The scan started.
     start,
     // The scan was cancelled.
@@ -44,11 +44,11 @@ namespace mediaGalleries {
     // The scan encountered an error and could not proceed.
     error
   };
-  
+
   [inline_doc] dictionary GalleryChangeDetails {
     // Type of change event.
     GalleryChangeType type;
-    
+
     // Identifies the modified gallery.
     DOMString galleryId;
   };
@@ -99,7 +99,7 @@ namespace mediaGalleries {
     boolean isAvailable;
   };
 
-  [inline_doc] dictionary ScanProgressDetails {
+  [nodefine, inline_doc] dictionary ScanProgressDetails {
     // The type of progress event, i.e. start, finish, etc.
     ScanProgressType type;
 
@@ -119,7 +119,7 @@ namespace mediaGalleries {
   dictionary StreamInfo {
     // Describes format of container or codec of stream, i.e. "mp3", "h264".
     DOMString type;
-    
+
     // An unfiltered string->string dictionary of tags for the stream.
     object tags;
   };
@@ -138,7 +138,7 @@ namespace mediaGalleries {
 
     // Defined for audio and video. In seconds.
     double? duration;
-    
+
     // Defined for images and video. In degrees.
     long? rotation;
 
@@ -204,16 +204,19 @@ namespace mediaGalleries {
     // The scan may take a long time so progress and completion is communicated
     // by events. No permission is granted as a result of the scan, see
     // addScanResults.
+    [nodefine, deprecated="The mediaGalleries API no longer supports scanning."]
     static void startMediaScan();
 
     // Cancel any pending media scan.  Well behaved apps should provide a way
     // for the user to cancel scans they start.
+    [nodefine, deprecated="The mediaGalleries API no longer supports scanning."]
     static void cancelMediaScan();
 
     // Show the user the scan results and let them add any or all of them as
     // galleries. This should be used after the 'finish' onScanProgress()
     // event has happened. All galleries the app has access to are returned, not
     // just the newly added galleries.
+    [nodefine, deprecated="The mediaGalleries API no longer supports scanning."]
     static void addScanResults(MediaFileSystemsCallback callback);
 
     // Get metadata about a specific media file system.
@@ -251,6 +254,7 @@ namespace mediaGalleries {
 
     // The pending media scan has changed state. See details for more
     // information.
+    [nodefine, deprecated="The mediaGalleries API no longer supports scanning."]
     static void onScanProgress(ScanProgressDetails details);
   };
 };