KGAPI2::AuthJob Class Reference

#include <authjob.h>

Inheritance diagram for KGAPI2::AuthJob:

Public Member Functions
	AuthJob (const AccountPtr &account, const QString &apiKey, const QString &secretKey, QObject *parent=nullptr)
	~AuthJob () override
AccountPtr	account () const
void	setPassword (const QString &password)
void	setUsername (const QString &username)
Public Member Functions inherited from KGAPI2::Job
	Job (const AccountPtr &account, QObject *parent=nullptr)
	Job (QObject *parent=nullptr)
	~Job () override
AccountPtr	account () const
KGAPI2::Error	error () const
QString	errorString () const
QStringList	fields () const
bool	isRunning () const
int	maxTimeout () const
bool	prettyPrint () const
void	restart ()
void	setAccount (const AccountPtr &account)
void	setFields (const QStringList &fields)
void	setMaxTimeout (int maxTimeout)
void	setPrettyPrint (bool prettyPrint)
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Protected Member Functions
void	dispatchRequest (QNetworkAccessManager *accessManager, const QNetworkRequest &request, const QByteArray &data, const QString &contentType) override
void	handleReply (const QNetworkReply *reply, const QByteArray &rawData) override
void	start () override
Protected Member Functions inherited from KGAPI2::Job
virtual void	aboutToFinish ()
virtual void	aboutToStart ()
virtual void	emitFinished ()
virtual void	emitProgress (int processed, int total)
virtual void	enqueueRequest (const QNetworkRequest &request, const QByteArray &data=QByteArray(), const QString &contentType=QString())
virtual bool	handleError (int statusCode, const QByteArray &rawData)
void	setError (KGAPI2::Error error)
void	setErrorString (const QString &errorString)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Public Types inherited from QObject
typedef	QObjectList
Properties inherited from KGAPI2::Job
bool	isRunning
int	maxTimeout
Properties inherited from QObject
	objectName
Signals inherited from KGAPI2::Job
void	finished (KGAPI2::Job *job)
void	progress (KGAPI2::Job *job, int processed, int total)
Static Public Member Functions inherited from KGAPI2::Job
static QString	buildSubfields (const QString &field, const QStringList &fields)
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
bool	disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool	disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)

Detailed Description

A job to authenticate against Google and fetch tokens.

This job can be either used to refresh expired tokens (this is usually done automatically by Job implementation), or to request tokens for a new account.

In the latter case, the AuthJob will automatically open a browser window where user has to provide Google account credentials and grant access to all requested scopes (

See also

Account::scopes).

Author

Daniel Vrátil dvrat.nosp@m.il@r.nosp@m.edhat.nosp@m..com

Since

2.0

Definition at line 33 of file authjob.h.

Constructor & Destructor Documentation

AuthJob()

AuthJob::AuthJob ( const AccountPtr & account, const QString & apiKey, const QString & secretKey, QObject * parent = nullptr )

explicit

Creates a new authentication job.

When constructed without a parent, or with a non-QWidget parent, the job might pop up the authentication dialog.

Parameters

account	Account to authenticate.
apiKey	Application API key
secretKey	Application secret API key
parent

Definition at line 51 of file authjob.cpp.

~AuthJob()

AuthJob::~AuthJob ( )

overridedefault

Destructor.

Member Function Documentation

account()

AccountPtr AuthJob::account

(

)

const

Returns reauthenticated account.

Returns

An account pointer passed to the AuthJob() constructor with all fields filled and validated. When the job fails, the account is unchanged.

Definition at line 62 of file authjob.cpp.

dispatchRequest()

void AuthJob::dispatchRequest ( QNetworkAccessManager * accessManager, const QNetworkRequest & request, const QByteArray & data, const QString & contentType )

overrideprotectedvirtual

KGAPI2::Job::displayRequest implementation.

Parameters

accessManager
request
data
contentType

Implements KGAPI2::Job.

Definition at line 82 of file authjob.cpp.

handleReply()

void AuthJob::handleReply ( const QNetworkReply * reply, const QByteArray & rawData )

overrideprotectedvirtual

KGAPI2::Job::handleReply implementation.

Parameters

reply
rawData

Implements KGAPI2::Job.

Definition at line 76 of file authjob.cpp.

setPassword()

void AuthJob::setPassword

(

const QString &

password

)

Sets the password that will be used when authenticate is called.

Parameters

password

password to use

Deprecated

Definition at line 72 of file authjob.cpp.

setUsername()

void AuthJob::setUsername

(

const QString &

username

)

Sets the username that will be used when authenticate is called.

Parameters

username

username to use

Definition at line 67 of file authjob.cpp.

start()

void AuthJob::start ( )

overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 91 of file authjob.cpp.

---

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

• authjob.h
• authjob.cpp