KGAPI2::AuthJob

#include <authjob.h>

Inheritance diagram for KGAPI2::AuthJob:

Public Member Functions

 AuthJob (const AccountPtr &account, const QString &apiKey, const QString &secretKey, QWidget *parent)
 
 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 (QObject *parent=nullptr)
 
 Job (const AccountPtr &account, 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)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () 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())
 
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
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Additional Inherited Members

- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from QObject
typedef QObjectList
 

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 show a dialog where user has to provide Google account credentials and grant access to all requested scopes (

See also
Account::scopes).
Author
Daniel Vrátil dvrat[email protected][email protected][email protected]edhat[email protected].com
Since
2.0

Definition at line 33 of file authjob.h.

Constructor & Destructor Documentation

AuthJob::AuthJob ( const AccountPtr account,
const QString apiKey,
const QString secretKey,
QWidget parent 
)
explicit

Creates a new authentication job that will use parent as parent for the authentication dialog.

When constructed with a widget parent, AuthJob will place the authentication widget on the parent instead of displaying a dialog. This allows embedding the authentication process into a wizard for instance.

Parameters
accountAccount to authenticate. When only scopes are set, a full authentication process will run (including showing the auth widget) and the rest will be filled by the job.
Passing an Account with account name, scopes and both tokens filled will only refresh the access token. If however the scopes have been changed a full authentication will be started.
Any other Account will be considered invalid and the job will finish immediately.
Parameters
apiKeyApplication API key
secretKeyApplication secret API key
parentParent widget on which auth widget should be constructed if necessary.

Definition at line 122 of file authjob.cpp.

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
accountAccount to authenticate. See AuthJob(AccountPtr,QString,QString,QWidget) for detailed description of account content.
apiKeyApplication API key
secretKeyApplication secret API key
parent

Definition at line 132 of file authjob.cpp.

AuthJob::~AuthJob ( )
override

Destructor.

Definition at line 141 of file authjob.cpp.

Member Function Documentation

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 146 of file authjob.cpp.

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 188 of file authjob.cpp.

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

KGAPI2::Job::handleReply implementation.

Parameters
reply
rawData

Implements KGAPI2::Job.

Definition at line 161 of file authjob.cpp.

void AuthJob::setPassword ( const QString password)

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

The password will be automatically filled in the Google login form in the authentication widget.

Be aware that the password will be set every time

See also
authenticate is called so if you want to change or remove it call
setPassword again with empty string or
clearCredentials.
Parameters
passwordpassword to use

Definition at line 156 of file authjob.cpp.

void AuthJob::setUsername ( const QString username)

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

The username will be automatically filled in the Google login form in the authentication widget.

Be aware that the username will be set every time

See also
authenticate is called so if you want to change or remove it call
setUsername again with empty string or
clearCredentials.
Parameters
usernameusername to use

Definition at line 151 of file authjob.cpp.

void AuthJob::start ( )
overrideprotectedvirtual

KGAPI2::Job::start implementation.

Implements KGAPI2::Job.

Definition at line 195 of file authjob.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sun Jul 12 2020 23:10:29 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.