Polkit-Qt-1  0.95.0
Public Types | Public Member Functions
PolkitQt1::ActionDescription Class Reference

Class used to encapsulate a registered action. More...

#include <ActionDescription>

Public Types

enum  ImplicitAuthorization {
  Unknown = -1, NotAuthorized = 0, AuthenticationRequired = 1, AdministratorAuthenticationRequired = 2,
  AuthenticationRequiredRetained = 3, AdministratorAuthenticationRequiredRetained = 4, Authorized = 5
}
 
typedef QList< ActionDescriptionList
 

Public Member Functions

 ActionDescription (PolkitActionDescription *actionDescription)
 Constructor of ActionDescription object from PolkitActionDescription. More...
 
 ActionDescription (const ActionDescription &other)
 
ActionDescriptionoperator= (const ActionDescription &other)
 
QString actionId () const
 Gets the action id for ActionDescription. More...
 
QString description () const
 Gets the description used of ActionDescription. More...
 
QString message () const
 Gets the message user for ActionDescription. More...
 
QString vendorName () const
 Gets the vendor name for ActionDescription, if any. More...
 
QString vendorUrl () const
 Gets the vendor URL for ActionDescription, if any. More...
 
QString iconName () const
 Gets the icon name for ActionDescription, if any. More...
 
ActionDescription::ImplicitAuthorization implicitAny () const
 Gets the implicit authorization for ActionDescription used for any subject. More...
 
ActionDescription::ImplicitAuthorization implicitInactive () const
 Gets the implicit authorization for ActionDescription used for subjects in inactive session on a local console. More...
 
ActionDescription::ImplicitAuthorization implicitActive () const
 Gets the implicit authorization for ActionDescription used for subjects in active session on a local console. More...
 

Detailed Description

Class used to encapsulate a registered action.

Author
Jaroslav Reznik jrezn.nosp@m.ik@r.nosp@m.edhat.nosp@m..com
Dario Freddi drf@k.nosp@m.de.o.nosp@m.rg

Member Enumeration Documentation

◆ ImplicitAuthorization

Enumerator
Unknown 

Unknown whether the subject is authorized, never returned in any public API.

NotAuthorized 

Subject is not authorized.

AuthenticationRequired 

Authentication is required.

AdministratorAuthenticationRequired 

Authentication as an administrator is required.

AuthenticationRequiredRetained 

Authentication is required. If the authorization is obtained, it is retained.

AdministratorAuthenticationRequiredRetained 

Authentication as an administrator is required. If the authorization is obtained, it is retained.

Authorized 

The subject is authorized.

Constructor & Destructor Documentation

◆ ActionDescription()

PolkitQt1::ActionDescription::ActionDescription ( PolkitActionDescription *  actionDescription)
explicit

Constructor of ActionDescription object from PolkitActionDescription.

Warning
Use this only if you are completely aware of what are you doing!
Parameters
actionDesciptionPolkitActionDescription

Member Function Documentation

◆ actionId()

QString PolkitQt1::ActionDescription::actionId ( ) const

Gets the action id for ActionDescription.

Returns
id of the action

◆ description()

QString PolkitQt1::ActionDescription::description ( ) const

Gets the description used of ActionDescription.

Returns
description of the action

◆ iconName()

QString PolkitQt1::ActionDescription::iconName ( ) const

Gets the icon name for ActionDescription, if any.

Returns
icon name or empty QString if there is no icon

◆ implicitActive()

ActionDescription::ImplicitAuthorization PolkitQt1::ActionDescription::implicitActive ( ) const

Gets the implicit authorization for ActionDescription used for subjects in active session on a local console.

Returns
A value from ImplicitAuthorization enumeration

◆ implicitAny()

ActionDescription::ImplicitAuthorization PolkitQt1::ActionDescription::implicitAny ( ) const

Gets the implicit authorization for ActionDescription used for any subject.

Returns
A value from ImplicitAuthorization enumeration

◆ implicitInactive()

ActionDescription::ImplicitAuthorization PolkitQt1::ActionDescription::implicitInactive ( ) const

Gets the implicit authorization for ActionDescription used for subjects in inactive session on a local console.

Returns
A value from ImplicitAuthorization enumeration

◆ message()

QString PolkitQt1::ActionDescription::message ( ) const

Gets the message user for ActionDescription.

Returns
action message

◆ vendorName()

QString PolkitQt1::ActionDescription::vendorName ( ) const

Gets the vendor name for ActionDescription, if any.

Returns
vendor name

◆ vendorUrl()

QString PolkitQt1::ActionDescription::vendorUrl ( ) const

Gets the vendor URL for ActionDescription, if any.

Returns
vendor URL or empty QString if there is no vendor URL

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