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

 /*
     SPDX-FileCopyrightText: 2019 David Barchiesi <david@barchie.si>
 
     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 <QString>
 
 #include <QDateTime>
 
 namespace KGAPI2
 {
 
 namespace Drive
 {
 
 /**
  * @brief Teamdrive contains a representation of a Team Drive.
  *
  * Getters and setters' documentation is based on Google Drive's API v2 reference
  * @see <a href="https://developers.google.com/drive/v2/reference/teamdrives">Teamdrives</a>
  *
  * @since x.0
  * @author David Barchiesi <david@barchie.si>
  */
 class KGAPIDRIVE_EXPORT Teamdrive : public KGAPI2::Object
 {
 public:
     /**
      * @brief DriveTeamdrive::Restrictions holds the structure used for
      * restrictions property.
      */
     class Restrictions
     {
     public:
         struct Fields {
             static const QString AdminManagedRestrictions;
             static const QString CopyRequiresWriterPermission;
             static const QString DomainUsersOnly;
             static const QString TeamMembersOnly;
         };
 
         Restrictions();
         Restrictions(const Restrictions &other);
         ~Restrictions();
         bool operator==(const Restrictions &other) const;
         bool operator!=(const Restrictions &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns whether administrative privileges on this Team Drive
          * are required to modify restrictions.
          */
         bool adminManagedRestrictions() const;
 
         /**
          * @brief Sets whether administrative privileges on this Team Drive
          * are required to modify restrictions.
          *
          * @param adminManagedRestrictions
          */
         void setAdminManagedRestrictions(bool adminManagedRestrictions) const;
 
         /**
          * @brief Returns whether the options to copy, print, or download files
          * inside this Team Drive, should be disabled for readers and commenters.
          * When this restriction is set to true, it will override the similarly
          * named field to true for any file inside this Team Drive.
          */
         [[nodiscard]] bool copyRequiresWriterPermission() const;
 
         /**
          * @brief Sets whether the options to copy, print, or download files
          * inside this Team Drive, should be disabled for readers and commenters.
          * When this restriction is set to true, it will override the similarly
          * named field to true for any file inside this Team Drive.
          *
          * @param copyRequiresWriterPermission
          */
         void setCopyRequiresWriterPermission(bool copyRequiresWriterPermission) const;
 
         /**
          * @brief Returns whether access to this Team Drive and items inside this
          * Team Drive is restricted to users of the domain to which this Team
          * Drive belongs. This restriction may be overridden by other sharing
          * policies controlled outside of this Team Drive.
          */
         [[nodiscard]] bool domainUsersOnly() const;
 
         /**
          * @brief Sets whether access to this Team Drive and items inside this
          * Team Drive is restricted to users of the domain to which this Team
          * Drive belongs. This restriction may be overridden by other sharing
          * policies controlled outside of this Team Drive.
          *
          * @param domainUsersOnly
          */
         void setDomainUsersOnly(bool domainUsersOnly) const;
 
         /**
          * @brief Returns whether access to items inside this Team Drive is
          * restricted to members of this Team Drive.
          */
         [[nodiscard]] bool teamMembersOnly() const;
 
         /**
          * @brief Sets whether access to items inside this Team Drive is
          * restricted to members of this Team Drive.
          *
          * @param teamMembersOnly
          */
         void setTeamMembersOnly(bool teamMembersOnly) const;
 
     private:
         class Private;
         QScopedPointer<Private> const d;
         friend class Private;
         friend class Teamdrive;
     };
 
     using RestrictionsPtr = QSharedPointer<Restrictions>;
 
     /**
      * @brief DriveTeamdrive::Capabilities holds the structure used for capabilities property.
      */
     class Capabilities
     {
     public:
         struct Fields {
             static const QString CanAddChildren;
             static const QString CanChangeCopyRequiresWriterPermissionRestriction;
             static const QString CanChangeDomainUsersOnlyRestriction;
             static const QString CanChangeTeamDriveBackground;
             static const QString CanChangeTeamMembersOnlyRestriction;
             static const QString CanComment;
             static const QString CanCopy;
             static const QString CanDeleteChildren;
             static const QString CanDeleteTeamDrive;
             static const QString CanDownload;
             static const QString CanEdit;
             static const QString CanListChildren;
             static const QString CanManageMembers;
             static const QString CanReadRevisions;
             static const QString CanRename;
             static const QString CanRenameTeamDrive;
             static const QString CanShare;
             static const QString CanTrashChildren;
         };
 
         Capabilities();
         Capabilities(const Capabilities &other);
         ~Capabilities();
         bool operator==(const Capabilities &other) const;
         bool operator!=(const Capabilities &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns whether the current user can add children to folders
          * in this Team Drive.
          */
         [[nodiscard]] bool canAddChildren() const;
 
         /**
          * @brief Returns whether the current user can change the
          * copyRequiresWriterPermission restriction of this Team Drive.
          */
         [[nodiscard]] bool canChangeCopyRequiresWriterPermissionRestriction() const;
 
         /**
          * @brief Returns whether the current user can change the domainUsersOnly
          * restriction of this Team Drive.
          */
         [[nodiscard]] bool canChangeDomainUsersOnlyRestriction() const;
 
         /**
          * @brief Returns whether the current user can change the background of
          * this Team Drive.
          */
         [[nodiscard]] bool canChangeTeamDriveBackground() const;
 
         /**
          * @brief Returns whether the current user can change the teamMembersOnly
          * restriction of this Team Drive.
          */
         [[nodiscard]] bool canChangeTeamMembersOnlyRestriction() const;
 
         /**
          * @brief Returns Whether the current user can comment on files in
          * this Team Drive.
          */
         [[nodiscard]] bool canComment() const;
 
         /**
          * @brief Returns Whether the current user can copy files in this Team Drive.
          */
         [[nodiscard]] bool canCopy() const;
 
         /**
          * @brief Returns Whether the current user can delete children from
          * folders in this Team Drive.
          */
         [[nodiscard]] bool canDeleteChildren() const;
 
         /**
          * @brief Returns Whether the current user can delete this Team Drive.
          *
          * Attempting to delete the Team Drive may still fail if there are
          * untrashed items inside the Team Drive.
          */
         [[nodiscard]] bool canDeleteTeamDrive() const;
 
         /**
          * @brief Returns Whether the current user can download files in this
          * Team Drive.
          */
         [[nodiscard]] bool canDownload() const;
 
         /**
          * @brief Returns Whether the current user can edit files in this
          * Team Drive
          */
         [[nodiscard]] bool canEdit() const;
 
         /**
          * @brief Returns Whether the current user can list the children of
          * folders in this Team Drive.
          */
         [[nodiscard]] bool canListChildren() const;
 
         /**
          * @brief Returns Whether the current user can add members to this Team Drive
          * or remove them or change their role.
          */
         [[nodiscard]] bool canManageMembers() const;
 
         /**
          * @brief Returns Whether the current user can read the revisions
          * resource of files in this Team Drive.
          */
         [[nodiscard]] bool canReadRevisions() const;
 
         /**
          * @brief Returns Whether the current user can rename files or folders
          * in this Team Drive.
          */
         [[nodiscard]] bool canRename() const;
 
         /**
          * @brief Returns Whether the current user can rename this Team Drive.
          */
         [[nodiscard]] bool canRenameTeamDrive() const;
 
         /**
          * @brief Returns Whether the current user can share files or folders
          * in this Team Drive.
          */
         [[nodiscard]] bool canShare() const;
 
         /**
          * @brief Returns Whether the current user can trash children from
          * folders in this Team Drive.
          */
         [[nodiscard]] bool canTrashChildren() const;
 
     private:
         class Private;
         QScopedPointer<Private> const d;
         friend class Private;
         friend class Teamdrive;
     };
 
     using CapabilitiesPtr = QSharedPointer<Capabilities>;
 
     /**
      * @brief DriveTeamdrive::BackgroundImageFile holds the structure used
      * for backgroundImageFile property.
      */
     class BackgroundImageFile
     {
     public:
         struct Fields {
             static const QString Id;
             static const QString XCoordinate;
             static const QString YCoordinate;
             static const QString Width;
         };
 
         BackgroundImageFile();
         BackgroundImageFile(const BackgroundImageFile &other);
         ~BackgroundImageFile();
         bool operator==(const BackgroundImageFile &other) const;
         bool operator!=(const BackgroundImageFile &other) const
         {
             return !operator==(other);
         }
 
         /**
          * @brief Returns the id of the background image file.
          */
         [[nodiscard]] QString id() const;
 
         /**
          * @brief Sets the id of the background image file.
          *
          * @param id
          */
         void setId(const QString &id) const;
 
         /**
          * @brief Returns the x coordinate for this background image file.
          */
         [[nodiscard]] float xCoordinate() const;
 
         /**
          * @brief Sets the x coordinate for this background image file.
          *
          * @param xCoordinate
          */
         void setXCoordinate(float xCoordinate) const;
 
         /**
          * @brief Returns the y coordinate for this background image file.
          */
         [[nodiscard]] float yCoordinate() const;
 
         /**
          * @brief Sets the y coordinate for this background image file.
          *
          * @param yCoordinate
          */
         void setYCoordinate(float yCoordinate) const;
 
         /**
          * @brief Returns the width for this background image file.
          */
         [[nodiscard]] float width() const;
 
         /**
          * @brief Sets the width for this background image file.
          *
          * @param width
          */
         void setWidth(float width) const;
 
     private:
         class Private;
         QScopedPointer<Private> const d;
         friend class Private;
         friend class Teamdrive;
     };
 
     using BackgroundImageFilePtr = QSharedPointer<BackgroundImageFile>;
 
     struct Fields {
         static const QString Kind;
         static const QString Items;
         static const QString KindDrive;
         static const QString PageToken;
         static const QString NextPageToken;
         static const QString Id;
         static const QString Name;
         static const QString ThemeId;
         static const QString ColorRgb;
         static const QString BackgroundImageFile;
         static const QString BackgroundImageLink;
         static const QString Capabilities;
         static const QString CreatedDate;
         static const QString Restrictions;
     };
 
     Teamdrive();
     Teamdrive(const Teamdrive &other);
     ~Teamdrive() override;
     bool operator==(const Teamdrive &other) const;
     bool operator!=(const Teamdrive &other) const
     {
         return !operator==(other);
     }
 
     /**
      * @brief Returns the id of the teamdrive.
      */
     [[nodiscard]] QString id() const;
 
     /**
      * @brief Sets the id of the teamdrive.
      *
      * @param id
      */
     void setId(const QString &id) const;
 
     /**
      * @brief Returns the name of the teamdrive.
      */
     [[nodiscard]] QString name() const;
 
     /**
      * @brief Sets the name of the teamdrive.
      *
      * @param name
      */
     void setName(const QString &name) const;
 
     /**
      * @brief Returns the themeId of the teamdrive.
      */
     [[nodiscard]] QString themeId() const;
 
     /**
      * @brief Sets the themeId of the teamdrive.
      *
      * @param themeId
      */
     void setThemeId(const QString &themeId) const;
 
     /**
      * @brief Returns the colorRgb of the teamdrive.
      */
     [[nodiscard]] QString colorRgb() const;
 
     /**
      * @brief Sets the colorRgb of the teamdrive.
      *
      * @param colorRgb
      */
     void setColorRgb(const QString &colorRgb) const;
 
     /**
      * @brief Returns the image file and cropping parameters from which a background image for this Team Drive is set.
      */
     BackgroundImageFilePtr backgroundImageFile() const;
 
     /**
      * @brief Sets the backgroundImageFile of the teamdrive.
      *
      * @param backgroundImageFile
      */
     void setBackgroundImageFile(const BackgroundImageFilePtr &backgroundImageFile) const;
 
     /**
      * @brief Returns the backgroundImageLink of the teamdrive.
      */
     [[nodiscard]] QString backgroundImageLink() const;
 
     /**
      * @brief Returns the capabilities the current user has on this Team Drive.
      */
     CapabilitiesPtr capabilities() const;
 
     /**
      * @brief Returns the time at which the Team Drive was created.
      */
     [[nodiscard]] QDateTime createdDate() const;
 
     /**
      * @brief Returns the set of restrictions that apply to this Team Drive or
      * items inside this Team Drive.
      */
     RestrictionsPtr restrictions() const;
 
     /**
      * @brief Sets the restrictions of the teamdrive.
      *
      * @param restrictions
      */
     void setRestrictions(const RestrictionsPtr &restrictions) const;
 
     static TeamdrivePtr fromJSON(const QByteArray &jsonData);
     static TeamdrivesList fromJSONFeed(const QByteArray &jsonData, FeedData &feedData);
     static QByteArray toJSON(const TeamdrivePtr &teamdrive);
 
 private:
     class Private;
     QScopedPointer<Private> const d;
     friend class Private;
 };
 
 } /* namespace Drive */
 
 } /* namespace KGAPI2 */