ZIF_PACKAGE_ERROR

#define ZIF_PACKAGE_ERROR		(zif_package_error_quark ())

enum ZifPackageEnsureType

typedef enum {
	ZIF_PACKAGE_ENSURE_TYPE_FILES,
	ZIF_PACKAGE_ENSURE_TYPE_SUMMARY,
	ZIF_PACKAGE_ENSURE_TYPE_LICENCE,
	ZIF_PACKAGE_ENSURE_TYPE_DESCRIPTION,
	ZIF_PACKAGE_ENSURE_TYPE_URL,
	ZIF_PACKAGE_ENSURE_TYPE_SIZE,
	ZIF_PACKAGE_ENSURE_TYPE_GROUP,
	ZIF_PACKAGE_ENSURE_TYPE_CATEGORY,
	ZIF_PACKAGE_ENSURE_TYPE_REQUIRES,
	ZIF_PACKAGE_ENSURE_TYPE_PROVIDES,
	ZIF_PACKAGE_ENSURE_TYPE_CONFLICTS,
	ZIF_PACKAGE_ENSURE_TYPE_OBSOLETES,
	ZIF_PACKAGE_ENSURE_TYPE_CACHE_FILENAME,
	ZIF_PACKAGE_ENSURE_TYPE_SOURCE_FILENAME, /* Since: 0.2.5 */
	ZIF_PACKAGE_ENSURE_TYPE_LAST
} ZifPackageEnsureType;

enum ZifPackageTrustKind

typedef enum {
	ZIF_PACKAGE_TRUST_KIND_UNKNOWN,			/* must be first */
	ZIF_PACKAGE_TRUST_KIND_NONE,
	ZIF_PACKAGE_TRUST_KIND_PUBKEY,
	ZIF_PACKAGE_TRUST_KIND_PUBKEY_UNVERIFIED, /* Since: 0.2.4 */
	ZIF_PACKAGE_TRUST_KIND_LAST
} ZifPackageTrustKind;

enum ZifPackageCompareMode

typedef enum {
	ZIF_PACKAGE_COMPARE_MODE_VERSION,
	ZIF_PACKAGE_COMPARE_MODE_DISTRO,
	ZIF_PACKAGE_COMPARE_MODE_UNKNOWN
} ZifPackageCompareMode;

enum ZifPackageCompareFlags

typedef enum {
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_NAME		= 1,
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_ARCH		= 2,
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_INSTALLED = 4,
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_VERSION		= 8,
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_DATA		= 16,
	ZIF_PACKAGE_COMPARE_FLAG_CHECK_LAST
} ZifPackageCompareFlags;

struct ZifPackage

struct ZifPackage;

struct ZifPackageClass

struct ZifPackageClass {
	GObjectClass parent_class;

	/* vtable */
	gboolean	 (*ensure_data)			(ZifPackage *package,
							 ZifPackageEnsureType type,
							 ZifState *state,
							 GError		**error);
	/* Padding for future expansion */
	void (*_zif_reserved1) (void);
	void (*_zif_reserved2) (void);
	void (*_zif_reserved3) (void);
	void (*_zif_reserved4) (void);
};

enum ZifPackageError

typedef enum {
	ZIF_PACKAGE_ERROR_FAILED,
	ZIF_PACKAGE_ERROR_NO_SUPPORT,
	ZIF_PACKAGE_ERROR_LAST
} ZifPackageError;

zif_package_error_quark ()

GQuark              zif_package_error_quark             (void);

Since 0.1.0

zif_package_new ()

ZifPackage *        zif_package_new                     (void);

Since 0.1.0

zif_package_get_id ()

const gchar *       zif_package_get_id                  (ZifPackage *package);

Gets the id uniquely identifying the package in all repos.

Since 0.1.0

zif_package_get_id_basic ()

const gchar *       zif_package_get_id_basic            (ZifPackage *package);

Gets the package ID without the ":repo" suffix.

Since 0.2.5

zif_package_get_printable ()

const gchar *       zif_package_get_printable           (ZifPackage *package);

Gets a string that identifies the package, and is printable

Since 0.1.3

zif_package_get_name_arch ()

const gchar *       zif_package_get_name_arch           (ZifPackage *package);

Gets a string which is the package name and architecture. This is often useful for matching on a multiarch system.

Since 0.1.6

zif_package_get_name_version ()

const gchar *       zif_package_get_name_version        (ZifPackage *package);

Gets a string which is the package name and version.

Since 0.2.4

zif_package_get_name_version_arch ()

const gchar *       zif_package_get_name_version_arch   (ZifPackage *package);

Gets a string which is the package name, version and arch.

Since 0.2.4

zif_package_get_name ()

const gchar *       zif_package_get_name                (ZifPackage *package);

Gets the package name.

Since 0.1.0

zif_package_get_version ()

const gchar *       zif_package_get_version             (ZifPackage *package);

Gets the package version.

Since 0.1.1

zif_package_get_version_arch ()

const gchar *       zif_package_get_version_arch        (ZifPackage *package);

Gets a string which is the version and arch.

Since 0.2.9

zif_package_get_arch ()

const gchar *       zif_package_get_arch                (ZifPackage *package);

Gets the package architecture, e.g. "i386".

Since 0.1.1

zif_package_get_data ()

const gchar *       zif_package_get_data                (ZifPackage *package);

Gets the package source data, e.g. "fedora".

Since 0.1.1

zif_package_get_trust_kind ()

ZifPackageTrustKind zif_package_get_trust_kind          (ZifPackage *package);

Gets the package trusted status. Packages that are trusted are usually signed by a trusted private key.

The trust value ZIF_PACKAGE_TRUST_KIND_PUBKEY will not be set on a package until zif_transaction_prepare() has been called and the actual package has been downloaded and verified.

Packages that are supposed to be trusted but cannot be verified have the trust value ZIF_PACKAGE_TRUST_KIND_PUBKEY_UNVERIFIED. This is _only_ an indication that the repository that the package is supposed to come from has public key signing enabled.

Since 0.1.3

zif_package_get_summary ()

const gchar *       zif_package_get_summary             (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the package summary.

Since 0.1.0

zif_package_get_description ()

const gchar *       zif_package_get_description         (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the package description.

Since 0.1.0

zif_package_get_license ()

const gchar *       zif_package_get_license             (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the package licence.

Since 0.1.0

zif_package_get_url ()

const gchar *       zif_package_get_url                 (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the homepage URL for the package.

Since 0.1.0

zif_package_get_filename ()

const gchar *       zif_package_get_filename            (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the remote filename for the package, e.g. Packages/net-snmp-5.4.2-3.fc10.i386.rpm

Since 0.1.0

zif_package_get_category ()

const gchar *       zif_package_get_category            (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the category the packag is in.

Since 0.1.0

zif_package_get_group ()

const gchar *       zif_package_get_group               (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the package group.

Since 0.1.0

zif_package_get_pkgid ()

const gchar *       zif_package_get_pkgid               (ZifPackage *package);

Gets the package pkgid, which is normally the SHA1 hash of the header. Every package has a pkgid, either virtual, local or remote. This function cannot fail.

Since 0.1.3

zif_package_get_cache_filename ()

const gchar *       zif_package_get_cache_filename      (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the filename used to create this package when using zif_package_local_set_from_filename() for a local package or the filename of the cached file for a remote package.

For example, the full local path of a remote package would be: /var/cache/yum/i386/fedora/hal-0.5.7-1.fc13.rpm

Since 0.1.3

zif_package_get_source_filename ()

const gchar *       zif_package_get_source_filename     (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the source RPM filename.

Since 0.2.5

zif_package_get_cache_file ()

GFile *             zif_package_get_cache_file          (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the GFile used to create this package when using zif_package_local_set_from_filename() for a local package or the filename of the cached file for a remote package.

Since 0.1.3

zif_package_get_size ()

guint64             zif_package_get_size                (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the size of the package. This is the installed size for installed packages, and the download size for remote packages.

Since 0.1.0

zif_package_get_files ()

GPtrArray *         zif_package_get_files               (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets the file list for the package.

Since 0.1.0

zif_package_get_requires ()

GPtrArray *         zif_package_get_requires            (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Gets all the package requires.

Since 0.1.0

zif_package_get_provides ()

GPtrArray *         zif_package_get_provides            (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Get all the package provides.

Since 0.1.0

zif_package_get_obsoletes ()

GPtrArray *         zif_package_get_obsoletes           (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Get all the package obsoletes.

Since 0.1.3

zif_package_get_conflicts ()

GPtrArray *         zif_package_get_conflicts           (ZifPackage *package,
                                                         ZifState *state,
                                                         GError **error);

Get all the package conflicts.

Since 0.1.3

zif_package_get_time_file ()

guint64             zif_package_get_time_file           (ZifPackage *package);

Get the time the file was created.

Since 0.1.2

zif_package_provides ()

gboolean            zif_package_provides                (ZifPackage *package,
                                                         ZifDepend *depend,
                                                         ZifDepend **satisfies,
                                                         ZifState *state,
                                                         GError **error);

Gets the package dependency that satisfies the supplied dependency.

Since 0.1.3

zif_package_conflicts ()

gboolean            zif_package_conflicts               (ZifPackage *package,
                                                         ZifDepend *depend,
                                                         ZifDepend **satisfies,
                                                         ZifState *state,
                                                         GError **error);

Gets the package dependency that satisfies the supplied dependency.

Since 0.1.3

zif_package_requires ()

gboolean            zif_package_requires                (ZifPackage *package,
                                                         ZifDepend *depend,
                                                         ZifDepend **satisfies,
                                                         ZifState *state,
                                                         GError **error);

Gets the package dependency that satisfies the supplied dependency.

Since 0.1.3

zif_package_obsoletes ()

gboolean            zif_package_obsoletes               (ZifPackage *package,
                                                         ZifDepend *depend,
                                                         ZifDepend **satisfies,
                                                         ZifState *state,
                                                         GError **error);

Gets the package dependency that satisfies the supplied dependency.

Since 0.1.3

zif_package_get_package_id ()

const gchar *       zif_package_get_package_id          (ZifPackage *package);

Gets the id (as text) uniquely identifying the package in all repos. DO NOT USE THIS FUNCTION. Use zif_package_get_id() instead.

Since 0.1.0

zif_package_print ()

void                zif_package_print                   (ZifPackage *package);

Prints details about a package to STDOUT.

Since 0.1.0

zif_package_is_devel ()

gboolean            zif_package_is_devel                (ZifPackage *package);

Finds out if a package is a development package.

Since 0.1.0

zif_package_is_gui ()

gboolean            zif_package_is_gui                  (ZifPackage *package);

Finds out if a package is a GUI package.

Since 0.1.0

zif_package_is_installed ()

gboolean            zif_package_is_installed            (ZifPackage *package);

Finds out if a package is installed.

Since 0.1.0

zif_package_is_free ()

gboolean            zif_package_is_free                 (ZifPackage *package);

Check the string license_text for free licenses, indicated by their short names as documented at http://fedoraproject.org/wiki/Licensing

Licenses can be grouped by " or " to indicate that the package can be redistributed under any of the licenses in the group. For instance: GPLv2+ or Artistic or FooLicense.

Also, if a license ends with "+", the "+" is removed before comparing it to the list of valid licenses. So if license "FooLicense" is free, then "FooLicense+" is considered free.

Groups of licenses can be grouped with " and " to indicate that parts of the package are distributed under one group of licenses, while other parts of the package are distributed under another group. Groups may be wrapped in parenthesis. For instance: (GPLv2+ or Artistic) and (GPL+ or Artistic) and FooLicense.

At least one license in each group must be free for the package to be considered Free Software. If the license_text is empty, the package is considered non-free.

Since 0.1.0

zif_package_is_native ()

gboolean            zif_package_is_native               (ZifPackage *package);

Finds out if a package is the native architecture for the system.

Since 0.1.0

zif_package_compare ()

gint                zif_package_compare                 (ZifPackage *a,
                                                         ZifPackage *b);

Compares one package versions against each other. If the package names or architectures are different, then an error is returned.

Since 0.1.0

zif_package_compare_full ()

gint                zif_package_compare_full            (ZifPackage *a,
                                                         ZifPackage *b,
                                                         ZifPackageCompareFlags flags);

Compares one package versions against each other. The order for comparison is, assuming all flags are set:

1. ZifPackage object 2. Installed status (optional) 3. Name (optional) 4. Architecture compatibility (optional) 5. Version (optional) 6. Repo name (optional)

Since 0.2.1

zif_package_is_compatible_arch ()

gboolean            zif_package_is_compatible_arch      (ZifPackage *a,
                                                         ZifPackage *b);

Finds if the package architectures are compatible. In this sense, i386 is compatible with i586, but not x86_64

Since 0.1.3

zif_package_ensure_type_to_string ()

const gchar *       zif_package_ensure_type_to_string   (ZifPackageEnsureType type);

Gets the string representation of a ZifPackageEnsureType

Since 0.1.3

zif_package_trust_kind_to_string ()

const gchar *       zif_package_trust_kind_to_string    (ZifPackageTrustKind trust_kind);

Gets the string representation of a ZifPackageTrustKind

Since 0.1.3

zif_package_set_compare_mode ()

void                zif_package_set_compare_mode        (ZifPackage *package,
                                                         ZifPackageCompareMode compare_mode);

Sets the compare mode for packages.

Since 0.2.1

zif_package_compare_mode_from_string ()

ZifPackageCompareMode zif_package_compare_mode_from_string
                                                        (const gchar *value);

Converts a string to a ZifPackageCompareMode.

Since 0.2.1

zif_package_compare_mode_to_string ()

const gchar *       zif_package_compare_mode_to_string  (ZifPackageCompareMode value);

Converts the ZifPackageCompareMode to a string.

Since 0.2.1