oauth.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <QDateTime>
#include <QObject>
#include <QString>
#include <albert/export.h>
#include <memory>
class QUrl;
 
namespace albert
{
 
class ALBERT_EXPORT OAuth2 : public QObject
{
    Q_OBJECT
public:
 
    OAuth2();
 
    ~OAuth2();
 
    void requestAccess();
 
    void updateTokens();
 
    const QString &clientId() const;
 
    void setClientId(const QString &id);
 
    const QString &clientSecret() const;
 
    void setClientSecret(const QString &secret);
 
    const QString &scope() const;
 
    void setScope(const QString &scope);
 
    const QString &authUrl() const;
 
    void setAuthUrl(const QString &url);
 
    const QString &redirectUri() const;
 
    void setRedirectUri(const QString &uri);
 
    bool isPkceEnabled() const;
 
    void setPkceEnabled(bool enabled);
 
    const QString &tokenUrl() const;
 
    void setTokenUrl(const QString &url);
 
    const QString &accessToken() const;
 
    const QString &refreshToken() const;
 
    const QDateTime &tokenExpiration() const;
 
    void setTokens(const QString &access_token,
                   const QString &refresh_token = {},
                   const QDateTime &expiration = {});
 
    const QString &error() const;
 
    enum class State {
        NotAuthorized,  
        Awaiting,  
        Granted  
    };
 
    State state() const;
 
    void handleCallback(const QUrl &callback);
 
signals:
 
    void clientIdChanged(const QString &);  
    void clientSecretChanged(const QString &);  
    void scopeChanged(const QString &);  
    void authUrlChanged(const QString &);  
    void redirectUriChanged(const QString &);  
    void tokenUrlChanged(const QString &);  
    void tokensChanged();  
    void stateChanged(State);  
 
private:
 
    class Private;
    std::unique_ptr<Private> d;
 
};
 
}