PolkitQt1::Agent::Session

Search for usage in LXR

PolkitQt1::Agent::Session Class Reference

#include <Session>

Inheritance diagram for PolkitQt1::Agent::Session:

Signals

void completed (bool gainedAuthorization)
 
void request (const QString &request, bool echo)
 
void showError (const QString &text)
 
void showInfo (const QString &text)
 

Public Member Functions

 Session (const PolkitQt1::Identity &identity, const QString &cookie, AsyncResult *result=nullptr, QObject *parent=nullptr)
 
 Session (PolkitAgentSession *pkAgentSession, QObject *parent=nullptr)
 
 ~Session ()
 
void cancel ()
 
void initiate ()
 
AsyncResultresult ()
 
void setResponse (const QString &response)
 
- 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

Author
Radek Novacek rnova[email protected][email protected][email protected]redha[email protected]t.co[email protected]m

This class is interface for interacting with native authentication system for obtaining authorizations.

Definition at line 67 of file polkitqt1-agent-session.h.

Constructor & Destructor Documentation

Session::Session ( const PolkitQt1::Identity identity,
const QString cookie,
AsyncResult result = nullptr,
QObject parent = nullptr 
)

Create a new authentication session.

Parameters
identityThe identity to authenticate
cookieThe cookie obtained from the PolicyKit daemon
resultResult of the authentication action. Must be finished using complete() method.
parent

Definition at line 39 of file polkitqt1-agent-session.cpp.

Session::Session ( PolkitAgentSession *  pkAgentSession,
QObject parent = nullptr 
)
explicit

Create a new authentication session from PolkitAgentSession object.

Warning
Use this only if you are completely aware of what are you doing!
Parameters
pkAgentSessionPolkitAgentSession object
parent

Definition at line 51 of file polkitqt1-agent-session.cpp.

Session::~Session ( )

Destroy authentication session.

Definition at line 65 of file polkitqt1-agent-session.cpp.

Member Function Documentation

void Session::cancel ( )

Cancel the authentication session.

This will emit the completed() signal.

Definition at line 83 of file polkitqt1-agent-session.cpp.

void PolkitQt1::Agent::Session::completed ( bool  gainedAuthorization)
signal

This signal will be emitted when the authentication polkitqt1-agent-session.has been completed or cancelled.

Parameters
gainedAuthorizationTrue if authorization was successfully obtained.
void Session::initiate ( )

Initiate the authentication session.

Use cancel() to cancel the session.

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

void PolkitQt1::Agent::Session::request ( const QString request,
bool  echo 
)
signal

This signal will be emitted when user is requested to answer a question.

Parameters
requestThe request to show the user, e.g. "name: " or "password: ".
echoTrue if the response to the request SHOULD be echoed on the screen, False if the response MUST NOT be echoed to the screen.
AsyncResult * Session::result ( )

Get AsyncResult that can be used to finish authentication operation.

Returns
AsyncResult object or NULL if it is not set

Definition at line 88 of file polkitqt1-agent-session.cpp.

void Session::setResponse ( const QString response)

Method for providing response to requests received via request signal.

Parameters
responseResponse from the user, typically a password

Definition at line 78 of file polkitqt1-agent-session.cpp.

void PolkitQt1::Agent::Session::showError ( const QString text)
signal

This signal will be emitted when there is information related to an error condition to be displayed to the user.

Parameters
textAn error string to display to the user.
void PolkitQt1::Agent::Session::showInfo ( const QString text)
signal

This signal will be emitted when there is information to be displayed to the user.

Parameters
textA string to be displayed to the user.

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.