Search for usage in LXR

KAuth::Action Class Reference

#include <KAuth/Action>

Public Types

enum class  AuthDetail { DetailOther = 0 , DetailMessage }
enum  AuthStatus {
  DeniedStatus , ErrorStatus , InvalidStatus , AuthorizedStatus ,
  AuthRequiredStatus , UserCancelledStatus
typedef QMap< AuthDetail, QVariantDetailsMap
enum  ExecutionMode { ExecuteMode , AuthorizeOnlyMode }

Public Member Functions

 Action ()
 Action (const Action &action)
 Action (const QString &name)
 Action (const QString &name, const DetailsMap &details)
 ~Action ()
void addArgument (const QString &key, const QVariant &value)
QVariantMap arguments () const
DetailsMap detailsV2 () const
ExecuteJobexecute (ExecutionMode mode=ExecuteMode)
bool hasHelper () const
QString helperId () const
bool isValid () const
QString name () const
bool operator!= (const Action &action) const
Actionoperator= (const Action &action)
bool operator== (const Action &action) const
QWindowparentWindow () const
void setArguments (const QVariantMap &arguments)
void setDetailsV2 (const DetailsMap &details)
void setHelperId (const QString &id)
void setName (const QString &name)
void setParentWindow (QWindow *parent)
void setTimeout (int timeout)
AuthStatus status () const
int timeout () const

Detailed Description

Class to access, authorize and execute actions.

This is the main class of the KAuth API. It provides the interface to manipulate actions. Every action is identified by its name. Every instance of the Action class with the same name refers to the same action.

Once you have an action object you can tell the helper to execute it (asking the user to authenticate if needed) with the execute() method. The simplest thing to do is to execute a single action synchronously blocking for the reply by calling KJob::exec() on the job object returned by execute().

For asynchronous calls, use KAuth::ExecuteJob::start() instead. It sends the request to the helper and returns immediately. Before doing so you should however connect to at least the KJob::result(KJob *) signal to receive a slot call once the action is done executing.

To use the execute() method you have to set the default helper's ID using the setHelperId() static method. Alternatively, you can specify the helperID using the overloaded version of the methods that takes it as a parameter.

Each action object contains a QVariantMap object that is passed directly to the helper when the action is executed. You can access this map using the arguments() method. You can insert into it any kind of custom data you need to pass to the helper.

void MyApp::runAction()
action = KAuth::Action("org.kde.myapp.action");
KAuth::ExecuteJob *job = action.execute();
connect(job, &KAuth::ExecuteJob::result, this, &MyApp::actionResult);
void MyApp::actionResult(KJob *kjob)
auto job = qobject_cast<KAuth::ExecuteJob *>(kjob);
qDebug() << job.error() << job.data();
Class to access, authorize and execute actions.
Definition action.h:78
Job for executing an Action.
Definition executejob.h:40
QVariantMap data() const
Use this to get the data set in the action by HelperSupport::progressStep(QVariant) or returned at th...
void start() override
Starts the job asynchronously.
int error() const
void result(KJob *job)

Definition at line 77 of file action.h.

Member Typedef Documentation

◆ DetailsMap

Map of details.

Definition at line 112 of file action.h.

Member Enumeration Documentation

◆ AuthDetail

enum class KAuth::Action::AuthDetail

The backend specific details.


The message to show in authentication dialog.

Definition at line 103 of file action.h.

◆ AuthStatus

The three values set by authorization methods.


The authorization has been denied by the authorization backend.


An error occurred.


An invalid action cannot be authorized.


The authorization has been granted by the authorization backend.


The user could obtain the authorization after authentication.


The user pressed Cancel the authentication dialog. Currently used only on the mac.

Definition at line 84 of file action.h.

◆ ExecutionMode

enum KAuth::Action::ExecutionMode

Definition at line 94 of file action.h.

Constructor & Destructor Documentation

◆ Action() [1/4]

Action::Action ( )

Default constructor.

This constructor sets the name to the empty string. Such an action is invalid and cannot be authorized nor executed, so you need to call setName() before you can use the object.

Definition at line 51 of file action.cpp.

◆ Action() [2/4]

Action::Action ( const Action & action)

Copy constructor.

Definition at line 56 of file action.cpp.

◆ Action() [3/4]

Action::Action ( const QString & name)

This creates a new action object with this name.

nameThe name of the new action

Definition at line 61 of file action.cpp.

◆ Action() [4/4]

Action::Action ( const QString & name,
const DetailsMap & details )

This creates a new action object with this name and details.

nameThe name of the new action
detailsThe details of the action
See also

Definition at line 68 of file action.cpp.

◆ ~Action()

Action::~Action ( )

Virtual destructor.

Definition at line 76 of file action.cpp.

Member Function Documentation

◆ addArgument()

void Action::addArgument ( const QString & key,
const QVariant & value )

Convenience method to add an argument.

This method adds the pair key/value to the QVariantMap used to send custom data to the helper.

Use this method if you don't want to create a new QVariantMap only to add a new entry.

keyThe new entry's key
valueThe value of the new entry

Definition at line 144 of file action.cpp.

◆ arguments()

QVariantMap Action::arguments ( ) const

Returns map object used to pass arguments to the helper.

This method returns the variant map that the application can use to pass arbitrary data to the helper when executing the action.

The arguments map that will be passed to the helper.

Definition at line 149 of file action.cpp.

◆ detailsV2()

Action::DetailsMap Action::detailsV2 ( ) const

Gets the action's details.

The details that will be shown in the authorization dialog, if the backend supports it.

The action's details

Definition at line 124 of file action.cpp.

◆ execute()

ExecuteJob * Action::execute ( ExecutionMode mode = ExecuteMode)

Get the job object used to execute the action.

The KAuth::ExecuteJob object to be used to run the action.

Definition at line 184 of file action.cpp.

◆ hasHelper()

bool Action::hasHelper ( ) const

Checks if the action has an helper.

This function can be used to check if an helper will be called upon the execution of an action. Such an helper can be set through setHelperId(). If this function returns false, upon execution the action will be just authorized.

Whether the action has an helper or not
See also

Definition at line 189 of file action.cpp.

◆ helperId()

QString Action::helperId ( ) const

Gets the default helper ID used for actions execution.

The helper ID is the string that uniquely identifies the helper in the system. It is the string passed to the KAUTH_HELPER_MAIN() macro in the helper source. Because one could have different helpers, you need to specify an helper ID for each execution, or set a default ID by calling setHelperId(). This method returns the current default value.

The default helper ID.

Definition at line 154 of file action.cpp.

◆ isValid()

bool Action::isValid ( ) const

Returns if the object represents a valid action.

Action names have to respect a simple syntax. They have to be all in lowercase characters, separated by dots. Dots can't appear at the beginning and at the end of the name.

In other words, the action name has to match this perl-like regular expression:


This method returns false if the action name doesn't match the valid syntax.

If the backend supports it, this method also checks if the action is valid and recognized by the backend itself.

This may spawn a nested event loop.

Invalid actions cannot be authorized nor executed. The empty string is not a valid action name, so the default constructor returns an invalid action.

Definition at line 134 of file action.cpp.

◆ name()

QString Action::name ( ) const

Gets the action's name.

This is the unique attribute that identifies an action object. Two action objects with the same name always refer to the same action.

The action name

Definition at line 103 of file action.cpp.

◆ operator!=()

bool Action::operator!= ( const Action & action) const

Negated comparison operator.

Returns the negation of operator==

true if the two actions are different and not both invalid

Definition at line 97 of file action.cpp.

◆ operator=()

Action & Action::operator= ( const Action & action)

Assignment operator.

Definition at line 81 of file action.cpp.

◆ operator==()

bool Action::operator== ( const Action & action) const

Comparison operator.

This comparison operator compares the names of two actions and returns whether they are the same. It does not care about the arguments stored in the actions. However, if two actions are invalid they'll match as equal, even if the invalid names are different.

true if the two actions are the same or both invalid

Definition at line 92 of file action.cpp.

◆ parentWindow()

QWindow * Action::parentWindow ( ) const

Returns the parent widget for the authentication dialog for this action.

A QWindow which will is being used as the dialog's parent

Definition at line 170 of file action.cpp.

◆ setArguments()

void Action::setArguments ( const QVariantMap & arguments)

Sets the map object used to pass arguments to the helper.

This method sets the variant map that the application can use to pass arbitrary data to the helper when executing the action.

Only non-gui variants are supported.

argumentsThe new arguments map

Definition at line 139 of file action.cpp.

◆ setDetailsV2()

void Action::setDetailsV2 ( const DetailsMap & details)

Sets the action's details.

You can use this function to provide the user more details (if the backend supports it) on the action being authorized in the authorization dialog

detailsthe details describing the action. For e.g, "DetailMessage" key can be used to give a customized authentication message.

Definition at line 129 of file action.cpp.

◆ setHelperId()

void Action::setHelperId ( const QString & id)

Sets the default helper ID used for actions execution.

This method sets the helper ID which contains the body of this action. If the string is non-empty, the corresponding helper will be fired and the action executed inside the helper. Otherwise, the action will be just authorized.

To unset a previously set helper, just pass an empty string
idThe default helper ID.
See also

Definition at line 160 of file action.cpp.

◆ setName()

void Action::setName ( const QString & name)

Sets the action's name.

It's not common to change the action name after its creation. Usually you set the name with the constructor (and you have to, because there's no default constructor)

Definition at line 108 of file action.cpp.

◆ setParentWindow()

void Action::setParentWindow ( QWindow * parent)

Sets a parent window for the authentication dialog.

This function is used for explicitly setting a parent window for an eventual authentication dialog required when authorization is triggered. Some backends, in fact, (like polkit-1) need to have a parent explicitly set for displaying the dialog correctly.

If you are using KAuth through one of KDE's GUI components (KPushButton, KCModule...) you do not need and should not call this function, as it is already done by the component itself.
parentA QWidget which will be used as the dialog's parent

Definition at line 165 of file action.cpp.

◆ setTimeout()

void Action::setTimeout ( int timeout)

Sets the action's timeout.

The timeout of the action in milliseconds -1 means the default D-Bus timeout (usually 25 seconds)


Definition at line 119 of file action.cpp.

◆ status()

Action::AuthStatus Action::status ( ) const

Gets information about the authorization status of an action.

This methods query the authorization backend to know if the user can try to acquire the authorization for this action. If the result is Action::AuthRequired, the user can try to acquire the authorization by authenticating.

It should not be needed to call this method directly, because the execution methods already take care of all the authorization stuff.

Action::Denied if the user doesn't have the authorization to execute the action, Action::Authorized if the action can be executed, Action::AuthRequired if the user could acquire the authorization after authentication, Action::UserCancelled if the user cancels the authentication dialog. Not currently supported by the Polkit backend

Definition at line 175 of file action.cpp.

◆ timeout()

int Action::timeout ( ) const

Gets the action's timeout.

The timeout of the action in milliseconds -1 means the default D-Bus timeout (usually 25 seconds)

The action timeouts

Definition at line 114 of file action.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:55:02 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.