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

 /*
     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 <QString>
 #include <QUrl>
 
 #include <QDateTime>
 
 namespace KGAPI2
 {
 
 namespace Drive
 {
 
 /**
  * @brief Revision contains a revision of a file.
  *
  * Getters and setters' documentation is based on Google Drive's API v2 reference
  * @see <a href="https://developers.google.com/drive/v2/reference/revisions">Revisions</a>
  *
  * @since 2.0
  * @author Andrius da Costa Ribas <andriusmao@gmail.com>
  * @author Daniel Vrátil <dvratil@redhat.com>
  */
 class KGAPIDRIVE_EXPORT Revision : public KGAPI2::Object
 {
 public:
     explicit Revision();
     explicit Revision(const Revision &other);
     ~Revision() override;
     bool operator==(const Revision &other) const;
     bool operator!=(const Revision &other) const
     {
         return !operator==(other);
     }
 
     /**
      * @brief Returns the id of the revision.
      */
     [[nodiscard]] QString id() const;
 
     /**
      * @brief Returns a link back to this revision.
      */
     [[nodiscard]] QUrl selfLink() const;
 
     /**
      * @brief Returns the MIME type of the revision.
      */
     [[nodiscard]] QString mimeType() const;
 
     /**
      * @brief Returns the last time this revision was modified.
      */
     [[nodiscard]] QDateTime modifiedDate() const;
 
     /**
      * @brief Returns whether this revision is pinned to prevent automatic purging.
      *
      * This will only be populated and can only be modified on files with content
      * stored in Drive which are not Google Docs.
      *
      * Revisions can also be pinned when they are created through the
      * drive.files.insert/update/copy by using the pinned query parameter.
      */
     [[nodiscard]] bool pinned() const;
 
     /**
      * @brief Sets whether this revision is pinned to prevent automatic purging.
      *
      * This will only be populated and can only be modified on files with content
      * stored in Drive which are not Google Docs.
      *
      * Revisions can also be pinned when they are created through the
      * drive.files.insert/update/copy by using the pinned query parameter.
      *
      * @param pinned
      */
     void setPinned(bool pinned);
 
     /**
      * @brief Returns whether this revision is published.
      *
      * This is only populated and can only be modified for Google Docs.
      */
     [[nodiscard]] bool published() const;
 
     /**
      * @brief Sets whether this revision is published.
      *
      * @param published
      */
     void setPublished(bool published);
 
     /**
      * @brief Returns a link to the published revision.
      */
     [[nodiscard]] QUrl publishedLink() const;
 
     /**
      * @brief Returns whether subsequent revisions will be automatically republished.
      *
      * This is only populated and can only be modified for Google Docs.
      */
     [[nodiscard]] bool publishAuto() const;
 
     /**
      * @brief Sets whether subsequent revisions will be automatically republished.
      *
      * This is only populated and can only be modified for Google Docs.
      *
      * @param publishAuto
      */
     void setPublishAuto(bool publishAuto);
 
     /**
      * @brief Returns whether this revision is published outside the domain.
      *
      * This is only populated and can only be modified for Google Docs.
      */
     [[nodiscard]] bool publishedOutsideDomain() const;
 
     /**
      * @brief Sets whether this revision is published outside the domain.
      *
      * This is only populated and can only be modified for Google Docs.
      *
      * @param publishedOutsideDomain
      */
     void setPublishedOutsideDomain(bool publishedOutsideDomain);
 
     /**
      * @brief Returns a short term download URL for the file.
      *
      * This will only be populated on files with content stored in Drive.
      */
     [[nodiscard]] QUrl downloadUrl() const;
 
     /**
      * @brief Returns the links for exporting Google Docs to specific formats.
      *
      * This is a map from the export format to URL.
      */
     QMap<QString /* format */, QUrl /* url */> exportLinks() const;
 
     /**
      * @brief Returns the name of the last user to modify this revision.
      */
     [[nodiscard]] QString lastModifyingUserName() const;
 
     /**
      * @brief Returns object representing the last user to modify this revision
      */
     [[nodiscard]] UserPtr lastModifyingUser() const;
 
     /**
      * @brief Returns the original filename when this revision was created.
      *
      * This will only be populated on files with content stored in Drive.
      */
     [[nodiscard]] QString originalFilename() const;
 
     /**
      * @brief Returns an MD5 checksum for the content of this revision.
      *
      * This will only be populated on files with content stored in Drive
      */
     [[nodiscard]] QString md5Checksum() const;
 
     /**
      * @brief Returns the size of the revision in bytes.
      *
      * This will only be populated on files with content stored in Drive.
      */
     [[nodiscard]] qlonglong fileSize() const;
 
     static RevisionPtr fromJSON(const QByteArray &jsonData);
     static RevisionsList fromJSONFeed(const QByteArray &jsonData);
     static QByteArray toJSON(const RevisionPtr &revision);
 
 private:
     class Private;
     Private *const d;
     friend class Private;
 };
 
 } /* namespace Drive */
 
 } /* namespace KGAPI2 */