PkClient

PkClient — For creating new transactions

Functions

GQuark pk_client_error_quark ()
PkClient * pk_client_new ()
PkResults * pk_client_generic_finish ()
PkResults * pk_client_resolve ()
void pk_client_resolve_async ()
PkResults * pk_client_search_names ()
void pk_client_search_names_async ()
PkResults * pk_client_search_details ()
void pk_client_search_details_async ()
PkResults * pk_client_search_groups ()
void pk_client_search_groups_async ()
PkResults * pk_client_search_files ()
void pk_client_search_files_async ()
PkResults * pk_client_get_details ()
void pk_client_get_details_async ()
PkResults * pk_client_get_details_local ()
void pk_client_get_details_local_async ()
PkResults * pk_client_get_files_local ()
void pk_client_get_files_local_async ()
PkResults * pk_client_get_update_detail ()
void pk_client_get_update_detail_async ()
PkResults * pk_client_download_packages ()
void pk_client_download_packages_async ()
PkResults * pk_client_get_updates ()
void pk_client_get_updates_async ()
PkResults * pk_client_get_old_transactions ()
void pk_client_get_old_transactions_async ()
PkResults * pk_client_depends_on ()
void pk_client_depends_on_async ()
PkResults * pk_client_get_packages ()
void pk_client_get_packages_async ()
PkResults * pk_client_required_by ()
void pk_client_required_by_async ()
PkResults * pk_client_what_provides ()
void pk_client_what_provides_async ()
PkResults * pk_client_get_distro_upgrades ()
void pk_client_get_distro_upgrades_async ()
PkResults * pk_client_get_files ()
void pk_client_get_files_async ()
PkResults * pk_client_get_categories ()
void pk_client_get_categories_async ()
PkResults * pk_client_remove_packages ()
void pk_client_remove_packages_async ()
PkResults * pk_client_refresh_cache ()
void pk_client_refresh_cache_async ()
PkResults * pk_client_install_packages ()
void pk_client_install_packages_async ()
PkResults * pk_client_install_signature ()
void pk_client_install_signature_async ()
PkResults * pk_client_update_packages ()
void pk_client_update_packages_async ()
PkResults * pk_client_install_files ()
void pk_client_install_files_async ()
PkResults * pk_client_accept_eula ()
void pk_client_accept_eula_async ()
PkResults * pk_client_get_repo_list ()
void pk_client_get_repo_list_async ()
PkResults * pk_client_repo_enable ()
void pk_client_repo_enable_async ()
PkResults * pk_client_repo_set_data ()
void pk_client_repo_set_data_async ()
PkResults * pk_client_repo_remove ()
void pk_client_repo_remove_async ()
PkResults * pk_client_upgrade_system ()
void pk_client_upgrade_system_async ()
PkResults * pk_client_repair_system ()
void pk_client_repair_system_async ()
PkResults * pk_client_adopt ()
void pk_client_adopt_async ()
PkProgress * pk_client_get_progress ()
void pk_client_get_progress_async ()
PkProgress * pk_client_get_progress_finish ()
void pk_client_set_locale ()
const gchar * pk_client_get_locale ()
void pk_client_set_background ()
gboolean pk_client_get_background ()
void pk_client_set_interactive ()
gboolean pk_client_get_interactive ()
gboolean pk_client_get_idle ()
void pk_client_set_cache_age ()
guint pk_client_get_cache_age ()

Types and Values

Description

A GObject to use for accessing PackageKit asynchronously. If you're using PkClient to install, remove, or update packages, be prepared that the eula, gpg and trusted callbacks need to be rescheduled manually, as in http://www.packagekit.org/gtk-doc/introduction-ideas-transactions.html

Functions

pk_client_error_quark ()

GQuark
pk_client_error_quark (void);

An error quark for PkClientError.

Returns

an error quark.

Since: 0.5.2


pk_client_new ()

PkClient *
pk_client_new (void);

PkClient is a nice GObject wrapper for PackageKit and makes writing frontends easy.

Returns

A new PkClient instance

Since: 0.5.2


pk_client_generic_finish ()

PkResults *
pk_client_generic_finish (PkClient *client,
                          GAsyncResult *res,
                          GError **error);

Gets the result from the asynchronous function.

Parameters

client

a valid PkClient instance

 

res

the GAsyncResult

 

error

A GError or NULL

 

Returns

the PkResults, or NULL. Free with g_object_unref().

[transfer full]

Since: 0.5.2


pk_client_resolve ()

PkResults *
pk_client_resolve (PkClient *client,
                   PkBitfield filters,
                   gchar **packages,
                   GCancellable *cancellable,
                   PkProgressCallback progress_callback,
                   gpointer progress_user_data,
                   GError **error);

Resolve a package name into a package_id . This can return installed and available packages and allows you find out if a package is installed locally or is available in a repository.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

packages

an array of package names to resolve, e.g. "gnome-system-tools".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_resolve_async ()

void
pk_client_resolve_async (PkClient *client,
                         PkBitfield filters,
                         gchar **packages,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GAsyncReadyCallback callback_ready,
                         gpointer user_data);

Resolve a package name into a package_id . This can return installed and available packages and allows you find out if a package is installed locally or is available in a repository.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

packages

an array of package names to resolve, e.g. "gnome-system-tools".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_search_names ()

PkResults *
pk_client_search_names (PkClient *client,
                        PkBitfield filters,
                        gchar **values,
                        GCancellable *cancellable,
                        PkProgressCallback progress_callback,
                        gpointer progress_user_data,
                        GError **error);

Search all the locally installed files and remote repositories for a package that matches a specific name.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

free text to search for, for instance, "power".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.5


pk_client_search_names_async ()

void
pk_client_search_names_async (PkClient *client,
                              PkBitfield filters,
                              gchar **values,
                              GCancellable *cancellable,
                              PkProgressCallback progress_callback,
                              gpointer progress_user_data,
                              GAsyncReadyCallback callback_ready,
                              gpointer user_data);

Search all the locally installed files and remote repositories for a package that matches a specific name.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

free text to search for, for instance, "power".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.5


pk_client_search_details ()

PkResults *
pk_client_search_details (PkClient *client,
                          PkBitfield filters,
                          gchar **values,
                          GCancellable *cancellable,
                          PkProgressCallback progress_callback,
                          gpointer progress_user_data,
                          GError **error);

Search all detailed summary information to try and find a keyword. Think of this as pk_client_search_names(), but trying much harder and taking longer.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

free text to search for, for instance, "power".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.5


pk_client_search_details_async ()

void
pk_client_search_details_async (PkClient *client,
                                PkBitfield filters,
                                gchar **values,
                                GCancellable *cancellable,
                                PkProgressCallback progress_callback,
                                gpointer progress_user_data,
                                GAsyncReadyCallback callback_ready,
                                gpointer user_data);

Search all detailed summary information to try and find a keyword. Think of this as pk_client_search_names(), but trying much harder and taking longer.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

free text to search for, for instance, "power".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.5


pk_client_search_groups ()

PkResults *
pk_client_search_groups (PkClient *client,
                         PkBitfield filters,
                         gchar **values,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

Return all packages in a specific group.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

a group enum to search for, for instance, "system-tools".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.5


pk_client_search_groups_async ()

void
pk_client_search_groups_async (PkClient *client,
                               PkBitfield filters,
                               gchar **values,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

Return all packages in a specific group.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

a group enum to search for, for instance, "system-tools".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.5


pk_client_search_files ()

PkResults *
pk_client_search_files (PkClient *client,
                        PkBitfield filters,
                        gchar **values,
                        GCancellable *cancellable,
                        PkProgressCallback progress_callback,
                        gpointer progress_user_data,
                        GError **error);

Search for packages that provide a specific file.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

file to search for, for instance, "/sbin/service".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.5


pk_client_search_files_async ()

void
pk_client_search_files_async (PkClient *client,
                              PkBitfield filters,
                              gchar **values,
                              GCancellable *cancellable,
                              PkProgressCallback progress_callback,
                              gpointer progress_user_data,
                              GAsyncReadyCallback callback_ready,
                              gpointer user_data);

Search for packages that provide a specific file.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

file to search for, for instance, "/sbin/service".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.5


pk_client_get_details ()

PkResults *
pk_client_get_details (PkClient *client,
                       gchar **package_ids,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

Get details of a package, so more information can be obtained for GUI or command line tools.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_details_async ()

void
pk_client_get_details_async (PkClient *client,
                             gchar **package_ids,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

Get details of a package, so more information can be obtained for GUI or command line tools.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_details_local ()

PkResults *
pk_client_get_details_local (PkClient *client,
                             gchar **files,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GError **error);

Get details of a local package, so more information can be obtained for GUI or command line tools.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

files

a null terminated array of filenames.

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.17


pk_client_get_details_local_async ()

void
pk_client_get_details_local_async (PkClient *client,
                                   gchar **files,
                                   GCancellable *cancellable,
                                   PkProgressCallback progress_callback,
                                   gpointer progress_user_data,
                                   GAsyncReadyCallback callback_ready,
                                   gpointer user_data);

Get details of a package, so more information can be obtained for GUI or command line tools.

Parameters

client

a valid PkClient instance

 

files

a null terminated array of filenames.

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.17


pk_client_get_files_local ()

PkResults *
pk_client_get_files_local (PkClient *client,
                           gchar **files,
                           GCancellable *cancellable,
                           PkProgressCallback progress_callback,
                           gpointer progress_user_data,
                           GError **error);

Get file list of a local package, so more information can be obtained for GUI or command line tools.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

files

a null terminated array of filenames.

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.9.1


pk_client_get_files_local_async ()

void
pk_client_get_files_local_async (PkClient *client,
                                 gchar **files,
                                 GCancellable *cancellable,
                                 PkProgressCallback progress_callback,
                                 gpointer progress_user_data,
                                 GAsyncReadyCallback callback_ready,
                                 gpointer user_data);

Get file list of a package, so more information can be obtained for GUI or command line tools.

Parameters

client

a valid PkClient instance

 

files

a null terminated array of filenames.

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.9.1


pk_client_get_update_detail ()

PkResults *
pk_client_get_update_detail (PkClient *client,
                             gchar **package_ids,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GError **error);

Get details about the specific update, for instance any CVE urls and severity information.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_update_detail_async ()

void
pk_client_get_update_detail_async (PkClient *client,
                                   gchar **package_ids,
                                   GCancellable *cancellable,
                                   PkProgressCallback progress_callback,
                                   gpointer progress_user_data,
                                   GAsyncReadyCallback callback_ready,
                                   gpointer user_data);

Get details about the specific update, for instance any CVE urls and severity information.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_download_packages ()

PkResults *
pk_client_download_packages (PkClient *client,
                             gchar **package_ids,
                             const gchar *directory,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GError **error);

Downloads package files to a specified location.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

directory

the location where packages are to be downloaded

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_download_packages_async ()

void
pk_client_download_packages_async (PkClient *client,
                                   gchar **package_ids,
                                   const gchar *directory,
                                   GCancellable *cancellable,
                                   PkProgressCallback progress_callback,
                                   gpointer progress_user_data,
                                   GAsyncReadyCallback callback_ready,
                                   gpointer user_data);

Downloads package files to a specified location.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

directory

the location where packages are to be downloaded

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_updates ()

PkResults *
pk_client_get_updates (PkClient *client,
                       PkBitfield filters,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

Get a list of all the packages that can be updated for all repositories.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_DEVELOPMENT or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_updates_async ()

void
pk_client_get_updates_async (PkClient *client,
                             PkBitfield filters,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

Get a list of all the packages that can be updated for all repositories.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_DEVELOPMENT or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_old_transactions ()

PkResults *
pk_client_get_old_transactions (PkClient *client,
                                guint number,
                                GCancellable *cancellable,
                                PkProgressCallback progress_callback,
                                gpointer progress_user_data,
                                GError **error);

Get the old transaction list, mainly used for the transaction viewer.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

number

the number of past transactions to return, or 0 for all

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_old_transactions_async ()

void
pk_client_get_old_transactions_async (PkClient *client,
                                      guint number,
                                      GCancellable *cancellable,
                                      PkProgressCallback progress_callback,
                                      gpointer progress_user_data,
                                      GAsyncReadyCallback callback_ready,
                                      gpointer user_data);

Get the old transaction list, mainly used for the transaction viewer.

Parameters

client

a valid PkClient instance

 

number

the number of past transactions to return, or 0 for all

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_depends_on ()

PkResults *
pk_client_depends_on (PkClient *client,
                      PkBitfield filters,
                      gchar **package_ids,
                      gboolean recursive,
                      GCancellable *cancellable,
                      PkProgressCallback progress_callback,
                      gpointer progress_user_data,
                      GError **error);

Get the packages that depend this one, i.e. child.parent.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

recursive

If we should search recursively for depends

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_depends_on_async ()

void
pk_client_depends_on_async (PkClient *client,
                            PkBitfield filters,
                            gchar **package_ids,
                            gboolean recursive,
                            GCancellable *cancellable,
                            PkProgressCallback progress_callback,
                            gpointer progress_user_data,
                            GAsyncReadyCallback callback_ready,
                            gpointer user_data);

Get the packages that depend this one, i.e. child->parent.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

recursive

If we should search recursively for depends

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_packages ()

PkResults *
pk_client_get_packages (PkClient *client,
                        PkBitfield filters,
                        GCancellable *cancellable,
                        PkProgressCallback progress_callback,
                        gpointer progress_user_data,
                        GError **error);

Get the list of packages from the backend

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_packages_async ()

void
pk_client_get_packages_async (PkClient *client,
                              PkBitfield filters,
                              GCancellable *cancellable,
                              PkProgressCallback progress_callback,
                              gpointer progress_user_data,
                              GAsyncReadyCallback callback_ready,
                              gpointer user_data);

Get the list of packages from the backend

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_required_by ()

PkResults *
pk_client_required_by (PkClient *client,
                       PkBitfield filters,
                       gchar **package_ids,
                       gboolean recursive,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

Get the packages that require this one, i.e. parent.child.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

recursive

If we should search recursively for requires

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_required_by_async ()

void
pk_client_required_by_async (PkClient *client,
                             PkBitfield filters,
                             gchar **package_ids,
                             gboolean recursive,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

Get the packages that require this one, i.e. parent->child.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

recursive

If we should search recursively for requires

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_what_provides ()

PkResults *
pk_client_what_provides (PkClient *client,
                         PkBitfield filters,
                         gchar **values,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

This should return packages that provide the supplied attributes. This method is useful for finding out what package(s) provide a modalias or GStreamer codec string.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

a search term such as "sound/mp3".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_what_provides_async ()

void
pk_client_what_provides_async (PkClient *client,
                               PkBitfield filters,
                               gchar **values,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

This should return packages that provide the supplied attributes. This method is useful for finding out what package(s) provide a modalias or GStreamer codec string.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_GUI | PK_FILTER_ENUM_FREE or PK_FILTER_ENUM_NONE

 

values

a search term such as "sound/mp3".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_distro_upgrades ()

PkResults *
pk_client_get_distro_upgrades (PkClient *client,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GError **error);

This method should return a list of distribution upgrades that are available. It should not return updates, only major upgrades.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_distro_upgrades_async ()

void
pk_client_get_distro_upgrades_async (PkClient *client,
                                     GCancellable *cancellable,
                                     PkProgressCallback progress_callback,
                                     gpointer progress_user_data,
                                     GAsyncReadyCallback callback_ready,
                                     gpointer user_data);

This method should return a list of distribution upgrades that are available. It should not return updates, only major upgrades.

Parameters

client

a valid PkClient instance

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_files ()

PkResults *
pk_client_get_files (PkClient *client,
                     gchar **package_ids,
                     GCancellable *cancellable,
                     PkProgressCallback progress_callback,
                     gpointer progress_user_data,
                     GError **error);

Get the file list (i.e. a list of files installed) for the specified package.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_files_async ()

void
pk_client_get_files_async (PkClient *client,
                           gchar **package_ids,
                           GCancellable *cancellable,
                           PkProgressCallback progress_callback,
                           gpointer progress_user_data,
                           GAsyncReadyCallback callback_ready,
                           gpointer user_data);

Get the file list (i.e. a list of files installed) for the specified package.

Parameters

client

a valid PkClient instance

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_categories ()

PkResults *
pk_client_get_categories (PkClient *client,
                          GCancellable *cancellable,
                          PkProgressCallback progress_callback,
                          gpointer progress_user_data,
                          GError **error);

Get a list of all categories supported.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_categories_async ()

void
pk_client_get_categories_async (PkClient *client,
                                GCancellable *cancellable,
                                PkProgressCallback progress_callback,
                                gpointer progress_user_data,
                                GAsyncReadyCallback callback_ready,
                                gpointer user_data);

Get a list of all categories supported.

Parameters

client

a valid PkClient instance

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_remove_packages ()

PkResults *
pk_client_remove_packages (PkClient *client,
                           PkBitfield transaction_flags,
                           gchar **package_ids,
                           gboolean allow_deps,
                           gboolean autoremove,
                           GCancellable *cancellable,
                           PkProgressCallback progress_callback,
                           gpointer progress_user_data,
                           GError **error);

Remove a package (optionally with dependancies) from the system. If allow_deps is set to FALSE, and other packages would have to be removed, then the transaction would fail.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

allow_deps

if other dependent packages are allowed to be removed from the computer

 

autoremove

if other packages installed at the same time should be tried to remove

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.1


pk_client_remove_packages_async ()

void
pk_client_remove_packages_async (PkClient *client,
                                 PkBitfield transaction_flags,
                                 gchar **package_ids,
                                 gboolean allow_deps,
                                 gboolean autoremove,
                                 GCancellable *cancellable,
                                 PkProgressCallback progress_callback,
                                 gpointer progress_user_data,
                                 GAsyncReadyCallback callback_ready,
                                 gpointer user_data);

Remove a package (optionally with dependancies) from the system. If allow_deps is set to FALSE, and other packages would have to be removed, then the transaction would fail.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

allow_deps

if other dependent packages are allowed to be removed from the computer

 

autoremove

if other packages installed at the same time should be tried to remove

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.1


pk_client_refresh_cache ()

PkResults *
pk_client_refresh_cache (PkClient *client,
                         gboolean force,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

Refresh the cache, i.e. download new metadata from a remote URL so that package lists are up to date. This action may take a few minutes and should be done when the session and system are idle.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

force

if we should aggressively drop caches

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_refresh_cache_async ()

void
pk_client_refresh_cache_async (PkClient *client,
                               gboolean force,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

Refresh the cache, i.e. download new metadata from a remote URL so that package lists are up to date. This action may take a few minutes and should be done when the session and system are idle.

Parameters

client

a valid PkClient instance

 

force

if we should aggressively drop caches

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_install_packages ()

PkResults *
pk_client_install_packages (PkClient *client,
                            PkBitfield transaction_flags,
                            gchar **package_ids,
                            GCancellable *cancellable,
                            PkProgressCallback progress_callback,
                            gpointer progress_user_data,
                            GError **error);

Install a package of the newest and most correct version.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.1


pk_client_install_packages_async ()

void
pk_client_install_packages_async (PkClient *client,
                                  PkBitfield transaction_flags,
                                  gchar **package_ids,
                                  GCancellable *cancellable,
                                  PkProgressCallback progress_callback,
                                  gpointer progress_user_data,
                                  GAsyncReadyCallback callback_ready,
                                  gpointer user_data);

Install a package of the newest and most correct version.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.1


pk_client_install_signature ()

PkResults *
pk_client_install_signature (PkClient *client,
                             PkSigTypeEnum type,
                             const gchar *key_id,
                             const gchar *package_id,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GError **error);

Install a software repository signature of the newest and most correct version.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

type

the signature type, e.g. PK_SIGTYPE_ENUM_GPG

 

key_id

a key ID such as "0df23df"

 

package_id

a signature_id structure such as "hal;0.0.1;i386;fedora"

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_install_signature_async ()

void
pk_client_install_signature_async (PkClient *client,
                                   PkSigTypeEnum type,
                                   const gchar *key_id,
                                   const gchar *package_id,
                                   GCancellable *cancellable,
                                   PkProgressCallback progress_callback,
                                   gpointer progress_user_data,
                                   GAsyncReadyCallback callback_ready,
                                   gpointer user_data);

Install a software repository signature of the newest and most correct version.

Parameters

client

a valid PkClient instance

 

type

the signature type, e.g. PK_SIGTYPE_ENUM_GPG

 

key_id

a key ID such as "0df23df"

 

package_id

a signature_id structure such as "hal;0.0.1;i386;fedora"

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_update_packages ()

PkResults *
pk_client_update_packages (PkClient *client,
                           PkBitfield transaction_flags,
                           gchar **package_ids,
                           GCancellable *cancellable,
                           PkProgressCallback progress_callback,
                           gpointer progress_user_data,
                           GError **error);

Update specific packages to the newest available versions.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.1


pk_client_update_packages_async ()

void
pk_client_update_packages_async (PkClient *client,
                                 PkBitfield transaction_flags,
                                 gchar **package_ids,
                                 GCancellable *cancellable,
                                 PkProgressCallback progress_callback,
                                 gpointer progress_user_data,
                                 GAsyncReadyCallback callback_ready,
                                 gpointer user_data);

Update specific packages to the newest available versions.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

package_ids

a null terminated array of package_id structures such as "hal;0.0.1;i386;fedora".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.1


pk_client_install_files ()

PkResults *
pk_client_install_files (PkClient *client,
                         PkBitfield transaction_flags,
                         gchar **files,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

Install a file locally, and get the deps from the repositories. This is useful for double clicking on a .rpm or .deb file.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

files

a file such as "/home/hughsie/Desktop/hal-devel-0.10.0.rpm".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.1


pk_client_install_files_async ()

void
pk_client_install_files_async (PkClient *client,
                               PkBitfield transaction_flags,
                               gchar **files,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

Install a file locally, and get the deps from the repositories. This is useful for double clicking on a .rpm or .deb file.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

files

a file such as "/home/hughsie/Desktop/hal-devel-0.10.0.rpm".

[array zero-terminated=1]

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.1


pk_client_accept_eula ()

PkResults *
pk_client_accept_eula (PkClient *client,
                       const gchar *eula_id,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

We may want to agree to a EULA dialog if one is presented.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

eula_id

the eula_id we are agreeing to

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_accept_eula_async ()

void
pk_client_accept_eula_async (PkClient *client,
                             const gchar *eula_id,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

We may want to agree to a EULA dialog if one is presented.

Parameters

client

a valid PkClient instance

 

eula_id

the eula_id we are agreeing to

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_repo_list ()

PkResults *
pk_client_get_repo_list (PkClient *client,
                         PkBitfield filters,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

Get the list of repositories installed on the system.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_DEVELOPMENT or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_repo_list_async ()

void
pk_client_get_repo_list_async (PkClient *client,
                               PkBitfield filters,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

Get the list of repositories installed on the system.

Parameters

client

a valid PkClient instance

 

filters

a PkBitfield such as PK_FILTER_ENUM_DEVELOPMENT or PK_FILTER_ENUM_NONE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_repo_enable ()

PkResults *
pk_client_repo_enable (PkClient *client,
                       const gchar *repo_id,
                       gboolean enabled,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

Enable or disable the repository.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

repo_id

a repo_id structure such as "livna-devel"

 

enabled

if we should enable the repository

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_repo_enable_async ()

void
pk_client_repo_enable_async (PkClient *client,
                             const gchar *repo_id,
                             gboolean enabled,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

Enable or disable the repository.

Parameters

client

a valid PkClient instance

 

repo_id

a repo_id structure such as "livna-devel"

 

enabled

if we should enable the repository

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_repo_set_data ()

PkResults *
pk_client_repo_set_data (PkClient *client,
                         const gchar *repo_id,
                         const gchar *parameter,
                         const gchar *value,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

We may want to set a repository parameter. NOTE: this is free text, and is left to the backend to define a format.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

repo_id

a repo_id structure such as "livna-devel"

 

parameter

the parameter to change

 

value

what we should change it to

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_repo_set_data_async ()

void
pk_client_repo_set_data_async (PkClient *client,
                               const gchar *repo_id,
                               const gchar *parameter,
                               const gchar *value,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

We may want to set a repository parameter. NOTE: this is free text, and is left to the backend to define a format.

Parameters

client

a valid PkClient instance

 

repo_id

a repo_id structure such as "livna-devel"

 

parameter

the parameter to change

 

value

what we should change it to

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_repo_remove ()

PkResults *
pk_client_repo_remove (PkClient *client,
                       PkBitfield transaction_flags,
                       const gchar *repo_id,
                       gboolean autoremove,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GError **error);

Removes a repo and optionally the packages installed from it.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

transaction flags

 

repo_id

a repo_id structure such as "livna-devel"

 

autoremove

If packages should be auto-removed

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.9.1


pk_client_repo_remove_async ()

void
pk_client_repo_remove_async (PkClient *client,
                             PkBitfield transaction_flags,
                             const gchar *repo_id,
                             gboolean autoremove,
                             GCancellable *cancellable,
                             PkProgressCallback progress_callback,
                             gpointer progress_user_data,
                             GAsyncReadyCallback callback_ready,
                             gpointer user_data);

Removes a repo and optionally the packages installed from it.

Parameters

client

a valid PkClient instance

 

transaction_flags

transaction flags

 

repo_id

a repo_id structure such as "livna-devel"

 

autoremove

If packages should be auto-removed

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.9.1


pk_client_upgrade_system ()

PkResults *
pk_client_upgrade_system (PkClient *client,
                          PkBitfield transaction_flags,
                          const gchar *distro_id,
                          PkUpgradeKindEnum upgrade_kind,
                          GCancellable *cancellable,
                          PkProgressCallback progress_callback,
                          gpointer progress_user_data,
                          GError **error);

This transaction will upgrade the distro to the next version, which may involve just downloading the installer and setting up the boot device, or may involve doing an on-line upgrade.

The backend will decide what is best to do.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

distro_id

a distro ID such as "fedora-14"

 

transaction_flags

transaction flags

 

upgrade_kind

a PkUpgradeKindEnum such as PK_UPGRADE_KIND_ENUM_COMPLETE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 1.0.10


pk_client_upgrade_system_async ()

void
pk_client_upgrade_system_async (PkClient *client,
                                PkBitfield transaction_flags,
                                const gchar *distro_id,
                                PkUpgradeKindEnum upgrade_kind,
                                GCancellable *cancellable,
                                PkProgressCallback progress_callback,
                                gpointer progress_user_data,
                                GAsyncReadyCallback callback_ready,
                                gpointer user_data);

This transaction will update the distro to the next version, which may involve just downloading the installer and setting up the boot device, or may involve doing an on-line upgrade.

The backend will decide what is best to do.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

distro_id

a distro ID such as "fedora-14"

 

upgrade_kind

a PkUpgradeKindEnum such as PK_UPGRADE_KIND_ENUM_COMPLETE

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 1.0.10


pk_client_repair_system ()

PkResults *
pk_client_repair_system (PkClient *client,
                         PkBitfield transaction_flags,
                         GCancellable *cancellable,
                         PkProgressCallback progress_callback,
                         gpointer progress_user_data,
                         GError **error);

This transaction will try to recover from a broken package management system: e.g. the installation of a package with unsatisfied dependencies has been forced by using a low level tool (rpm or dpkg) or the system was shutdown during processing an installation.

The backend will decide what is best to do.

Warning: this function is synchronous, and may block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_flags

if only trusted packages should be installed

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.8.1


pk_client_repair_system_async ()

void
pk_client_repair_system_async (PkClient *client,
                               PkBitfield transaction_flags,
                               GCancellable *cancellable,
                               PkProgressCallback progress_callback,
                               gpointer progress_user_data,
                               GAsyncReadyCallback callback_ready,
                               gpointer user_data);

This transaction will try to recover from a broken package management system: e.g. the installation of a package with unsatisfied dependencies has been forced by the user using a low level tool (rpm or dpkg) or the system was shutdown during processing an installation.

The backend will decide what is best to do.

Parameters

client

a valid PkClient instance

 

transaction_flags

a transaction type bitfield

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.8.1


pk_client_adopt ()

PkResults *
pk_client_adopt (PkClient *client,
                 const gchar *transaction_id,
                 GCancellable *cancellable,
                 PkProgressCallback progress_callback,
                 gpointer progress_user_data,
                 GError **error);

Adopt a transaction.

Warning: this function is synchronous, and will block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_id

a transaction ID such as "/21_ebcbdaae_data"

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope call]

progress_user_data

data to pass to progress_callback

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_adopt_async ()

void
pk_client_adopt_async (PkClient *client,
                       const gchar *transaction_id,
                       GCancellable *cancellable,
                       PkProgressCallback progress_callback,
                       gpointer progress_user_data,
                       GAsyncReadyCallback callback_ready,
                       gpointer user_data);

Adopt a transaction which allows the caller to monitor the state or cancel it.

Parameters

client

a valid PkClient instance

 

transaction_id

a transaction ID such as "/21_ebcbdaae_data"

 

cancellable

a GCancellable or NULL

 

progress_callback

the function to run when the progress changes.

[scope notified]

progress_user_data

data to pass to progress_callback

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_progress ()

PkProgress *
pk_client_get_progress (PkClient *client,
                        const gchar *transaction_id,
                        GCancellable *cancellable,
                        GError **error);

Get the progress of a transaction.

Warning: this function is synchronous, and will block. Do not use it in GUI applications.

Parameters

client

a valid PkClient instance

 

transaction_id

The transaction id

 

cancellable

a GCancellable or NULL

 

error

the GError to store any failure, or NULL

 

Returns

a PkResults object, or NULL for error.

[transfer full]

Since: 0.5.3


pk_client_get_progress_async ()

void
pk_client_get_progress_async (PkClient *client,
                              const gchar *transaction_id,
                              GCancellable *cancellable,
                              GAsyncReadyCallback callback_ready,
                              gpointer user_data);

Find the current state of a transaction.

Parameters

client

a valid PkClient instance

 

transaction_id

a transaction ID such as "/21_ebcbdaae_data"

 

cancellable

a GCancellable or NULL

 

callback_ready

the function to run on completion

 

user_data

the data to pass to callback_ready

 

Since: 0.5.2


pk_client_get_progress_finish ()

PkProgress *
pk_client_get_progress_finish (PkClient *client,
                               GAsyncResult *res,
                               GError **error);

Gets the result from the asynchronous function.

Parameters

client

a valid PkClient instance

 

res

the GAsyncResult

 

error

A GError or NULL

 

Returns

the PkProgress, or NULL. Free with g_object_unref().

[transfer full]

Since: 0.5.2


pk_client_set_locale ()

void
pk_client_set_locale (PkClient *client,
                      const gchar *locale);

Sets the locale to be used for the client. This may affect returned results.

Parameters

client

a valid PkClient instance

 

locale

the locale to set, e.g. "en_GB.UTF-8"

 

Since: 0.6.10


pk_client_get_locale ()

const gchar *
pk_client_get_locale (PkClient *client);

Gets the locale used for this transaction.

Parameters

client

a valid PkClient instance

 

Returns

The locale.

Since: 0.6.10


pk_client_set_background ()

void
pk_client_set_background (PkClient *client,
                          gboolean background);

Sets the background value for the client. A background transaction is usually scheduled at a lower priority and is usually given less network and disk performance.

Parameters

client

a valid PkClient instance

 

background

if the transaction is a background transaction

 

Since: 0.6.10


pk_client_get_background ()

gboolean
pk_client_get_background (PkClient *client);

Gets the background value.

Parameters

client

a valid PkClient instance

 

Returns

The background status.

Since: 0.6.10


pk_client_set_interactive ()

void
pk_client_set_interactive (PkClient *client,
                           gboolean interactive);

Sets the interactive value for the client. Interactive transactions are usally allowed to ask the user questions.

Parameters

client

a valid PkClient instance

 

interactive

the value to set

 

Since: 0.6.10


pk_client_get_interactive ()

gboolean
pk_client_get_interactive (PkClient *client);

Gets the client interactive value.

Parameters

client

a valid PkClient instance

 

Returns

if the transaction is due to run interactivly.

Since: 0.6.10


pk_client_get_idle ()

gboolean
pk_client_get_idle (PkClient *client);

Gets if the transaction client idle value.

Parameters

client

a valid PkClient instance

 

Returns

if this client is idle.

Since: 0.6.10


pk_client_set_cache_age ()

void
pk_client_set_cache_age (PkClient *client,
                         guint cache_age);

Sets the maximum cache age value for the client.

Parameters

client

a valid PkClient instance

 

cache_age

the cache age to set, where G_MAXUINT means "never"

 

Since: 0.6.10


pk_client_get_cache_age ()

guint
pk_client_get_cache_age (PkClient *client);

Gets the maximum cache age value.

Parameters

client

a valid PkClient instance

 

Returns

The cache age in seconds

Since: 0.6.10

Types and Values

PK_CLIENT_ERROR

#define PK_CLIENT_ERROR		(pk_client_error_quark ())

PK_CLIENT_TYPE_ERROR

#define PK_CLIENT_TYPE_ERROR (pk_client_error_get_type ())

enum PkClientError

Errors that can be thrown

Members

PK_CLIENT_ERROR_FAILED

the transaction failed for an unknown reason

 

PK_CLIENT_ERROR_FAILED_AUTH

the transaction failed authentication/authorization

 

PK_CLIENT_ERROR_NO_TID

the transaction id was not pre-allocated (internal error)

 

PK_CLIENT_ERROR_ALREADY_TID

the transaction id has already been used (internal error)

 

PK_CLIENT_ERROR_ROLE_UNKNOWN

the role was not set (internal error)

 

PK_CLIENT_ERROR_CANNOT_START_DAEMON

the PackageKit daemon failed to start

 

PK_CLIENT_ERROR_INVALID_INPUT

the package_id is invalid

 

PK_CLIENT_ERROR_INVALID_FILE

the file is invalid

 

PK_CLIENT_ERROR_NOT_SUPPORTED

the action is not supported

 

PK_CLIENT_ERROR_DECLINED_SIMULATION

the simulation was declined by the user

 

PK_CLIENT_ERROR_LAST