Media Galleries Partial Deprecation: Remove scan functionality.

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 (audio,
 // images, video) from the user's local disks (with the user's consent).
 namespace mediaGalleries {
 
   [inline_doc] enum GalleryChangeType {
     // The contents of the gallery have changed.
@@ skipping 15 matching lines @@
 
   [inline_doc] enum GetMetadataType {
     // Retrieve the mime type, metadata tags, and attached images.
     all,
     // Retrieve only the mime type and the metadata tags.
     mimeTypeAndTags,
     // Retrieve only the mime type.
     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.
     cancel,
     // The scan finished but none of the result have been added,
     // addScanResults() has to be called to ask the user for permission.
     finish,
     // 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;
   };
 
   [inline_doc] dictionary MediaFileSystemsDetails {
     // 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.
@@ skipping 30 matching lines @@
     boolean isRemovable;
 
     // True if the device the media gallery is on was detected as a media
     // device.  i.e. a PTP or MTP device, or a DCIM directory is present.
     boolean isMediaDevice;
 
     // True if the device is currently available.
     boolean isAvailable;
   };
 
-  [inline_doc] dictionary ScanProgressDetails {
+  [nodefine, inline_doc] dictionary ScanProgressDetails {
     // The type of progress event, i.e. start, finish, etc.
     ScanProgressType type;
 
     // The number of Galleries found.
     long? galleryCount;
 
     // Appoximate number of media files found; some file types can be either
     // audio or video and are included in both counts.
     long? audioCount;
     long? imageCount;
     long? videoCount;
   };
 
   callback MediaFileSystemsMetadataCallback =
       void (MediaFileSystemMetadata[] metadata);
 
   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;
   };
 
   dictionary MediaMetadata {
     // The browser sniffed mime type.
     DOMString mimeType;
 
     // Defined for images and video. In pixels.
     long? height;
     long? width;
 
     // Defined for images only.
     double? xResolution;
     double? yResolution;
 
     // Defined for audio and video. In seconds.
     double? duration;
-    
+
     // Defined for images and video. In degrees.
     long? rotation;
 
     // Defined for images only.
     DOMString? cameraMake;
     DOMString? cameraModel;
     double? exposureTimeSeconds;
     boolean? flashFired;
     double? fNumber;
     double? focalLengthMm;
@@ skipping 45 matching lines @@
 
     // Give up access to a given media gallery.
     static void dropPermissionForMediaFileSystem(
         DOMString galleryId,
         optional DropPermissionForMediaFileSystemCallback callback);
 
     // Start a scan of the user's hard disks for directories containing media.
     // 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.
     [nocompile] static MediaFileSystemMetadata getMediaFileSystemMetadata(
         [instanceOf=DOMFileSystem] object mediaFileSystem);
 
     // Get metadata for all available media galleries.
     static void getAllMediaFileSystemMetadata(
         MediaFileSystemsMetadataCallback callback);
 
@@ skipping 17 matching lines @@
     // Removes all gallery watches.
     static void removeAllGalleryWatch();
   };
 
   interface Events {
     // Fired when a media gallery is changed or a gallery watch is dropped.
     static void onGalleryChanged(GalleryChangeDetails details);
 
     // 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);
   };
 };