ZifUpdate

ZifUpdate — Information about an update

Synopsis

#define             ZIF_UPDATE_ERROR
enum                ZifUpdateState;
enum                ZifUpdateKind;
struct              ZifUpdate;
struct              ZifUpdateClass;
ZifUpdate *         zif_update_new                      (void);
ZifUpdateState      zif_update_state_from_string        (const gchar *state);
ZifUpdateKind       zif_update_kind_from_string         (const gchar *kind);
const gchar *       zif_update_state_to_string          (ZifUpdateState state);
const gchar *       zif_update_kind_to_string           (ZifUpdateKind kind);
ZifUpdateState      zif_update_get_state                (ZifUpdate *update);
ZifUpdateKind       zif_update_get_kind                 (ZifUpdate *update);
const gchar *       zif_update_get_id                   (ZifUpdate *update);
const gchar *       zif_update_get_title                (ZifUpdate *update);
const gchar *       zif_update_get_description          (ZifUpdate *update);
const gchar *       zif_update_get_issued               (ZifUpdate *update);
const gchar *       zif_update_get_source               (ZifUpdate *update);
gboolean            zif_update_get_reboot               (ZifUpdate *update);
GPtrArray *         zif_update_get_update_infos         (ZifUpdate *update);
GPtrArray *         zif_update_get_packages             (ZifUpdate *update);
GPtrArray *         zif_update_get_changelog            (ZifUpdate *update);
void                zif_update_set_state                (ZifUpdate *update,
                                                         ZifUpdateState state);
void                zif_update_set_kind                 (ZifUpdate *update,
                                                         ZifUpdateKind kind);
void                zif_update_set_id                   (ZifUpdate *update,
                                                         const gchar *id);
void                zif_update_set_title                (ZifUpdate *update,
                                                         const gchar *title);
void                zif_update_set_description          (ZifUpdate *update,
                                                         const gchar *description);
void                zif_update_set_issued               (ZifUpdate *update,
                                                         const gchar *issued);
void                zif_update_set_source               (ZifUpdate *update,
                                                         const gchar *source);
void                zif_update_set_reboot               (ZifUpdate *update,
                                                         gboolean reboot);
void                zif_update_add_update_info          (ZifUpdate *update,
                                                         ZifUpdateInfo *update_info);
void                zif_update_add_package              (ZifUpdate *update,
                                                         ZifPackage *package);
void                zif_update_add_changeset            (ZifUpdate *update,
                                                         ZifChangeset *changeset);
                    ZifUpdatePrivate;

Description

Details

ZIF_UPDATE_ERROR

#define ZIF_UPDATE_ERROR (zif_update_error_quark ())


enum ZifUpdateState

typedef enum {
	ZIF_UPDATE_STATE_STABLE,
	ZIF_UPDATE_STATE_TESTING,
	ZIF_UPDATE_STATE_UNKNOWN
} ZifUpdateState;


enum ZifUpdateKind

typedef enum {
	ZIF_UPDATE_KIND_BUGFIX,
	ZIF_UPDATE_KIND_SECURITY,
	ZIF_UPDATE_KIND_ENHANCEMENT,
	ZIF_UPDATE_KIND_NEWPACKAGE,
	ZIF_UPDATE_KIND_UNKNOWN
} ZifUpdateKind;


struct ZifUpdate

struct ZifUpdate {
	GObject			 parent;
	ZifUpdatePrivate *priv;
};


struct ZifUpdateClass

struct ZifUpdateClass {
	GObjectClass		 parent_class;
};


zif_update_new ()

ZifUpdate *         zif_update_new                      (void);

Returns :

A new ZifUpdate instance.

Since 0.1.0


zif_update_state_from_string ()

ZifUpdateState      zif_update_state_from_string        (const gchar *state);

zif_update_kind_from_string ()

ZifUpdateKind       zif_update_kind_from_string         (const gchar *kind);

zif_update_state_to_string ()

const gchar *       zif_update_state_to_string          (ZifUpdateState state);

zif_update_kind_to_string ()

const gchar *       zif_update_kind_to_string           (ZifUpdateKind kind);

zif_update_get_state ()

ZifUpdateState      zif_update_get_state                (ZifUpdate *update);

Gets the update state.

update :

A ZifUpdate

Returns :

The state of update, e.g. PK_UPDATE_STATE_ENUM_STABLE.

Since 0.1.0


zif_update_get_kind ()

ZifUpdateKind       zif_update_get_kind                 (ZifUpdate *update);

Gets the update kind.

update :

A ZifUpdate

Returns :

The state of update, e.g. PK_INFO_ENUM_SECURITY.

Since 0.1.0


zif_update_get_id ()

const gchar *       zif_update_get_id                   (ZifUpdate *update);

Gets the ID for this update.

update :

A ZifUpdate

Returns :

A string value, or NULL.

Since 0.1.0


zif_update_get_title ()

const gchar *       zif_update_get_title                (ZifUpdate *update);

Gets the title for this update.

update :

A ZifUpdate

Returns :

A string value, or NULL.

Since 0.1.0


zif_update_get_description ()

const gchar *       zif_update_get_description          (ZifUpdate *update);

Gets the description for this update.

update :

A ZifUpdate

Returns :

A string value, or NULL.

Since 0.1.0


zif_update_get_issued ()

const gchar *       zif_update_get_issued               (ZifUpdate *update);

Gets the time this update was issued.

update :

A ZifUpdate

Returns :

A string value, or NULL.

Since 0.1.0


zif_update_get_source ()

const gchar *       zif_update_get_source               (ZifUpdate *update);

Gets the source of the update, e.g. "updatesfedoraproject.org".

update :

A ZifUpdate

Returns :

A string value, or NULL.

Since 0.1.3


zif_update_get_reboot ()

gboolean            zif_update_get_reboot               (ZifUpdate *update);

Gets if the update requires a reboot.

update :

A ZifUpdate

Returns :

TRUE for a reboot.

Since 0.1.0


zif_update_get_update_infos ()

GPtrArray *         zif_update_get_update_infos         (ZifUpdate *update);

Gets the update info for this update.

update :

A ZifUpdate

Returns :

A refcounted GPtrArray of ZifUpdateInfo, or NULL. Free with g_ptr_array_unref().

Since 0.1.0


zif_update_get_packages ()

GPtrArray *         zif_update_get_packages             (ZifUpdate *update);

Gets the packages for this update.

update :

A ZifUpdate

Returns :

A refcounted GPtrArray of ZifPackage, or NULL. Free with g_ptr_array_unref().

Since 0.1.0


zif_update_get_changelog ()

GPtrArray *         zif_update_get_changelog            (ZifUpdate *update);

Gets the changelog for this update.

update :

A ZifUpdate

Returns :

A refcounted GPtrArray of ZifChangeset's, or NULL. Free with g_ptr_array_unref().

Since 0.1.0


zif_update_set_state ()

void                zif_update_set_state                (ZifUpdate *update,
                                                         ZifUpdateState state);

Sets the update state status.

update :

A ZifUpdate

state :

If the update is state

Since 0.1.0


zif_update_set_kind ()

void                zif_update_set_kind                 (ZifUpdate *update,
                                                         ZifUpdateKind kind);

Sets the kind of update.

update :

A ZifUpdate

kind :

The update kind, e.g. PK_INFO_ENUM_SECURITY.

Since 0.1.0


zif_update_set_id ()

void                zif_update_set_id                   (ZifUpdate *update,
                                                         const gchar *id);

Sets the update ID.

update :

A ZifUpdate

id :

The update ID

Since 0.1.0


zif_update_set_title ()

void                zif_update_set_title                (ZifUpdate *update,
                                                         const gchar *title);

Sets the update title.

update :

A ZifUpdate

title :

The update title

Since 0.1.0


zif_update_set_description ()

void                zif_update_set_description          (ZifUpdate *update,
                                                         const gchar *description);

Sets the update description.

update :

A ZifUpdate

description :

The update description

Since 0.1.0


zif_update_set_issued ()

void                zif_update_set_issued               (ZifUpdate *update,
                                                         const gchar *issued);

Sets the time the update was issued.

update :

A ZifUpdate

issued :

The update issued time

Since 0.1.0


zif_update_set_source ()

void                zif_update_set_source               (ZifUpdate *update,
                                                         const gchar *source);

Sets the source of the updates, which is normally an email address.

update :

A ZifUpdate

source :

The update source email

Since 0.1.3


zif_update_set_reboot ()

void                zif_update_set_reboot               (ZifUpdate *update,
                                                         gboolean reboot);

Sets the update reboot status

update :

A ZifUpdate

reboot :

if the update requires a reboot

Since 0.1.0


zif_update_add_update_info ()

void                zif_update_add_update_info          (ZifUpdate *update,
                                                         ZifUpdateInfo *update_info);

Adds some update info to the update.

update :

A ZifUpdate

update_info :

A ZifUpdateInfo

Since 0.1.0


zif_update_add_package ()

void                zif_update_add_package              (ZifUpdate *update,
                                                         ZifPackage *package);

Adds some update info to the update.

update :

A ZifUpdate

package :

A ZifPackage

Since 0.1.0


zif_update_add_changeset ()

void                zif_update_add_changeset            (ZifUpdate *update,
                                                         ZifChangeset *changeset);

Adds a changeset to the update.

update :

A ZifUpdate

changeset :

A ZifChangeset

Since 0.1.0


ZifUpdatePrivate

typedef struct _ZifUpdatePrivate ZifUpdatePrivate;