pk-extra-obj

pk-extra-obj — Client object access to extra metadata about a package

Synopsis




                    PkExtraObj;
PkExtraObj*         pk_extra_obj_new                    (void);
PkExtraObj*         pk_extra_obj_new_from_package_id    (const gchar *package_id);
PkExtraObj*         pk_extra_obj_new_from_package_id_summary
                                                        (const gchar *package_id,
                                                         const gchar *summary);
gboolean            pk_extra_obj_free                   (PkExtraObj *extra_obj);

Description

Extra metadata such as icon name and localised summary may be stored here

Details

PkExtraObj

typedef struct {
	PkPackageId	*id;
	gchar		*icon;
	gchar		*exec;
	gchar		*summary;	/* one line quick description */
} PkExtraObj;

The cached structure for the extra fields from the metadata store


pk_extra_obj_new ()

PkExtraObj*         pk_extra_obj_new                    (void);

Creates a new PkExtraObj object with default values

Returns :

a new PkExtraObj object

pk_extra_obj_new_from_package_id ()

PkExtraObj*         pk_extra_obj_new_from_package_id    (const gchar *package_id);

Creates a new PkExtraObj object with values taken from the supplied id.

package_id :

the package_id to pre-fill the object

Returns :

a new PkExtraObj object

pk_extra_obj_new_from_package_id_summary ()

PkExtraObj*         pk_extra_obj_new_from_package_id_summary
                                                        (const gchar *package_id,
                                                         const gchar *summary);

Creates a new PkExtraObj object with values taken from the supplied id.

package_id :

the package_id to pre-fill the object

summary :

Returns :

a new PkExtraObj object

pk_extra_obj_free ()

gboolean            pk_extra_obj_free                   (PkExtraObj *extra_obj);

extra_obj :

the PkExtraObj object

Returns :

TRUE if the PkExtraObj object was freed.