File indexing completed on 2024-05-12 05:22:16

 /*
     SPDX-FileCopyrightText: 2012 Andrius da Costa Ribas <andriusmao@gmail.com>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #pragma once
 
 #include "kgapidrive_export.h"
 #include "object.h"
 #include "types.h"
 
 #include <QSharedPointer>
 #include <QString>
 #include <QStringList>
 #include <QUrl>
 
 namespace KGAPI2
 {
 
 namespace Drive
 {
 
 /**
  * @brief DriveAbout contains information about the current user along with
  *        Google Drive API settings.
  *
  * Getters and setters' documentation is based on Google Drive's API v2 reference
  * @see <a href="https://developers.google.com/drive/v2/reference/about">About</a>
  *
  * @since 2.0
  * @author Andrius da Costa Ribas <andriusmao@gmail.com>
  * @author Daniel Vrátil <dvratil@redhat.com>
  */
 class KGAPIDRIVE_EXPORT About : public KGAPI2::Object
 {
 public:
     /**
      * @brief DriveAbout::Format holds the structure used for importFormats[]
      *        and exportFormats[] properties.
      */
     class Format
     {
     public:
         explicit Format(const Format &other);
         virtual ~Format();
         bool operator==(const Format &other) const;
         bool operator!=(const Format &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the content type to convert from.
          */
         QString source() const;
 
         /**
          * @brief Returns the possible content types to convert to.
          */
         QStringList targets() const;
 
     private:
         explicit Format();
 
         class Private;
         Private *const d;
         friend class Private;
         friend class About;
     };
 
     using FormatPtr = QSharedPointer<Format>;
     using FormatsList = QList<FormatPtr>;
 
     /**
      * @brief DriveAbout::AdditionalRoleInfo holds the structure used for
      *        additionalRoleInfo[] property.
      */
     class AdditionalRoleInfo
     {
     public:
         /**
          * @brief DriveAbout::AdditionalRoleInfo::Role holds the structure used for
          *        additionalRoleInfo[].roleSets[] property.
          */
         class RoleSet
         {
         public:
             explicit RoleSet(const RoleSet &other);
             virtual ~RoleSet();
             bool operator==(const RoleSet &other) const;
             bool operator!=(const RoleSet &other) const
             {
                 return !operator==(other);
             }
 
             /**
              * @brief Returns the primary permission role.
              */
             QString primaryRole() const;
 
             /**
              * @brief Returns the supported additional roles with the primary role.
              */
             QStringList additionalRoles() const;
 
         private:
             explicit RoleSet();
 
             class Private;
             Private *const d;
             friend class Private;
             friend class About;
         };
 
         using RoleSetPtr = QSharedPointer<RoleSet>;
         using RoleSetsList = QList<RoleSetPtr>;
 
         explicit AdditionalRoleInfo(const AdditionalRoleInfo &other);
         virtual ~AdditionalRoleInfo();
         bool operator==(const AdditionalRoleInfo &other) const;
         bool operator!=(const AdditionalRoleInfo &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the content type that this additional role info applies to.
          */
         [[nodiscard]] QString type() const;
 
         /**
          * @brief Returns the supported additional roles per primary role.
          */
         [[nodiscard]] RoleSetsList roleSets() const;
 
     private:
         explicit AdditionalRoleInfo();
 
         class Private;
         Private *const d;
         friend class Private;
         friend class About;
     };
 
     using AdditionalRoleInfoPtr = QSharedPointer<AdditionalRoleInfo>;
     using AdditionalRoleInfosList = QList<AdditionalRoleInfoPtr>;
 
     /**
      * @brief DriveAbout::Feature holds the structure used for features[] property.
      */
     class Feature
     {
     public:
         explicit Feature(const Feature &other);
         virtual ~Feature();
         bool operator==(const Feature &other) const;
         bool operator!=(const Feature &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the name of the feature.
          */
         QString featureName() const;
 
         /**
          * @brief Returns the request limit rate for this feature, in queries per second.
          */
         qreal featureRate() const;
 
     private:
         explicit Feature();
 
         class Private;
         Private *const d;
         friend class Private;
         friend class About;
     };
 
     using FeaturePtr = QSharedPointer<Feature>;
     using FeaturesList = QList<FeaturePtr>;
 
     /**
      * @brief DriveAbout::MaxUploadSize holds the structure used for maxUploadSizes[] property.
      */
     class MaxUploadSize
     {
     public:
         explicit MaxUploadSize(const MaxUploadSize &other);
         virtual ~MaxUploadSize();
         bool operator==(const MaxUploadSize &other) const;
         bool operator!=(const MaxUploadSize &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the file type.
          */
         QString type() const;
 
         /**
          * @brief Returns the max upload size for this type.
          */
         qlonglong size() const;
 
     private:
         explicit MaxUploadSize();
 
         class Private;
         Private *const d;
         friend class Private;
         friend class About;
     };
 
     using MaxUploadSizePtr = QSharedPointer<MaxUploadSize>;
     using MaxUploadSizesList = QList<MaxUploadSizePtr>;
 
     struct KGAPIDRIVE_EXPORT Fields {
         static const QString AdditionalRoleInfo;
         static const QString AdditionalRoles;
         static const QString BackgroundImageLink;
         static const QString BytesUsed;
         static const QString CanCreateDrives;
         static const QString ColorRgb;
         static const QString DisplayName;
         static const QString DomainSharingPolicy;
         static const QString EmailAddress;
         static const QString Etag;
         static const QString ExportFormats;
         static const QString FeatureName;
         static const QString FeatureRate;
         static const QString Features;
         static const QString FolderColorPalette;
         static const QString Id;
         static const QString ImportFormats;
         static const QString IsAuthenticatedUser;
         static const QString IsCurrentAppInstalled;
         static const QString Kind;
         static const QString LanguageCode;
         static const QString LargestChangeId;
         static const QString MaxUploadSizes;
         static const QString Name;
         static const QString PermissionId;
         static const QString Picture;
         static const QString PrimaryRole;
         static const QString QuotaBytesByService;
         static const QString QuotaBytesTotal;
         static const QString QuotaBytesUsed;
         static const QString QuotaBytesUsedAggregate;
         static const QString QuotaBytesUsedInTrash;
         static const QString QuotaType;
         static const QString RemainingChangeIds;
         static const QString RoleSets;
         static const QString RootFolderId;
         static const QString SelfLink;
         static const QString ServiceName;
         static const QString Size;
         static const QString Source;
         static const QString Targets;
         static const QString TeamDriveThemes;
         static const QString Type;
         static const QString Url;
         static const QString User;
     };
 
     About(const About &other);
     ~About() override;
 
     bool operator==(const About &other) const;
     bool operator!=(const About &other) const
     {
         return !operator==(other);
     }
 
     /**
      * @brief Returns the link back to this item.
      */
     QUrl selfLink() const;
 
     /**
      * @brief Returns the name of the current user.
      */
     QString name() const;
 
     /**
      * @brief Returns the total number of quota bytes.
      */
     qlonglong quotaBytesTotal() const;
 
     /**
      * @brief Returns the total number of quota bytes used.
      */
     qlonglong quotaBytesUsed() const;
 
     /**
      * @brief Returns the total number of quota bytes used by trashed items.
      */
     qlonglong quotaBytesUsedInTrash() const;
 
     /**
      * @brief returns the total number of quota bytes used by all Google apps
      *        (Drive, Picasa, etc.).
      * @since 5.3.2
      */
     qlonglong quotaBytesUsedAggregate() const;
 
     /**
      * @brief returns the total number of quota bytes used by all Google apps
      *        (Drive, Picasa, etc.).
      * @deprecated since 5.3.2, use quotaBytesUsedAggregate() instead.
      */
 #ifndef KGAPIDRIVE_NO_DEPRECATED
     KGAPIDRIVE_DEPRECATED qlonglong quotaBytesUserAggregate() const;
 #endif
 
     /**
      * @brief Returns the largest change id.
      */
     qlonglong largestChangeId() const;
 
     /**
      * @brief Returns the number of remaining change ids.
      */
     qlonglong remainingChangeIds() const;
 
     /**
      * @brief Returns the id of the root folder.
      */
     QString rootFolderId() const;
 
     /**
      * @brief Returns the domain sharing policy for the current user.
      */
     QString domainSharingPolicy() const;
 
     /**
      * @brief Returns the allowable import formats.
      */
     FormatsList importFormats() const;
 
     /**
      * @brief Returns the allowable export formats.
      */
     FormatsList exportFormats() const;
 
     /**
      * @brief Returns information about supported additional roles per file type.
      *
      * The most specific type takes precedence.
      */
     AdditionalRoleInfosList additionalRoleInfo() const;
 
     /**
      * @brief Returns the list of additional features enabled on this account.
      */
     FeaturesList features() const;
 
     /**
      * @brief Returns the list of max upload sizes for each file type.
      *
      * The most specific type takes precedence.
      */
     MaxUploadSizesList maxUploadSizes() const;
 
     /**
      * @brief Returns the current user's ID as visible in the permissions collection.
      */
     QString permissionId() const;
 
     /**
      * @brief Returns whether the authenticated app is installed by the authenticated user.
      */
     bool isCurrentAppInstalled() const;
 
     /**
      * @brief Returns the authenticated user.
      */
     UserPtr user() const;
 
     /**
      * @brief Returns whether the user can create shared drives.
      */
     bool canCreateDrives() const;
 
     /**
      * @brief Constructs a new DriveAbout object from given JSON data
      *
      * @param jsonData
      */
     static AboutPtr fromJSON(const QByteArray &jsonData);
 
 private:
     About();
 
     class Private;
     QScopedPointer<Private> const d;
     friend class Private;
 };
 
 } /* namespace Drive */
 
 } /* namespace KGAPI2 */