ZifUpdate

## ZifUpdate ZifUpdate — Information about an update |

## Synopsis

    #define             ZIF_UPDATE_ERROR
    struct              ZifUpdate;
    struct              ZifUpdateClass;
    enum                ZifUpdateKind;
    enum                ZifUpdateState;
    GPtrArray *         zif_update_get_changelog            (ZifUpdate *update);
    const gchar *       zif_update_get_description          (ZifUpdate *update);
    const gchar *       zif_update_get_id                   (ZifUpdate *update);
    const gchar *       zif_update_get_issued               (ZifUpdate *update);
    ZifUpdateKind       zif_update_get_kind                 (ZifUpdate *update);
    GPtrArray *         zif_update_get_packages             (ZifUpdate *update);
    gboolean            zif_update_get_reboot               (ZifUpdate *update);
    const gchar *       zif_update_get_source               (ZifUpdate *update);
    ZifUpdateState      zif_update_get_state                (ZifUpdate *update);
    const gchar *       zif_update_get_title                (ZifUpdate *update);
    GPtrArray *         zif_update_get_update_infos         (ZifUpdate *update);
    ZifUpdateKind       zif_update_kind_from_string         (const gchar *kind);
    const gchar *       zif_update_kind_to_string           (ZifUpdateKind kind);
    ZifUpdate *         zif_update_new                      (void);
    ZifUpdateState      zif_update_state_from_string        (const gchar *state);
    const gchar *       zif_update_state_to_string          (ZifUpdateState state);

## Object Hierarchy

      GObject
       +----ZifUpdate

## Properties

      "description"              gchar*                : Read
      "id"                       gchar*                : Read
      "issued"                   gchar*                : Read
      "kind"                     guint                 : Read
      "reboot"                   gboolean              : Read
      "source"                   gchar*                : Read
      "state"                    guint                 : Read
      "title"                    gchar*                : Read

## Description

## Details

### ZIF_UPDATE_ERROR

    #define ZIF_UPDATE_ERROR (zif_update_error_quark ())

### struct ZifUpdate

    struct ZifUpdate;

### struct ZifUpdateClass

    struct ZifUpdateClass {
    	GObjectClass		 parent_class;
    	/* Padding for future expansion */
    	void (*_zif_reserved1) (void);
    	void (*_zif_reserved2) (void);
    	void (*_zif_reserved3) (void);
    	void (*_zif_reserved4) (void);
    };

### 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;

`ZIF_UPDATE_KIND_BUGFIX` |
`ZIF_UPDATE_KIND_SECURITY` |
`ZIF_UPDATE_KIND_ENHANCEMENT` |
`ZIF_UPDATE_KIND_NEWPACKAGE` |
`ZIF_UPDATE_KIND_UNKNOWN` |

### enum ZifUpdateState

    typedef enum {
    	ZIF_UPDATE_STATE_STABLE,
    	ZIF_UPDATE_STATE_TESTING,
    	ZIF_UPDATE_STATE_UNKNOWN
    } ZifUpdateState;

`ZIF_UPDATE_STATE_STABLE` |
`ZIF_UPDATE_STATE_TESTING` |
`ZIF_UPDATE_STATE_UNKNOWN` |

### 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`. [element-type ZifChangeset][transfer container]

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_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_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_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_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`. [element-type ZifPackage][transfer container]

Since 0.1.0

### 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_source ()

    const gchar *       zif_update_get_source               (ZifUpdate *update);

Gets the source of the update, e.g. "updates`fedoraproject.org`".

`update` : | A ZifUpdate
Returns : | A string value, or `NULL`.

Since 0.1.3

### 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_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_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`. [element-type ZifUpdateInfo][transfer container]

Since 0.1.0

### zif_update_kind_from_string ()

    ZifUpdateKind       zif_update_kind_from_string         (const gchar *kind);

### zif_update_kind_to_string ()

    const gchar *       zif_update_kind_to_string           (ZifUpdateKind kind);

### 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_state_to_string ()

    const gchar *       zif_update_state_to_string          (ZifUpdateState state);

## Property Details

### The `"description"` property

      "description"              gchar*                : Read

Default value: NULL

Since 0.1.0

### The `"id"` property

      "id"                       gchar*                : Read

Default value: NULL

Since 0.1.0

### The `"issued"` property

      "issued"                   gchar*                : Read

Default value: NULL

Since 0.1.0

### The `"kind"` property

      "kind"                     guint                 : Read

Default value: 0

Since 0.1.0

### The `"reboot"` property

      "reboot"                   gboolean              : Read

Default value: FALSE

Since 0.1.0

### The `"source"` property

      "source"                   gchar*                : Read

Default value: NULL

Since 0.1.3

### The `"state"` property

      "state"                    guint                 : Read

Default value: 0

Since 0.1.0

### The `"title"` property

      "title"                    gchar*                : Read

Default value: NULL

Since 0.1.0