PolkitQt1::ActionDescription

Search for usage in LXR

PolkitQt1::ActionDescription Class Reference

#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 (const ActionDescription &other)
 
 ActionDescription (PolkitActionDescription *actionDescription)
 
QString actionId () const
 
QString description () const
 
QString iconName () const
 
ActionDescription::ImplicitAuthorization implicitActive () const
 
ActionDescription::ImplicitAuthorization implicitAny () const
 
ActionDescription::ImplicitAuthorization implicitInactive () const
 
QString message () const
 
ActionDescriptionoperator= (const ActionDescription &other)
 
QString vendorName () const
 
QString vendorUrl () const
 

Detailed Description

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.

Definition at line 32 of file polkitqt1-actiondescription.h.

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

Definition at line 55 of file polkitqt1-actiondescription.cpp.

Member Function Documentation

◆ actionId()

QString PolkitQt1::ActionDescription::actionId ( ) const

Gets the action id for ActionDescription.

Returns
id of the action

Definition at line 88 of file polkitqt1-actiondescription.cpp.

◆ description()

QString PolkitQt1::ActionDescription::description ( ) const

Gets the description used for ActionDescription.

Returns
description of the action

Definition at line 93 of file polkitqt1-actiondescription.cpp.

◆ 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

Definition at line 113 of file polkitqt1-actiondescription.cpp.

◆ 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

Definition at line 128 of file polkitqt1-actiondescription.cpp.

◆ implicitAny()

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

Gets the implicit authorization for ActionDescription used for any subject.

Returns
A value from ImplicitAuthorization enumeration

Definition at line 118 of file polkitqt1-actiondescription.cpp.

◆ 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

Definition at line 123 of file polkitqt1-actiondescription.cpp.

◆ message()

QString PolkitQt1::ActionDescription::message ( ) const

Gets the message used for ActionDescription.

Returns
action message

Definition at line 98 of file polkitqt1-actiondescription.cpp.

◆ vendorName()

QString PolkitQt1::ActionDescription::vendorName ( ) const

Gets the vendor name for ActionDescription, if any.

Returns
vendor name

Definition at line 103 of file polkitqt1-actiondescription.cpp.

◆ 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

Definition at line 108 of file polkitqt1-actiondescription.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Tue Aug 16 2022 04:02:58 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.