albert::util::OAuth2 Class Reference

#include <albert/oauth.h>

Inherits QObject.

Detailed Description

Provides OAuth2 authentication with support for the Authorization Code Flow with PKCE and refresh tokens.

Public Types
enum class	State { NotAuthorized , Awaiting , Granted }

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)

Public Member Functions
	OAuth2 ()
	~OAuth2 ()
void	requestAccess ()
void	updateTokens ()
const QString &	clientId () const
void	setClientId (const QString &)
const QString &	clientSecret () const
void	setClientSecret (const QString &)
const QString &	scope () const
void	setScope (const QString &)
const QString &	authUrl () const
void	setAuthUrl (const QString &)
const QString &	redirectUri () const
void	setRedirectUri (const QString &)
bool	isPkceEnabled () const
void	setPkceEnabled (bool)
const QString &	tokenUrl () const
void	setTokenUrl (const QString &)
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
State	state () const
void	handleCallback (const QUrl &callback)

Member Enumeration Documentation

State

enum class albert::util::OAuth2::State

strong

Enumerator
NotAuthorized
Awaiting
Granted

Constructor & Destructor Documentation

OAuth2()

albert::util::OAuth2::OAuth2

(

)

~OAuth2()

albert::util::OAuth2::~OAuth2

(

)

Member Function Documentation

accessToken()

const QString & albert::util::OAuth2::accessToken

(

)

const

authUrl()

const QString & albert::util::OAuth2::authUrl

(

)

const

authUrlChanged

void albert::util::OAuth2::authUrlChanged ( const QString &  )

signal

clientId()

const QString & albert::util::OAuth2::clientId

(

)

const

clientIdChanged

void albert::util::OAuth2::clientIdChanged ( const QString &  )

signal

clientSecret()

const QString & albert::util::OAuth2::clientSecret

(

)

const

clientSecretChanged

void albert::util::OAuth2::clientSecretChanged ( const QString &  )

signal

error()

const QString & albert::util::OAuth2::error

(

)

const

handleCallback()

void albert::util::OAuth2::handleCallback

(

const QUrl &

callback

)

isPkceEnabled()

bool albert::util::OAuth2::isPkceEnabled

(

)

const

redirectUri()

const QString & albert::util::OAuth2::redirectUri

(

)

const

redirectUriChanged

void albert::util::OAuth2::redirectUriChanged ( const QString &  )

signal

refreshToken()

const QString & albert::util::OAuth2::refreshToken

(

)

const

requestAccess()

void albert::util::OAuth2::requestAccess

(

)

scope()

const QString & albert::util::OAuth2::scope

(

)

const

scopeChanged

void albert::util::OAuth2::scopeChanged ( const QString &  )

signal

setAuthUrl()

void albert::util::OAuth2::setAuthUrl

(

const QString &

)

setClientId()

void albert::util::OAuth2::setClientId

(

const QString &

)

setClientSecret()

void albert::util::OAuth2::setClientSecret

(

const QString &

)

setPkceEnabled()

void albert::util::OAuth2::setPkceEnabled

(

bool

)

setRedirectUri()

void albert::util::OAuth2::setRedirectUri

(

const QString &

)

setScope()

void albert::util::OAuth2::setScope

(

const QString &

)

setTokens()

void albert::util::OAuth2::setTokens	(	const QString &	access_token,
		const QString &	refresh_token = {},
		const QDateTime &	expiration = {}
	)

setTokenUrl()

void albert::util::OAuth2::setTokenUrl

(

const QString &

)

state()

State albert::util::OAuth2::state

(

)

const

stateChanged

void albert::util::OAuth2::stateChanged ( State  )

signal

tokenExpiration()

const QDateTime & albert::util::OAuth2::tokenExpiration

(

)

const

tokensChanged

void albert::util::OAuth2::tokensChanged ( )

signal

tokenUrl()

const QString & albert::util::OAuth2::tokenUrl

(

)

const

tokenUrlChanged

void albert::util::OAuth2::tokenUrlChanged ( const QString &  )

signal

updateTokens()

void albert::util::OAuth2::updateTokens

(

)

---

The documentation for this class was generated from the following file:

• workspace/albert/include/albert/oauth.h