PolkitQt1::Agent::Listener
#include <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 (PolkitAgentListener *listener, QObject *parent=nullptr) | |
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) | |
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 |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
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 *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) |
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) |
Detailed Description
Listener is abstract class used for implementing authentication agents.
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 47 of file polkitqt1-agent-listener.h.
Constructor & Destructor Documentation
◆ Listener() [1/2]
PolkitQt1::Agent::Listener::Listener | ( | QObject * | parent = nullptr | ) |
Constructor of Listener class.
Definition at line 34 of file polkitqt1-agent-listener.cpp.
◆ Listener() [2/2]
|
explicit |
Constructor of Listener class from PolkitAgentListener.
- Warning
- Use this only if you are completely aware of what are you doing!
- Parameters
-
listener Pointer to the PolkitAgentListener parent
Definition at line 44 of file polkitqt1-agent-listener.cpp.
◆ ~Listener()
|
override |
Definition at line 54 of file polkitqt1-agent-listener.cpp.
Member Function Documentation
◆ 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
◆ initiateAuthentication
|
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
-
actionId The action to authenticate for message The message to present to the user iconName The name of the icon which is representing the action details Details describing the action cookie The cookie for the authentization request identities A list of Identity object that the user can choose to authenticate as result This 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.
◆ 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
◆ listener()
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 102 of file polkitqt1-agent-listener.cpp.
◆ registerListener()
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
-
subject Subject that listener will be registered for objectPath DBus object path
- Returns
True
if the polkitqt1-agent-listener.has been registered,False
otherwise
Definition at line 69 of file polkitqt1-agent-listener.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Oct 11 2024 12:16:56 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.