Fetch files shared in Team Drives by specifying allTeamDrives corpora.

google_apis/drive/drive_api_url_generator.h

 // Copyright (c) 2013 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.
 
 #ifndef GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_
 #define GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_
 
 #include <stdint.h>
 
 #include <string>
 
 #include "base/macros.h"
 #include "google_apis/drive/drive_switches.h"
 #include "url/gurl.h"
 
 namespace google_apis {
 
+// A class to specify team_drive_id and corpora parameters for Files:list.
+class FilesListScope {

[hashimoto, 2017/05/26 09:09:19]

Sorry, I couldn't understand why this needs to be a class.
Can't this be just a std::string for Team Drive ID, and an enum for the corpora?

[yamaguchi, 2017/05/29 08:38:21]

I think it can.
- corpora : enum
- team_drive_id : std::string. Ignored if corpus is not teamDrive.
The only reason to have this class is to make sure callers won't need to pass an
unused dummy string as teamDrive in case of allTeamDrives or default corpora. If
you think this is not much benefit, I will replace this with such 2 parameters
(with the notice above in @param document).

[hashimoto, 2017/05/30 08:34:57]

IMO the Drive API is already too complicated (it's not easy to describe the
relationships between corpora, corpus, includeTeamDriveItems,
supportsTeamDrives, and teamDriveId).
Introducing a new "scope" concept (btw "scope" is a term already used by OAuth)
just makes the situation worse.

I think it's better to keep our code as dumb as possible.

[yamaguchi, 2017/05/31 08:21:30]

Thanks. Changed to use 2 args instead of a new class.

+ public:
+  static FilesListScope kAllTeamDrives;
+  static FilesListScope kDefault;
+  static FilesListScope CreateForTeamDrive(const std::string& team_drive_id);
+
+  const std::string& GetCorpusParam() const;
+  const std::string& GetTeamDriveId() const { return team_drive_id_; }
+
+ private:
+  static std::string kDefaultAndAllTeamDrivesCorpus_;
+  static std::string kTeamDriveCorpus_;
+  static std::string kDefaultCorpus_;
+
+  FilesListScope(bool all_team_drives, std::string team_drive_id)
+      : all_team_drives_(all_team_drives), team_drive_id_(team_drive_id) {}
+  bool all_team_drives_;
+  std::string team_drive_id_;
+};
+
 // This class is used to generate URLs for communicating with drive api
 // servers for production, and a local server for testing.
 class DriveApiUrlGenerator {
  public:
   // |base_url| is the path to the target drive api server.
   // Note that this is an injecting point for a testing server.
   DriveApiUrlGenerator(const GURL& base_url,
                        const GURL& base_thumbnail_url,
                        TeamDrivesIntegrationStatus team_drives_integration);
   DriveApiUrlGenerator(const DriveApiUrlGenerator& src);
@@ skipping 33 matching lines @@
                         bool set_modified_date,
                         bool update_viewed_date) const;
 
   // Returns a URL to copy a resource specified by |file_id|.
   GURL GetFilesCopyUrl(const std::string& file_id,
                        const std::string& visibility) const;
 
   // Returns a URL to fetch file list.
   GURL GetFilesListUrl(int max_results,
                        const std::string& page_token,
+                       const FilesListScope& scope,
                        const std::string& q) const;
 
   // Returns a URL to delete a resource with the given |file_id|.
   GURL GetFilesDeleteUrl(const std::string& file_id) const;
 
   // Returns a URL to trash a resource with the given |file_id|.
   GURL GetFilesTrashUrl(const std::string& file_id) const;
 
   // Returns a URL to invoke "TeamDrives: list" method.
   GURL GetTeamDriveListUrl(int max_results,
@@ skipping 54 matching lines @@
   const GURL base_download_url_;
   const GURL base_thumbnail_url_;
   const bool enable_team_drives_;
 
   // This class is copyable hence no DISALLOW_COPY_AND_ASSIGN here.
 };
 
 }  // namespace google_apis
 
 #endif  // GOOGLE_APIS_DRIVE_DRIVE_API_URL_GENERATOR_H_