KAuth.Action

KDE 4.7 PyKDE API Reference

- KDE's Python API

# Action Class Reference

`from PyKDE4.kdecore import *`

Namespace: KAuth

## 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 one of the execute*() methods. The simplest thing to do is to execute a single action synchronously blocking for the reply, using the execute() method.

For asynchronous calls, use the executeAsync() method. It sends the request to the helper and returns immediately. You can optionally provide an object and a slot. This will be connected to the actionPerformed() signal of the action's ActionWatcher object. By calling the watcher() method, you obtain an object that emits some useful signals that you can receive while the action is in progress. Those signals are emitted also with the synchronous calls. To execute a bunch of actions with a single call, you can use the executeActions() static method. This is not the same as calling executeAsync() for each action, because the actions are execute with a single request to the helper. To use any of the execute*() methods 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.

Since:
  4.4

## Enumerations
AuthStatus | { Denied, Error, Invalid, Authorized, AuthRequired, UserCancelled }
## Methods
| __init__ (self)
| __init__ (self, KAuth.Action action)
| __init__ (self, QString name)
| __init__ (self, QString name, QString details)
| addArgument (self, QString key, QVariant value)
{QString:QVariant} | arguments (self)
KAuth.Action.AuthStatus | authorize (self)
QString | details (self)
KAuth.Action.AuthStatus | earlyAuthorize (self)
KAuth.ActionReply | execute (self)
KAuth.ActionReply | execute (self, QString helperID)
bool | executesAsync (self)
bool | hasHelper (self)
QString | helperID (self)
bool | isValid (self)
QString | name (self)
bool | operator != (self, KAuth.Action action)
bool | operator == (self, KAuth.Action action)
QWidget | parentWidget (self)
| setArguments (self, {QString:QVariant} arguments)
| setDetails (self, QString details)
| setExecutesAsync (self, bool async)
| setHelperID (self, QString id)
| setName (self, QString name)
| setParentWidget (self, QWidget parent)
KAuth.Action.AuthStatus | status (self)
| stop (self)
| stop (self, QString helperID)
KAuth.ActionWatcher | watcher (self)
## Static Methods
bool | executeActions ([KAuth.Action] actions, [KAuth.Action] deniedActions, QString helperId)
bool | executeActions ([KAuth.Action] actions, [KAuth.Action] deniedActions, QString helperId, QWidget parent)

## Method Documentation

__init__ | ( |  | self ) |

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.

__init__ | ( | self, |
|  | KAuth.Action | action
| ) |  |  |

Copy constructor

__init__ | ( | self, |
|  | QString | name
| ) |  |  |

This creates a new action object with this name

Parameters:

  | name | The name of the new action

__init__ | ( | self, |
|  | QString | name,
|  | QString | details
| ) |  |  |

This creates a new action object with this name and details

Parameters:

  | name | The name of the new action
  | details | The details of the action

See also:
  setDetails

addArgument | ( | self, |
|  | QString | key,
|  | 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.

Parameters:

  | key | The new entry's key
  | value | The value of the new entry

{QString:QVariant} arguments | ( |  | self ) |

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.

Returns:
  The arguments map that will be passed to the helper.

KAuth.Action.AuthStatus authorize | ( |  | self ) |

Acquires authorization for an action without excuting it.

Note:
  Please use this method if you really know what you are doing. If you are implementing a GUI, you probably should look into earlyAuthorize instead.

Note:
  Please remember that calling this method is not required for a successful action execution: it is safe and advised to call execute() only, without a previous call to authorize or earlyAuthorize.

This method acquires the authorization rights for the action, asking the user to authenticate if needed. It tries very hard to resolve a possible challenge (AuthRequired); for this reason, it is meant only for advanced usages. If you are unsure, always use earlyAuthorize or execute the action directly.

Returns:
  The result of the authorization process

See also:
  earlyAuthorize

QString details | ( |  | self ) |

Gets the action's details

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

Returns:
  The action's details

KAuth.Action.AuthStatus earlyAuthorize | ( |  | self ) |

Tries to resolve authorization status in the best possible way without executing the action

This method checks for the status of the action, and tries to acquire authorization (if needed) if the backend being used supports client-side authorization.

This means this method is not reliable - its purpose is to provide user interfaces with an efficient means to acquire authorization as early as possible, without interrupting the user's workflow. If the backend's authentication phase happens in the helper and the action requires authentication, Authorized will be returned.

The main difference with authorize is that this method does not try to acquire authorization if the backend's authentication phase happens in the helper: using authorize in such a case might lead to ask the user its password twice, as the helper might time out, or in the case of a one shot authorization, the scope of the authorization would end with the authorization check itself. For this reason, you should always use this method instead of authorize, which is meant only for very advanced usages.

This method is always safe to be called and used before an execution, even if not needed.

Since:
  4.5

Returns:
  The result of the early authorization process, with the caveats described above.

KAuth.ActionReply execute | ( |  | self ) |

Synchronously executes the action with a specific helperID

This method does the exact same thing as execute(), but it takes a specific helperID, useful if you don't want to use the default one without changing it with setHelperID()

Parameters:

  | helperID | The helper ID to use for the execution of this action

Returns:
  The reply from the helper, or an error if something's wrong.

KAuth.ActionReply execute | ( | self, |
|  | QString | helperID
| ) |  |  |

Synchronously executes the action with a specific helperID

This method does the exact same thing as execute(), but it takes a specific helperID, useful if you don't want to use the default one without changing it with setHelperID()

Parameters:

  | helperID | The helper ID to use for the execution of this action

Returns:
  The reply from the helper, or an error if something's wrong.

bool executesAsync | ( |  | self ) |

bool hasHelper | ( |  | self ) |

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.

Since:
  4.5

Returns:
  Whether the action has an helper or not

See also:
  setHelperID

QString helperID | ( |  | self ) |

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 KDE4_AUTH_HELPER() 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.

Returns:
  The default helper ID.

bool isValid | ( |  | self ) |

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: @verbatim /^[a-z]+(\.[a-z]+)*$/ @endverbatim

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 name | ( |  | self ) |

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.

Returns:
  The action name

bool operator != | ( | self, |
|  | KAuth.Action | action
| ) |  |  |

Negated comparison operator

Returns the negation of operator==

Returns:
  true if the two actions are different and not both invalid

bool operator == | ( | self, |
|  | KAuth.Action | action
| ) |  |  |

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.

Returns:
  true if the two actions are the same or both invalid

QWidget parentWidget | ( |  | self ) |

Returns the parent widget for the authentication dialog for this action

Since:
  4.6

Returns:
  A QWidget which will is being used as the dialog's parent

setArguments | ( | self, |
|  | {QString:QVariant} | 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.

Parameters:

  | arguments | The new arguments map

setDetails | ( | self, |
|  | 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

setExecutesAsync | ( | self, |
|  | bool | async
| ) |  |  |

setHelperID | ( | self, |
|  | 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.

Note:
  To unset a previously set helper, just pass an empty string

Parameters:

  | id | The default helper ID.

See also:
  hasHelper

See also:
  helperID

setName | ( | self, |
|  | 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)

setParentWidget | ( | self, |
|  | 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.

Note:
  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.

Since:
  4.6

Parameters:

  | parent | A QWidget which will be used as the dialog's parent

KAuth.Action.AuthStatus status | ( |  | self ) |

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.

Returns:
  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

stop | ( |  | self ) |

Ask the helper to stop executing an action, using a specific helper ID

This method works exactly as the stop() method, but it lets you specify an helper ID different from the default one.

To stop an action you need to send the stop request to the helper that is executing that action. This of course means you have to use the same helperID used for the execution call (either passed as a parameter or set as default with setHelperID() )

stop | ( | self, |
|  | QString | helperID
| ) |  |  |

Ask the helper to stop executing an action, using a specific helper ID

This method works exactly as the stop() method, but it lets you specify an helper ID different from the default one.

To stop an action you need to send the stop request to the helper that is executing that action. This of course means you have to use the same helperID used for the execution call (either passed as a parameter or set as default with setHelperID() )

KAuth.ActionWatcher watcher | ( |  | self ) |

Gets the ActionWatcher object for this action

ActionWatcher objects are used to get notifications about the action execution status. Every action watcher is tied to an action and every action has a watcher. This means that if you call this method on two different Action objects with the same name, you'll get the same watcher object.

Returns:
  The action watcher for this action

## Static Method Documentation

bool executeActions | ( | [KAuth.Action] | actions,
|  | [KAuth.Action] | deniedActions,
|  | QString | helperId
| ) |  |  |

Convenience overload. This overload lets you specify, in addition, a QWidget which will be used as the authentication dialog's parent.

Since:
  4.6

See also:
  executeActions

See also:
  setParentWidget

bool executeActions | ( | [KAuth.Action] | actions,
|  | [KAuth.Action] | deniedActions,
|  | QString | helperId,
|  | QWidget | parent
| ) |  |  |

Convenience overload. This overload lets you specify, in addition, a QWidget which will be used as the authentication dialog's parent.

Since:
  4.6

See also:
  executeActions

See also:
  setParentWidget

## Enumeration Documentation

AuthStatus

The three values returned by authorization methods

Enumerator:

  Denied |
  Error |
  Invalid |
  Authorized |
  AuthRequired |
  UserCancelled |