KAuth 5.109.0
|
Class to access, authorize and execute actions. More...
#include <KAuth/Action>
Public Types | |
enum class | AuthDetail { DetailOther = 0 , DetailMessage } |
The backend specific details. More... | |
enum | AuthStatus { DeniedStatus , ErrorStatus , InvalidStatus , AuthorizedStatus , AuthRequiredStatus , UserCancelledStatus } |
The three values set by authorization methods. More... | |
typedef QMap< AuthDetail, QVariant > | DetailsMap |
Map of details. | |
enum | ExecutionMode { ExecuteMode , AuthorizeOnlyMode } |
Public Member Functions | |
Action () | |
Default constructor. | |
Action (const Action &action) | |
Copy constructor. | |
Action (const QString &name) | |
This creates a new action object with this name. | |
Action (const QString &name, const DetailsMap &details) | |
This creates a new action object with this name and details. | |
Action (const QString &name, const QString &details) | |
This creates a new action object with this name and details. | |
~Action () | |
Virtual destructor. | |
void | addArgument (const QString &key, const QVariant &value) |
Convenience method to add an argument. | |
QVariantMap | arguments () const |
Returns map object used to pass arguments to the helper. | |
QString | details () const |
Gets the action's details. | |
DetailsMap | detailsV2 () const |
Gets the action's details. | |
ExecuteJob * | execute (ExecutionMode mode=ExecuteMode) |
Get the job object used to execute the action. | |
bool | hasHelper () const |
Checks if the action has an helper. | |
QString | helperId () const |
Gets the default helper ID used for actions execution. | |
bool | isValid () const |
Returns if the object represents a valid action. | |
QString | name () const |
Gets the action's name. | |
bool | operator!= (const Action &action) const |
Negated comparison operator. | |
Action & | operator= (const Action &action) |
Assignment operator. | |
bool | operator== (const Action &action) const |
Comparison operator. | |
QWidget * | parentWidget () const |
Returns the parent widget for the authentication dialog for this action. | |
void | setArguments (const QVariantMap &arguments) |
Sets the map object used to pass arguments to the helper. | |
void | setDetails (const QString &details) |
Sets the action's details. | |
void | setDetailsV2 (const DetailsMap &details) |
Sets the action's details. | |
void | setHelperId (const QString &id) |
Sets the default helper ID used for actions execution. | |
void | setName (const QString &name) |
Sets the action's name. | |
void | setParentWidget (QWidget *parent) |
Sets a parent widget for the authentication dialog. | |
void | setTimeout (int timeout) |
Sets the action's timeout. | |
AuthStatus | status () const |
Gets information about the authorization status of an action. | |
int | timeout () const |
Gets the action's timeout. | |
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.
typedef QMap<AuthDetail, QVariant> KAuth::Action::DetailsMap |
Map of details.
|
strong |
The three values set by authorization methods.
KAuth::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.
KAuth::Action::Action | ( | const Action & | action | ) |
Copy constructor.
KAuth::Action::Action | ( | const QString & | name | ) |
This creates a new action object with this name.
name | The name of the new action |
KAuth::Action::Action | ( | const QString & | name, |
const QString & | details | ||
) |
This creates a new action object with this name and details.
name | The name of the new action |
details | The details of the action |
KAuth::Action::Action | ( | const QString & | name, |
const DetailsMap & | details | ||
) |
This creates a new action object with this name and details.
name | The name of the new action |
details | The details of the action |
KAuth::Action::~Action | ( | ) |
Virtual destructor.
void KAuth::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.
key | The new entry's key |
value | The value of the new entry |
QVariantMap KAuth::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.
QString KAuth::Action::details | ( | ) | const |
Gets the action's details.
The details that will be shown in the authorization dialog, if the backend supports it.
DetailsMap KAuth::Action::detailsV2 | ( | ) | const |
Gets the action's details.
The details that will be shown in the authorization dialog, if the backend supports it.
ExecuteJob * KAuth::Action::execute | ( | ExecutionMode | mode = ExecuteMode | ) |
Get the job object used to execute the action.
bool KAuth::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.
QString KAuth::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.
bool KAuth::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.
Invalid actions cannot be authorized nor executed. The empty string is not a valid action name, so the default constructor returns an invalid action.
QString KAuth::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.
bool KAuth::Action::operator!= | ( | const Action & | action | ) | const |
Negated comparison operator.
Returns the negation of operator==
bool KAuth::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.
QWidget * KAuth::Action::parentWidget | ( | ) | const |
Returns the parent widget for the authentication dialog for this action.
void KAuth::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.
arguments | The new arguments map |
void KAuth::Action::setDetails | ( | const QString & | 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
void KAuth::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
details | the details describing the action. For e.g, "DetailMessage" key can be used to give a customized authentication message. |
void KAuth::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.
id | The default helper ID. |
void KAuth::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)
void KAuth::Action::setParentWidget | ( | QWidget * | parent | ) |
Sets a parent widget 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.
parent | A QWidget which will be used as the dialog's parent |
void KAuth::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)
AuthStatus KAuth::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 int KAuth::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)