PolkitQt1::Agent::Listener

Search for usage in LXR

PolkitQt1::Agent::Listener Class Referenceabstract

#include <Listener>

Inheritance diagram for PolkitQt1::Agent::Listener:

Public Slots

virtual void cancelAuthentication ()=0
 
virtual void initiateAuthentication (const QString &actionId, const QString &message, const QString &iconName, const PolkitQt1::Details &details, const QString &cookie, const PolkitQt1::Identity::List &identities, PolkitQt1::Agent::AsyncResult *result)=0
 
virtual bool initiateAuthenticationFinish ()=0
 

Public Member Functions

 Listener (QObject *parent=nullptr)
 
 Listener (PolkitAgentListener *listener, QObject *parent=nullptr)
 
const PolkitAgentListener * listener ()
 
bool registerListener (const PolkitQt1::Subject &subject, const QString &objectPath)
 
- 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
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- 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
 
- 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)
 

Detailed Description

Listener is abstract class used for implementing authentication agents.

Author
Jaroslav Reznik jrezn[email protected][email protected][email protected]edhat[email protected].com

To implement an authentication agent, just subclass this class and implement virtual functions initiateAuthentication, initiateAuthenticationFinish and cancelAuthentication.

You can also use Session class to authenticate users however it isn't required.

See also
Session

Definition at line 48 of file polkitqt1-agent-listener.h.

Constructor & Destructor Documentation

PolkitQt1::Agent::Listener::Listener ( QObject parent = nullptr)

Constructor of Listener class.

Definition at line 34 of file polkitqt1-agent-listener.cpp.

PolkitQt1::Agent::Listener::Listener ( PolkitAgentListener *  listener,
QObject parent = nullptr 
)
explicit

Constructor of Listener class from PolkitAgentListener.

Warning
Use this only if you are completely aware of what are you doing!
Parameters
listenerPointer to the PolkitAgentListener
parent

Definition at line 46 of file polkitqt1-agent-listener.cpp.

Member Function Documentation

virtual void PolkitQt1::Agent::Listener::cancelAuthentication ( )
pure virtualslot

TODO: Is this method really required ?

Cancels an authentication request from the polkit daemon.

Note
You have to reimplement this method in the subclass.
See also
initiateAuthentication
virtual void PolkitQt1::Agent::Listener::initiateAuthentication ( const QString actionId,
const QString message,
const QString iconName,
const PolkitQt1::Details details,
const QString cookie,
const PolkitQt1::Identity::List identities,
PolkitQt1::Agent::AsyncResult result 
)
pure virtualslot

Initiate authentication for the action.

This method will be called on a registered authentication agent when the user owning the session needs to prove he is one of the identities listed in identities.

Note
You have to reimplement this method in the subclass.
Parameters
actionIdThe action to authenticate for
messageThe message to present to the user
iconNameThe name of the icon which is representing the action
detailsDetails describing the action
cookieThe cookie for the authentization request
identitiesA list of Identity object that the user can choose to authenticate as
resultThis AsyncResult MUST be completed by using complete() method when the authentication is done. You can pass it to the constructor of the Session class and then call session->result()->complete() to mark the action as done.
virtual bool PolkitQt1::Agent::Listener::initiateAuthenticationFinish ( )
pure virtualslot

TODO: Is this method really required ?

Finishes an authentication request from the polkit daemon.

Note
You have to reimplement this method in the subclass.
See also
initiateAuthentication
const PolkitAgentListener * PolkitQt1::Agent::Listener::listener ( )

Returns pointer to the PolkitAgentListener.

Warning
Use this only if you are completely aware of what are you doing!
Returns
PolkitAgentListener

Definition at line 106 of file polkitqt1-agent-listener.cpp.

bool PolkitQt1::Agent::Listener::registerListener ( const PolkitQt1::Subject subject,
const QString objectPath 
)

Registers listener with polkit daemon as an authentication agent for subject.

This is implemented by registering a DBus object at objectPath on the unique name assigned by the system message bus.

Whenever the polkit daemon needs to authenticate a processes that is related to subject, the methods initiateAuthentication and initiateAuthenticationFinish will be evoked.

Parameters
subjectSubject that listener will be registered for
objectPathDBus object path
Returns
True if the polkitqt1-agent-listener.has been registered, False otherwise

Definition at line 73 of file polkitqt1-agent-listener.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Fri Apr 16 2021 23:06:38 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.