PkControl: PackageKit Reference Manual

## PkControl PkControl — For querying data about PackageKit |

## Functions

GQuark | pk_control_error_quark ()
PkControl * | pk_control_new ()
void | pk_control_test ()
void | pk_control_get_tid_async ()
gchar * | pk_control_get_tid_finish ()
void | pk_control_suggest_daemon_quit_async ()
gboolean | pk_control_suggest_daemon_quit_finish ()
void | pk_control_get_daemon_state_async ()
gchar * | pk_control_get_daemon_state_finish ()
void | pk_control_set_proxy_async ()
void | pk_control_set_proxy2_async ()
gboolean | pk_control_set_proxy_finish ()
void | pk_control_get_time_since_action_async ()
guint | pk_control_get_time_since_action_finish ()
void | pk_control_get_transaction_list_async ()
gchar ** | pk_control_get_transaction_list_finish ()
void | pk_control_can_authorize_async ()
PkAuthorizeEnum | pk_control_can_authorize_finish ()
void | pk_control_get_properties_async ()
gboolean | pk_control_get_properties_finish ()

## Properties

gchar * | backend-author | Read / Write
gchar * | backend-description | Read / Write
gchar * | backend-name | Read / Write
gboolean | connected | Read / Write
gchar * | distro-id | Read / Write
guint64 | filters | Read / Write
guint64 | groups | Read / Write
gboolean | locked | Read / Write
GStrv | mime-types | Read / Write
PkNetworkEnum | network-state | Read / Write
guint64 | provides | Read / Write
guint64 | roles | Read / Write
guint | version-major | Read
guint | version-micro | Read
guint | version-minor | Read

## Signals

void | repo-list-changed | Run Last
void | restart-schedule | Run Last
void | transaction-list-changed | Run Last
void | updates-changed | Run Last

## Types and Values

#define | PK_CONTROL_ERROR
#define | PK_CONTROL_TYPE_ERROR
enum | PkControlError

## Object Hierarchy

        GEnum
        ╰── PkControlError
        GObject
        ╰── PkControl

## Description

A GObject to use for accessing PackageKit asynchronously.

## Functions

### pk_control_error_quark ()

    GQuark
    pk_control_error_quark (void);

We are a GObject that sets errors

#### Returns

Our personal error quark.

Since: 0.5.2

### pk_control_new ()

    PkControl *
    pk_control_new (void);

#### Returns

a new PkControl object.

Since: 0.5.2

### pk_control_test ()

    void
    pk_control_test (gpointer user_data);

### pk_control_get_tid_async ()

    void
    pk_control_get_tid_async (PkControl *control,
                              GCancellable *cancellable,
                              GAsyncReadyCallback callback,
                              gpointer user_data);

Gets a transacton ID from the daemon.

#### Parameters

control | a valid PkControl instance |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_get_tid_finish ()

    gchar *
    pk_control_get_tid_finish (PkControl *control,
                               GAsyncResult *res,
                               GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

the ID, or `NULL` if unset, free with `g_free()`

Since: 0.5.2

### pk_control_suggest_daemon_quit_async ()

    void
    pk_control_suggest_daemon_quit_async (PkControl *control,
                                          GCancellable *cancellable,
                                          GAsyncReadyCallback callback,
                                          gpointer user_data);

Suggests to the daemon that it should quit as soon as possible.

#### Parameters

control | a valid PkControl instance |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.6.2

### pk_control_suggest_daemon_quit_finish ()

    gboolean
    pk_control_suggest_daemon_quit_finish (PkControl *control,
                                           GAsyncResult *res,
                                           GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

`TRUE` if the suggestion was sent

Since: 0.6.2

### pk_control_get_daemon_state_async ()

    void
    pk_control_get_daemon_state_async (PkControl *control,
                                       GCancellable *cancellable,
                                       GAsyncReadyCallback callback,
                                       gpointer user_data);

Gets the debugging state from the daemon.

#### Parameters

control | a valid PkControl instance |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_get_daemon_state_finish ()

    gchar *
    pk_control_get_daemon_state_finish (PkControl *control,
                                        GAsyncResult *res,
                                        GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

the ID, or `NULL` if unset, free with `g_free()`

Since: 0.5.2

### pk_control_set_proxy_async ()

    void
    pk_control_set_proxy_async (PkControl *control,
                                const gchar *proxy_http,
                                const gchar *proxy_ftp,
                                GCancellable *cancellable,
                                GAsyncReadyCallback callback,
                                gpointer user_data);

Set a proxy on the PK daemon

NOTE: This is just provided for backwards compatibility. Clients should really be using `pk_control_set_proxy2_async()`.

#### Parameters

control | a valid PkControl instance |
proxy_http | a HTTP proxy string such as "username:password`server.lan` :8080" |
proxy_ftp | a FTP proxy string such as "server.lan:8080" |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_set_proxy2_async ()

    void
    pk_control_set_proxy2_async (PkControl *control,
                                 const gchar *proxy_http,
                                 const gchar *proxy_https,
                                 const gchar *proxy_ftp,
                                 const gchar *proxy_socks,
                                 const gchar *no_proxy,
                                 const gchar *pac,
                                 GCancellable *cancellable,
                                 GAsyncReadyCallback callback,
                                 gpointer user_data);

Set a proxy on the PK daemon

#### Parameters

control | a valid PkControl instance |
proxy_http | a HTTP proxy string such as "username:password`server.lan` :8080", or `NULL` |
proxy_https | a HTTPS proxy string such as "username:password`server.lan` :8080", or `NULL` |
proxy_ftp | a FTP proxy string such as "server.lan:8080", or `NULL` |
proxy_socks | a SOCKS proxy string such as "server.lan:8080", or `NULL` |
no_proxy | a list of download IPs that shouldn't go through the proxy, or `NULL` |
pac | a PAC string, or `NULL` |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.6.13

### pk_control_set_proxy_finish ()

    gboolean
    pk_control_set_proxy_finish (PkControl *control,
                                 GAsyncResult *res,
                                 GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

`TRUE` if we set the proxy successfully

Since: 0.5.2

### pk_control_get_time_since_action_async ()

    void
    pk_control_get_time_since_action_async
                                   (PkControl *control,
                                    PkRoleEnum role,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

We may want to know how long it has been since we refreshed the cache or retrieved the update list.

#### Parameters

control | a valid PkControl instance |
role | the role enum, e.g. `PK_ROLE_ENUM_GET_UPDATES` |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_get_time_since_action_finish ()

    guint
    pk_control_get_time_since_action_finish
                                   (PkControl *control,
                                    GAsyncResult *res,
                                    GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

`TRUE` if the daemon serviced the request

Since: 0.5.2

### pk_control_get_transaction_list_async ()

    void
    pk_control_get_transaction_list_async (PkControl *control,
                                           GCancellable *cancellable,
                                           GAsyncReadyCallback callback,
                                           gpointer user_data);

Gets the transactions currently running in the daemon.

#### Parameters

control | a valid PkControl instance |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_get_transaction_list_finish ()

    gchar **
    pk_control_get_transaction_list_finish
                                   (PkControl *control,
                                    GAsyncResult *res,
                                    GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

A GStrv list of transaction ID's, free with `g_strfreev()`.

[transfer full]

Since: 0.5.2

### pk_control_can_authorize_async ()

    void
    pk_control_can_authorize_async (PkControl *control,
                                    const gchar *action_id,
                                    GCancellable *cancellable,
                                    GAsyncReadyCallback callback,
                                    gpointer user_data);

We may want to know before we run a method if we are going to be denied, accepted or challenged for authentication.

#### Parameters

control | a valid PkControl instance |
action_id | The action ID, for instance "org.freedesktop.PackageKit.install-untrusted" |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_can_authorize_finish ()

    PkAuthorizeEnum
    pk_control_can_authorize_finish (PkControl *control,
                                     GAsyncResult *res,
                                     GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

the `PkAuthorizeEnum` or `PK_AUTHORIZE_ENUM_UNKNOWN` if the method failed

Since: 0.5.2

### pk_control_get_properties_async ()

    void
    pk_control_get_properties_async (PkControl *control,
                                     GCancellable *cancellable,
                                     GAsyncReadyCallback callback,
                                     gpointer user_data);

Gets global properties from the daemon.

#### Parameters

control | a valid PkControl instance |
cancellable | a GCancellable or `NULL` |
callback | the function to run on completion |
user_data | the data to pass to `callback` |

Since: 0.5.2

### pk_control_get_properties_finish ()

    gboolean
    pk_control_get_properties_finish (PkControl *control,
                                      GAsyncResult *res,
                                      GError **error);

Gets the result from the asynchronous function.

#### Parameters

control | a valid PkControl instance |
res | the GAsyncResult |
error | A GError or `NULL` |

#### Returns

`TRUE` if we set the proxy successfully

Since: 0.5.2

## Types and Values

### PK_CONTROL_ERROR

    #define PK_CONTROL_ERROR (pk_control_error_quark ())

### PK_CONTROL_TYPE_ERROR

    #define PK_CONTROL_TYPE_ERROR (pk_control_error_get_type ())

### enum PkControlError

Errors that can be thrown

#### Members

PK_CONTROL_ERROR_FAILED | the transaction failed for an unknown reason |
PK_CONTROL_ERROR_CANNOT_START_DAEMON |  |

## Property Details

### The `“backend-author”` property

      “backend-author”           gchar *

Flags: Read / Write

Default value: NULL

Since: 0.5.2

### The `“backend-description”` property

      “backend-description”      gchar *

Flags: Read / Write

Default value: NULL

Since: 0.5.2

### The `“backend-name”` property

      “backend-name”             gchar *

Flags: Read / Write

Default value: NULL

Since: 0.5.2

### The `“connected”` property

      “connected”                gboolean

Flags: Read / Write

Default value: FALSE

Since: 0.5.3

### The `“distro-id”` property

      “distro-id”                gchar *

Flags: Read / Write

Default value: NULL

Since: 0.5.5

### The `“filters”` property

      “filters”                  guint64

Flags: Read / Write

Default value: 0

Since: 0.5.2

### The `“groups”` property

      “groups”                   guint64

Flags: Read / Write

Default value: 0

Since: 0.5.2

### The `“locked”` property

      “locked”                   gboolean

Flags: Read / Write

Default value: FALSE

Since: 0.5.3

### The `“mime-types”` property

      “mime-types”               GStrv

Flags: Read / Write

Since: 0.8.1

### The `“network-state”` property

      “network-state”            PkNetworkEnum

Flags: Read / Write

Default value: PK_NETWORK_ENUM_LAST

Since: 0.5.3

### The `“provides”` property

      “provides”                 guint64

Flags: Read / Write

Default value: 0

Since: 0.8.8

### The `“roles”` property

      “roles”                    guint64

Flags: Read / Write

Default value: 0

Since: 0.5.2

### The `“version-major”` property

      “version-major”            guint

Flags: Read

Default value: 0

Since: 0.5.2

### The `“version-micro”` property

      “version-micro”            guint

Flags: Read

Default value: 0

Since: 0.5.2

### The `“version-minor”` property

      “version-minor”            guint

Flags: Read

Default value: 0

Since: 0.5.2

## Signal Details

### The `“repo-list-changed”` signal

    void
    user_function (PkControl *control,
                   gpointer   user_data)

The ::repo-list-changed signal is emitted when the repo list may have changed and the control program may have to update some UI.

#### Parameters

control | the PkControl instance that emitted the signal |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“restart-schedule”` signal

    void
    user_function (PkControl *control,
                   gpointer   user_data)

The ::restart_schedule signal is emitted when the packagekitd service has been restarted because it has been upgraded. Client programs should reload themselves when it is convenient to do so, as old client tools may not be compatable with the new daemon.

#### Parameters

control | the PkControl instance that emitted the signal |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“transaction-list-changed”` signal

    void
    user_function (PkControl *control,
                   GStrv      transaction_ids,
                   gpointer   user_data)

The ::transaction-list-changed signal is emitted when the list of transactions handled by the daemon is changed.

#### Parameters

control | the PkControl instance that emitted the signal |
transaction_ids | an GStrv array of transaction ID's |
user_data | user data set when the signal handler was connected. |

Flags: Run Last

### The `“updates-changed”` signal

    void
    user_function (PkControl *control,
                   gpointer   user_data)

The ::updates-changed signal is emitted when the update list may have changed and the control program may have to update some UI.

#### Parameters

control | the PkControl instance that emitted the signal |
user_data | user data set when the signal handler was connected. |

Flags: Run Last