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

 /*
     SPDX-FileCopyrightText: 2012-2018 Daniel Vrátil <dvratil@kde.org>
 
     SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
 */
 
 #pragma once
 
 #include <QMetaType>
 #include <QSharedPointer>
 #include <QString>
 #include <QUrl>
 
 #include "kgapicore_export.h"
 #include "types.h"
 
 namespace KGAPI2
 {
 
 /**
  * @headerfile account.h
  * @brief A Google account
  *
  * This class represents a single Google account. The account is uniquely
  * identified by Account::accountName (which is actually the user's GMail address).
  *
  * The class stores an access token, refresh token (to retrieve a new access token
  * when the old one expires) and list of scopes (APIs that current access token
  * can be used to access).
  *
  * Unlike in previous versions, account management is not handled by LibKGAPI
  * anymore and it's up to programmer to store the account in a persistent storage.
  *
  * To obtain a new account, use AuthJob.
  *
  * @author Daniel Vrátil <dvratil@redhat.com>
  * @since 0.1
  */
 class KGAPICORE_EXPORT Account
 {
 public:
     /**
      * @brief Constructs an invalid account.
      */
     Account();
 
     /**
      * @brief Constructs a new valid account
      *
      * @param account Google account name (usually user.name@gmail.com)
      * @param accessToken Access token to \p scopes for \p account
      * @param refreshToken Refresh token
      * @param scopes List of scopes
      */
     explicit Account(const QString &account,
                      const QString &accessToken = QString(),
                      const QString &refreshToken = QString(),
                      const QList<QUrl> &scopes = QList<QUrl>());
 
     /**
      * @brief Copy constructor
      */
     Account(const Account &other);
 
     /**
      * @brief Destructor
      */
     virtual ~Account();
 
     bool operator==(const Account &other) const;
 
     /**
      * @returns Returns unique account identifier
      */
     [[nodiscard]] QString accountName() const;
 
     /**
      * Sets account name.
      *
      * @param accountName
      */
     void setAccountName(const QString &accountName);
 
     /**
      * @return Returns access token.
      */
     [[nodiscard]] QString accessToken() const;
 
     /**
      * Sets a new access token.
      *
      * @param accessToken
      */
     void setAccessToken(const QString &accessToken);
 
     /**
      * @return Returns refresh token.
      */
     [[nodiscard]] QString refreshToken() const;
 
     /**
      * Sets a new refresh token for the access token.
      *
      * @param refreshToken
      */
     void setRefreshToken(const QString &refreshToken);
 
     /**
      * @return Returns list of scopes the account is authenticated against.
      */
     [[nodiscard]] QList<QUrl> scopes() const;
 
     /**
      * \brief Sets new scopes.
      *
      * @note Note that changing scopes requires makes current tokens invalid.
      * This means that when this Account is used next time, AuthJob will be
      * automatically started and user will be prompted with a dialog to grant
      * access to all scopes.
      *
      * @param scopes
      */
     void setScopes(const QList<QUrl> &scopes);
 
     /**
      * Adds a single scope to account scopes.
      *
      * @param scope
      * @see Account::setScopes(const QList<QUrl>)
      */
     void addScope(const QUrl &scope);
 
     /**
      * Removes scope from the list.
      *
      * @param scope
      * @see Account::setScopes(const QList<QUrl>)
      */
     void removeScope(const QUrl &scope);
 
     /**
      * @since 2.0.82
      * Returns expire date time token
      */
     [[nodiscard]] QDateTime expireDateTime() const;
 
     /**
      * @since 2.0.82
      * set expire date time
      */
     void setExpireDateTime(const QDateTime &expire);
 
     /**
      * Returns scope URL for AccountInfo service.
      */
     static QUrl accountInfoScopeUrl();
 
     /**
      * Returns scope URL to retrieve AccountInfo with email.
      */
     static QUrl accountInfoEmailScopeUrl();
 
     /**
      * Returns scope URL for Google Calendar service.
      */
     static QUrl calendarScopeUrl();
 
     /**
      * Returns scope URL for Google Tasks service.
      */
     static QUrl tasksScopeUrl();
 
     /**
      * Returns scope URL for Google People service.
      */
     static QUrl peopleScopeUrl();
 
     /**
      * Returns scope URL for Google Latitude service.
      */
     static QUrl latitudeScopeUrl();
 
     /**
      * Returns scope URL for Google Blogger service.
      */
     static QUrl bloggerScopeUrl();
 
     /**
      * Returns scope URL for Gmail service.
      */
     static QUrl mailScopeUrl();
 
     /**
      * Returns scope URL for Drive service.
      */
     static QUrl driveScopeUrl();
 
 private:
     class Private;
     Private *const d;
 
     /**
      * @internal
      * Whether scopes were changed or not.
      *
      * AuthJob reads this attribute when Account is passed to it to
      * determine whether completely new process of authentication is needed,
      * or whether just refreshing tokens is enough.
      *
      * When m_scopesChanged is \p true and AuthJob successffulyperforms full
      * re-authentication it sets this attribute to \p false and next time it
      * will just refresh existing tokens until the scopes are changed again.
      */
     bool m_scopesChanged; // krazy:exclude=dpointer
 
     friend class AuthJob;
 };
 
 } // namespace KGAPI2
 
 Q_DECLARE_METATYPE(KGAPI2::AccountPtr)