PolkitQt1::Agent::Session

PolkitQt1
Agent
Session

#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 () override

void	cancel ()

void	initiate ()

AsyncResult *	result ()

void	setResponse (const QString &response)

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

Author: Radek Novacek rnova.nosp@m.cek@.nosp@m.redha.nosp@m.t.co.nosp@m.m

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

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

Constructor & Destructor Documentation

◆ Session() [1/2]

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

Create a new authentication session.

Parameters

identity	The identity to authenticate
cookie	The cookie obtained from the PolicyKit daemon
result	Result of the authentication action. Must be finished using complete() method.
parent

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

◆ Session() [2/2]

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

pkAgentSession	PolkitAgentSession object
parent

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

◆ ~Session()

Session::~Session ( )

override

Destroy authentication session.

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

Member Function Documentation

◆ cancel()

void Session::cancel ( )

Cancel the authentication session.

This will emit the completed() signal.

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

◆ completed

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

gainedAuthorization True if authorization was successfully obtained.

◆ initiate()

void Session::initiate ( )

Initiate the authentication session.

Use cancel() to cancel the session.

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

◆ request

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

request	The request to show the user, e.g. "name: " or "password: ".
echo	`True` if the response to the request SHOULD be echoed on the screen, `False` if the response MUST NOT be echoed to the screen.

◆ result()

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.

◆ setResponse()

void Session::setResponse ( const QString & response )

Method for providing response to requests received via request signal.

Parameters

response Response from the user, typically a password

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

◆ showError

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

text	An error string to display to the user.

◆ showInfo

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

text	A string to be displayed to the user.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About PolkitQt-1

PolkitQt1::Agent::Session

Signals

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Session() [1/2]

◆ Session() [2/2]

◆ ~Session()

Member Function Documentation

◆ cancel()

◆ completed

◆ initiate()

◆ request

◆ result()

◆ setResponse()

◆ showError

◆ showInfo