PkPolkitClient

PkPolkitClient — Provides a nice GObject to get a PolKit action auth

Synopsis




                    PkPolkitClientPrivate;
                    PkPolkitClient;
PkPolkitClient*     pk_polkit_client_new                (void);
gboolean            pk_polkit_client_gain_privilege     (PkPolkitClient *pclient,
                                                         const gchar *pk_action);
gboolean            pk_polkit_client_gain_privilege_str (PkPolkitClient *pclient,
                                                         const gchar *error_str);
gboolean            pk_polkit_client_error_denied_by_policy
                                                        (GError *error);

Object Hierarchy


  GObject
   +----PkPolkitClient

Description

This file contains functions that can be used for authorising a PolKit action.

Details

PkPolkitClientPrivate

typedef struct _PkPolkitClientPrivate PkPolkitClientPrivate;

Private PkPolkitClient data


PkPolkitClient

typedef struct _PkPolkitClient PkPolkitClient;


pk_polkit_client_new ()

PkPolkitClient*     pk_polkit_client_new                (void);

Returns :


pk_polkit_client_gain_privilege ()

gboolean            pk_polkit_client_gain_privilege     (PkPolkitClient *pclient,
                                                         const gchar *pk_action);

This function is indented to be used by client tools to gain extra privileges needed to do extra functionality.

pclient :

a valid PkPolkitClient instance

pk_action :

a PolicyKit action description, e.g. "org.freedesktop.packagekit.installfile"

Returns :

if we gained the privilege we asked for

pk_polkit_client_gain_privilege_str ()

gboolean            pk_polkit_client_gain_privilege_str (PkPolkitClient *pclient,
                                                         const gchar *error_str);

This function is indented to be passed failure messages from dbus methods so that extra auth can be requested.

pclient :

a valid PkPolkitClient instance

error_str :

the raw output error, e.g. "org.freedesktop.packagekit.installfile no"

Returns :

if we gained the privilege we asked for

pk_polkit_client_error_denied_by_policy ()

gboolean            pk_polkit_client_error_denied_by_policy
                                                        (GError *error);

error :

a valid GError

Returns :

TRUE if the error is the PolicyKit "RefusedByPolicy"