pk-item

pk-item — A single piece of information from a transaction

Synopsis

                    PkItemDetails;
                    PkItemUpdateDetail;
                    PkItemPackage;
void                pk_item_test                        (gpointer user_data);
PkItemPackage *     pk_item_package_ref                 (PkItemPackage *item);
PkItemPackage *     pk_item_package_unref               (PkItemPackage *item);
PkItemDetails *     pk_item_details_ref                 (PkItemDetails *item);
PkItemDetails *     pk_item_details_unref               (PkItemDetails *item);
PkItemUpdateDetail * pk_item_update_detail_ref          (PkItemUpdateDetail *item);
PkItemUpdateDetail * pk_item_update_detail_unref        (PkItemUpdateDetail *item);
PkItemCategory *    pk_item_category_ref                (PkItemCategory *item);
PkItemCategory *    pk_item_category_unref              (PkItemCategory *item);
PkItemDistroUpgrade * pk_item_distro_upgrade_ref        (PkItemDistroUpgrade *item);
PkItemDistroUpgrade * pk_item_distro_upgrade_unref      (PkItemDistroUpgrade *item);
PkItemRequireRestart * pk_item_require_restart_ref      (PkItemRequireRestart *item);
PkItemRequireRestart * pk_item_require_restart_unref    (PkItemRequireRestart *item);
PkItemTransaction * pk_item_transaction_ref             (PkItemTransaction *item);
PkItemTransaction * pk_item_transaction_unref           (PkItemTransaction *item);
PkItemFiles *       pk_item_files_ref                   (PkItemFiles *item);
PkItemFiles *       pk_item_files_unref                 (PkItemFiles *item);
PkItemRepoSignatureRequired * pk_item_repo_signature_required_ref
                                                        (PkItemRepoSignatureRequired *item);
PkItemRepoSignatureRequired * pk_item_repo_signature_required_unref
                                                        (PkItemRepoSignatureRequired *item);
PkItemEulaRequired * pk_item_eula_required_ref          (PkItemEulaRequired *item);
PkItemEulaRequired * pk_item_eula_required_unref        (PkItemEulaRequired *item);
PkItemMediaChangeRequired * pk_item_media_change_required_ref
                                                        (PkItemMediaChangeRequired *item);
PkItemMediaChangeRequired * pk_item_media_change_required_unref
                                                        (PkItemMediaChangeRequired *item);
PkItemRepoDetail *  pk_item_repo_detail_ref             (PkItemRepoDetail *item);
PkItemRepoDetail *  pk_item_repo_detail_unref           (PkItemRepoDetail *item);
PkItemErrorCode *   pk_item_error_code_ref              (PkItemErrorCode *item);
PkItemErrorCode *   pk_item_error_code_unref            (PkItemErrorCode *item);
PkItemMessage *     pk_item_message_ref                 (PkItemMessage *item);
PkItemMessage *     pk_item_message_unref               (PkItemMessage *item);
PkItemPackage *     pk_item_package_new                 (PkInfoEnum info_enum,
                                                         const gchar *package_id,
                                                         const gchar *summary);
PkItemDetails *     pk_item_details_new                 (const gchar *package_id,
                                                         const gchar *license,
                                                         PkGroupEnum group_enum,
                                                         const gchar *description,
                                                         const gchar *url,
                                                         guint64 size);
PkItemUpdateDetail * pk_item_update_detail_new          (const gchar *package_id,
                                                         const gchar *updates,
                                                         const gchar *obsoletes,
                                                         const gchar *vendor_url,
                                                         const gchar *bugzilla_url,
                                                         const gchar *cve_url,
                                                         PkRestartEnum restart_enum,
                                                         const gchar *update_text,
                                                         const gchar *changelog,
                                                         PkUpdateStateEnum state_enum,
                                                         GDate *issued,
                                                         GDate *updated);
PkItemCategory *    pk_item_category_new                (const gchar *parent_id,
                                                         const gchar *cat_id,
                                                         const gchar *name,
                                                         const gchar *summary,
                                                         const gchar *icon);
PkItemDistroUpgrade * pk_item_distro_upgrade_new        (PkUpdateStateEnum state_enum,
                                                         const gchar *name,
                                                         const gchar *summary);
PkItemRequireRestart * pk_item_require_restart_new      (PkRestartEnum restart_enum,
                                                         const gchar *package_id);
PkItemTransaction * pk_item_transaction_new             (const gchar *tid,
                                                         const gchar *timespec,
                                                         gboolean succeeded,
                                                         PkRoleEnum role_enum,
                                                         guint duration,
                                                         const gchar *data,
                                                         guint uid,
                                                         const gchar *cmdline);
PkItemFiles *       pk_item_files_new                   (const gchar *package_id,
                                                         gchar **files);
PkItemRepoSignatureRequired * pk_item_repo_signature_required_new
                                                        (const gchar *package_id,
                                                         const gchar *repository_name,
                                                         const gchar *key_url,
                                                         const gchar *key_userid,
                                                         const gchar *key_id,
                                                         const gchar *key_fingerprint,
                                                         const gchar *key_timestamp,
                                                         PkSigTypeEnum type_enum);
PkItemEulaRequired * pk_item_eula_required_new          (const gchar *eula_id,
                                                         const gchar *package_id,
                                                         const gchar *vendor_name,
                                                         const gchar *license_agreement);
PkItemMediaChangeRequired * pk_item_media_change_required_new
                                                        (PkMediaTypeEnum media_type_enum,
                                                         const gchar *media_id,
                                                         const gchar *media_text);
PkItemRepoDetail *  pk_item_repo_detail_new             (const gchar *repo_id,
                                                         const gchar *description,
                                                         gboolean enabled);
PkItemErrorCode *   pk_item_error_code_new              (PkErrorCodeEnum code_enum,
                                                         const gchar *details);
PkItemMessage *     pk_item_message_new                 (PkMessageEnum type_enum,
                                                         const gchar *details);

Description

These objects represent single items of data from the transaction, and are often present in lists (PkResults) or just refcounted in client programs.

Details

PkItemDetails

typedef struct {
	guint				 refcount;
	gchar				*package_id;
	gchar				*license;
	PkGroupEnum			 group;
	gchar				*description;
	gchar				*url;
	guint64				 size;
	gpointer			 user_data;
} PkItemDetails;

Object to represent details about the update.

PkItemUpdateDetail

typedef struct {
	guint				 refcount;
	gchar				*package_id;
	gchar				*updates;
	gchar				*obsoletes;
	gchar				*vendor_url;
	gchar				*bugzilla_url;
	gchar				*cve_url;
	PkRestartEnum			 restart;
	gchar				*update_text;
	gchar				*changelog;
	PkUpdateStateEnum		 state;
	GDate				*issued;
	GDate				*updated;
	gpointer			 user_data;
} PkItemUpdateDetail;

Object to represent details about the update.

PkItemPackage

typedef struct {
	guint				 refcount;
	PkInfoEnum			 info;
	gchar				*package_id;
	gchar				*summary;
	gpointer			 user_data;
} PkItemPackage;

Object to represent details about a package.

pk_item_test ()

void                pk_item_test                        (gpointer user_data);

user_data :

pk_item_package_ref ()

PkItemPackage *     pk_item_package_ref                 (PkItemPackage *item);

Increases the reference count by one.

item :

 the PkItemPackage

Returns :

 the item

pk_item_package_unref ()

PkItemPackage *     pk_item_package_unref               (PkItemPackage *item);

Decreases the reference count by one.

item :

 the PkItemPackage

Returns :

 the item, or NULL if the object is no longer valid

pk_item_details_ref ()

PkItemDetails *     pk_item_details_ref                 (PkItemDetails *item);

Increases the reference count by one.

item :

 the PkItemDetails

Returns :

 the item

pk_item_details_unref ()

PkItemDetails *     pk_item_details_unref               (PkItemDetails *item);

Decreases the reference count by one.

item :

 the PkItemDetails

Returns :

 the item, or NULL if the object is no longer valid

pk_item_update_detail_ref ()

PkItemUpdateDetail * pk_item_update_detail_ref          (PkItemUpdateDetail *item);

Increases the reference count by one.

item :

 the PkItemUpdateDetail

Returns :

 the item

pk_item_update_detail_unref ()

PkItemUpdateDetail * pk_item_update_detail_unref        (PkItemUpdateDetail *item);

Decreases the reference count by one.

item :

 the PkItemUpdateDetail

Returns :

 the item, or NULL if the object is no longer valid

pk_item_category_ref ()

PkItemCategory *    pk_item_category_ref                (PkItemCategory *item);

Increases the reference count by one.

item :

 the PkItemCategory

Returns :

 the item

pk_item_category_unref ()

PkItemCategory *    pk_item_category_unref              (PkItemCategory *item);

Decreases the reference count by one.

item :

 the PkItemCategory

Returns :

 the item, or NULL if the object is no longer valid

pk_item_distro_upgrade_ref ()

PkItemDistroUpgrade * pk_item_distro_upgrade_ref        (PkItemDistroUpgrade *item);

Increases the reference count by one.

item :

 the PkItemDistroUpgrade

Returns :

 the item

pk_item_distro_upgrade_unref ()

PkItemDistroUpgrade * pk_item_distro_upgrade_unref      (PkItemDistroUpgrade *item);

Decreases the reference count by one.

item :

 the PkItemDistroUpgrade

Returns :

 the item, or NULL if the object is no longer valid

pk_item_require_restart_ref ()

PkItemRequireRestart * pk_item_require_restart_ref      (PkItemRequireRestart *item);

Increases the reference count by one.

item :

 the PkItemRequireRestart

Returns :

 the item

pk_item_require_restart_unref ()

PkItemRequireRestart * pk_item_require_restart_unref    (PkItemRequireRestart *item);

Decreases the reference count by one.

item :

 the PkItemRequireRestart

Returns :

 the item, or NULL if the object is no longer valid

pk_item_transaction_ref ()

PkItemTransaction * pk_item_transaction_ref             (PkItemTransaction *item);

Increases the reference count by one.

item :

 the PkItemTransaction

Returns :

 the item

pk_item_transaction_unref ()

PkItemTransaction * pk_item_transaction_unref           (PkItemTransaction *item);

Decreases the reference count by one.

item :

 the PkItemTransaction

Returns :

 the item, or NULL if the object is no longer valid

pk_item_files_ref ()

PkItemFiles *       pk_item_files_ref                   (PkItemFiles *item);

Increases the reference count by one.

item :

 the PkItemFiles

Returns :

 the item

pk_item_files_unref ()

PkItemFiles *       pk_item_files_unref                 (PkItemFiles *item);

Decreases the reference count by one.

item :

 the PkItemFiles

Returns :

 the item, or NULL if the object is no longer valid

pk_item_repo_signature_required_ref ()

PkItemRepoSignatureRequired * pk_item_repo_signature_required_ref
                                                        (PkItemRepoSignatureRequired *item);

Increases the reference count by one.

item :

 the PkItemRepoSignatureRequired

Returns :

 the item

pk_item_repo_signature_required_unref ()

PkItemRepoSignatureRequired * pk_item_repo_signature_required_unref
                                                        (PkItemRepoSignatureRequired *item);

Decreases the reference count by one.

item :

 the PkItemRepoSignatureRequired

Returns :

 the item, or NULL if the object is no longer valid

pk_item_eula_required_ref ()

PkItemEulaRequired * pk_item_eula_required_ref          (PkItemEulaRequired *item);

Increases the reference count by one.

item :

 the PkItemEulaRequired

Returns :

 the item

pk_item_eula_required_unref ()

PkItemEulaRequired * pk_item_eula_required_unref        (PkItemEulaRequired *item);

Decreases the reference count by one.

item :

 the PkItemEulaRequired

Returns :

 the item, or NULL if the object is no longer valid

pk_item_media_change_required_ref ()

PkItemMediaChangeRequired * pk_item_media_change_required_ref
                                                        (PkItemMediaChangeRequired *item);

Increases the reference count by one.

item :

 the PkItemMediaChangeRequired

Returns :

 the item

pk_item_media_change_required_unref ()

PkItemMediaChangeRequired * pk_item_media_change_required_unref
                                                        (PkItemMediaChangeRequired *item);

Decreases the reference count by one.

item :

 the PkItemMediaChangeRequired

Returns :

 the item, or NULL if the object is no longer valid

pk_item_repo_detail_ref ()

PkItemRepoDetail *  pk_item_repo_detail_ref             (PkItemRepoDetail *item);

Increases the reference count by one.

item :

 the PkItemRepoDetail

Returns :

 the item

pk_item_repo_detail_unref ()

PkItemRepoDetail *  pk_item_repo_detail_unref           (PkItemRepoDetail *item);

Decreases the reference count by one.

item :

 the PkItemRepoDetail

Returns :

 the item, or NULL if the object is no longer valid

pk_item_error_code_ref ()

PkItemErrorCode *   pk_item_error_code_ref              (PkItemErrorCode *item);

Increases the reference count by one.

item :

 the PkItemErrorCode

Returns :

 the item

pk_item_error_code_unref ()

PkItemErrorCode *   pk_item_error_code_unref            (PkItemErrorCode *item);

Decreases the reference count by one.

item :

 the PkItemErrorCode

Returns :

 the item, or NULL if the object is no longer valid

pk_item_message_ref ()

PkItemMessage *     pk_item_message_ref                 (PkItemMessage *item);

Increases the reference count by one.

item :

 the PkItemMessage

Returns :

 the item

pk_item_message_unref ()

PkItemMessage *     pk_item_message_unref               (PkItemMessage *item);

Decreases the reference count by one.

item :

 the PkItemMessage

Returns :

 the item, or NULL if the object is no longer valid

pk_item_package_new ()

PkItemPackage *     pk_item_package_new                 (PkInfoEnum info_enum,
                                                         const gchar *package_id,
                                                         const gchar *summary);

Adds a package to the results set.

info_enum :

package_id :

summary :

Returns :

 TRUE if the value was set

pk_item_details_new ()

PkItemDetails *     pk_item_details_new                 (const gchar *package_id,
                                                         const gchar *license,
                                                         PkGroupEnum group_enum,
                                                         const gchar *description,
                                                         const gchar *url,
                                                         guint64 size);

Adds some package details to the results set.

package_id :

license :

group_enum :

description :

url :

size :

Returns :

 TRUE if the value was set

pk_item_update_detail_new ()

PkItemUpdateDetail * pk_item_update_detail_new          (const gchar *package_id,
                                                         const gchar *updates,
                                                         const gchar *obsoletes,
                                                         const gchar *vendor_url,
                                                         const gchar *bugzilla_url,
                                                         const gchar *cve_url,
                                                         PkRestartEnum restart_enum,
                                                         const gchar *update_text,
                                                         const gchar *changelog,
                                                         PkUpdateStateEnum state_enum,
                                                         GDate *issued,
                                                         GDate *updated);

Adds some update details to the results set.

package_id :

updates :

obsoletes :

vendor_url :

bugzilla_url :

cve_url :

restart_enum :

update_text :

changelog :

state_enum :

issued :

updated :

Returns :

 TRUE if the value was set

pk_item_category_new ()

PkItemCategory *    pk_item_category_new                (const gchar *parent_id,
                                                         const gchar *cat_id,
                                                         const gchar *name,
                                                         const gchar *summary,
                                                         const gchar *icon);

Adds a category item to the results set.

parent_id :

cat_id :

name :

summary :

icon :

Returns :

 TRUE if the value was set

pk_item_distro_upgrade_new ()

PkItemDistroUpgrade * pk_item_distro_upgrade_new        (PkUpdateStateEnum state_enum,
                                                         const gchar *name,
                                                         const gchar *summary);

Adds a distribution upgrade item to the results set.

state_enum :

name :

summary :

Returns :

 TRUE if the value was set

pk_item_require_restart_new ()

PkItemRequireRestart * pk_item_require_restart_new      (PkRestartEnum restart_enum,
                                                         const gchar *package_id);

Adds a require restart item to the results set.

restart_enum :

package_id :

Returns :

 TRUE if the value was set

pk_item_transaction_new ()

PkItemTransaction * pk_item_transaction_new             (const gchar *tid,
                                                         const gchar *timespec,
                                                         gboolean succeeded,
                                                         PkRoleEnum role_enum,
                                                         guint duration,
                                                         const gchar *data,
                                                         guint uid,
                                                         const gchar *cmdline);

Adds a transaction item to the results set.

tid :

timespec :

succeeded :

role_enum :

duration :

data :

uid :

cmdline :

Returns :

 TRUE if the value was set

pk_item_files_new ()

PkItemFiles *       pk_item_files_new                   (const gchar *package_id,
                                                         gchar **files);

Adds some files details to the results set.

package_id :

files :

Returns :

 TRUE if the value was set

pk_item_repo_signature_required_new ()

PkItemRepoSignatureRequired * pk_item_repo_signature_required_new
                                                        (const gchar *package_id,
                                                         const gchar *repository_name,
                                                         const gchar *key_url,
                                                         const gchar *key_userid,
                                                         const gchar *key_id,
                                                         const gchar *key_fingerprint,
                                                         const gchar *key_timestamp,
                                                         PkSigTypeEnum type_enum);

Adds some repository signature details to the results set.

package_id :

repository_name :

key_url :

key_userid :

key_id :

key_fingerprint :

key_timestamp :

type_enum :

Returns :

 TRUE if the value was set

pk_item_eula_required_new ()

PkItemEulaRequired * pk_item_eula_required_new          (const gchar *eula_id,
                                                         const gchar *package_id,
                                                         const gchar *vendor_name,
                                                         const gchar *license_agreement);

Adds some EULA details to the results set.

eula_id :

package_id :

vendor_name :

license_agreement :

Returns :

 TRUE if the value was set

pk_item_media_change_required_new ()

PkItemMediaChangeRequired * pk_item_media_change_required_new
                                                        (PkMediaTypeEnum media_type_enum,
                                                         const gchar *media_id,
                                                         const gchar *media_text);

Adds some media change details to the results set.

media_type_enum :

media_id :

media_text :

Returns :

 TRUE if the value was set

pk_item_repo_detail_new ()

PkItemRepoDetail *  pk_item_repo_detail_new             (const gchar *repo_id,
                                                         const gchar *description,
                                                         gboolean enabled);

Adds some repository details to the results set.

repo_id :

description :

enabled :

Returns :

 TRUE if the value was set

pk_item_error_code_new ()

PkItemErrorCode *   pk_item_error_code_new              (PkErrorCodeEnum code_enum,
                                                         const gchar *details);

Adds some error details to the results set.

code_enum :

details :

Returns :

 TRUE if the value was set

pk_item_message_new ()

PkItemMessage *     pk_item_message_new                 (PkMessageEnum type_enum,
                                                         const gchar *details);

Adds some message details to the results set.

type_enum :

details :

Returns :

 TRUE if the value was set
Generated by GTK-Doc V1.11