Enums

Details

class AppStream.AgreementKind(value)

Bases: GObject.GEnum

The kind of the agreement.

classmethod from_string(value)
Parameters:

value (str) – the string.

Returns:

a AppStream.AgreementKind or AppStream.AgreementKind.UNKNOWN for unknown

Return type:

AppStream.AgreementKind

Converts the text representation to an enumerated value.

New in version 0.12.1.

classmethod to_string(value)
Parameters:

value (AppStream.AgreementKind) – the AppStream.AgreementKind.

Returns:

string version of value

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.12.1.

UNKNOWN = 0

Unknown value

GENERIC = 1

A generic agreement without a specific type

EULA = 2

An End User License Agreement

PRIVACY = 3

A privacy agreement, typically a GDPR statement

class AppStream.ArtifactKind(value)

Bases: GObject.GEnum

The artifact type.

classmethod from_string(kind)
Parameters:

kind (str) – the string.

Returns:

a AppStream.ArtifactKind, or AppStream.ArtifactKind.UNKNOWN for unknown.

Return type:

AppStream.ArtifactKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ArtifactKind) – the AppStream.ArtifactKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Type invalid or not known

SOURCE = 1

The artifact describes software sources.

BINARY = 2

The artifact describes a binary distribution of the component.

class AppStream.BundleKind(value)

Bases: GObject.GEnum

The bundle type.

classmethod from_string(bundle_str)
Parameters:

bundle_str (str) – the string.

Returns:

a AppStream.BundleKind or AppStream.BundleKind.UNKNOWN for unknown

Return type:

AppStream.BundleKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.BundleKind) – the AppStream.BundleKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.8.0.

UNKNOWN = 0

Type invalid or not known

PACKAGE = 1

A native package (currently not used)

LIMBA = 2

A Limba bundle

FLATPAK = 3

A Flatpak bundle

APPIMAGE = 4

An AppImageKit bundle

SNAP = 5

A Snap/Snappy bundle

TARBALL = 6

A (maybe compressed) tarball.

CABINET = 7

Cabinet firmware deployment

LINGLONG = 8

A Linglong bundle

class AppStream.ChassisKind(value)

Bases: GObject.GEnum

The type of chassis a computing device is built into.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.ChassisKind or AppStream.ChassisKind.UNKNOWN for unknown

Return type:

AppStream.ChassisKind

Converts the text representation to an enumerated value.

New in version 1.0.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.ChassisKind) – the AppStream.ChassisKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 1.0.0.

UNKNOWN = 0

Unknown chassis.

DESKTOP = 1

A desktop/workstation

LAPTOP = 2

A mobile computer with a bigger screen / laptop

SERVER = 3

A server, often without GUI

TABLET = 4

A tablet with touch as primary input method

HANDSET = 5

A smaller touch-input device, like a smartphone

class AppStream.CheckResult(value)

Bases: GObject.GEnum

Result of a check operation.

ERROR = 0

The check failed.

UNKNOWN = 1

The outcome could not be determined.

FALSE = 2

False/No

TRUE = 3

True/Yes

class AppStream.ChecksumKind(value)

Bases: GObject.GEnum

Checksums supported by AppStream.Release

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.ChecksumKind or AppStream.ChecksumKind.NONE for unknown

Return type:

AppStream.ChecksumKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ChecksumKind) – the AppStream.ChecksumKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

NONE = 0

No checksum

SHA1 = 1

SHA1 checksum

SHA256 = 2

SHA256 checksum

SHA512 = 3

SHA512 checksum

BLAKE2B = 4

BLAKE2 checksum

BLAKE3 = 5

BLAKE3 checksum

class AppStream.ColorKind(value)

Bases: GObject.GEnum

A branding color type.

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.ColorKind or AppStream.ColorKind.UNKNOWN for unknown.

Return type:

AppStream.ColorKind

Converts the text representation to an enumerated value.

New in version 0.15.2.

classmethod to_string(kind)
Parameters:

kind (AppStream.ColorKind) – the AppStream.ColorKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.15.2.

UNKNOWN = 0

Color type invalid or not known

PRIMARY = 1

Primary accent color

class AppStream.ColorSchemeKind(value)

Bases: GObject.GEnum

A color scheme type.

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.ColorKind or AppStream.ColorSchemeKind.UNKNOWN for unknown.

Return type:

AppStream.ColorSchemeKind

Converts the text representation to an enumerated value.

New in version 0.15.2.

classmethod to_string(kind)
Parameters:

kind (AppStream.ColorSchemeKind) – the AppStream.ColorSchemeKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.15.2.

UNKNOWN = 0

Color scheme invalid or not known

LIGHT = 1

A light color scheme

DARK = 2

A dark color scheme

class AppStream.ComponentKind(value)

Bases: GObject.GEnum

The type of an AppStream.Component.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.ComponentKind or AppStream.ComponentKind.UNKNOWN for unknown

Return type:

AppStream.ComponentKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ComponentKind) – the AppStream.ComponentKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Type invalid or not known

GENERIC = 1

A generic (= without specialized type) component

INPUT_METHOD = 10

An input-method provider

OPERATING_SYSTEM = 11

A computer operating system

FIRMWARE = 12

Firmware

DRIVER = 13

A driver

LOCALIZATION = 14

Software localization (usually l10n resources)

REPOSITORY = 15

A remote software or data source

ICON_THEME = 16

An icon theme following the XDG specification

DESKTOP_APP = 2

An application with a .desktop-file

CONSOLE_APP = 3

A console application

WEB_APP = 4

A web application

SERVICE = 5

A system service launched by the init system

ADDON = 6

An extension of existing software, which does not run standalone

RUNTIME = 7

An application runtime platform

FONT = 8

A font

CODEC = 9

A multimedia codec

class AppStream.ComponentScope(value)

Bases: GObject.GEnum

Scope of the AppStream.Component (system-wide or user-scope)

classmethod from_string(scope_str)
Parameters:

scope_str (str) – the string.

Returns:

a AppStream.ComponentScope or AppStream.ComponentScope.UNKNOWN for unknown

Return type:

AppStream.ComponentScope

Converts the text representation to an enumerated value.

classmethod to_string(scope)
Parameters:

scope (AppStream.ComponentScope) – the AppStream.ComponentScope.

Returns:

string version of scope

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown scope

SYSTEM = 1

System scope

USER = 2

User scope

class AppStream.ContentRatingSystem(value)

Bases: GObject.GEnum

A content rating system for a particular territory.

New in version 0.12.12.

classmethod format_age(system, age)
Parameters:
Returns:

a newly allocated formatted version of age, or None if the given system has no representation for age

Return type:

str or None

Format age as a human-readable string in the given rating system. This is the way to present system-specific strings in a UI.

New in version 0.12.12.

classmethod from_locale(locale)
Parameters:

locale (str) – a locale, in the format described in man 3 setlocale

Returns:

the most relevant AppStream.ContentRatingSystem

Return type:

AppStream.ContentRatingSystem

Determine the most appropriate AppStream.ContentRatingSystem for the given locale. Content rating systems are selected by territory. If no content rating system seems suitable, AppStream.ContentRatingSystem.IARC is returned.

New in version 0.12.12.

classmethod get_csm_ages(system)
Parameters:

system (AppStream.ContentRatingSystem) – an AppStream.ContentRatingSystem

Returns:

an array of CSM ages

Return type:

[int]

Get the CSM ages corresponding to the entries returned by AppStream.ContentRatingSystem.get_formatted_ages() for this system.

New in version 0.12.12.

classmethod get_formatted_ages(system)
Parameters:

system (AppStream.ContentRatingSystem) – an AppStream.ContentRatingSystem

Returns:

None-terminated array of human-readable age strings

Return type:

[str]

Get an array of all the possible return values of AppStream.ContentRatingSystem.format_age() for the given system. The array is sorted with youngest CSM age first.

New in version 0.12.12.

classmethod to_string(system)
Parameters:

system (AppStream.ContentRatingSystem) – an AppStream.ContentRatingSystem

Returns:

a human-readable string for system, or None if unknown

Return type:

str or None

Get a human-readable string to identify system. None will be returned for AppStream.ContentRatingSystem.UNKNOWN.

New in version 0.12.12.

UNKNOWN = 0

Unknown ratings system

INCAA = 1

INCAA

OFLCNZ = 10

OFLCNZ

RUSSIA = 11

Russia

MDA = 12

MDA

GRAC = 13

GRAC

ESRB = 14

ESRB

IARC = 15

IARC

ACB = 2

ACB

DJCTQ = 3

DJCTQ

GSRR = 4

GSRR

PEGI = 5

PEGI

KAVI = 6

KAVI

USK = 7

USK

ESRA = 8

ESRA

CERO = 9

CERO

class AppStream.ContentRatingValue(value)

Bases: GObject.GEnum

The specified level of an content_rating rating ID.

classmethod from_string(value)
Parameters:

value (str) – the string.

Returns:

a AppStream.ContentRatingValue or AppStream.ContentRatingValue.UNKNOWN for unknown

Return type:

AppStream.ContentRatingValue

Converts the text representation to an enumerated value.

New in version 0.11.0.

classmethod to_string(value)
Parameters:

value (AppStream.ContentRatingValue) – the AppStream.ContentRatingValue.

Returns:

string version of value

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.11.0.

UNKNOWN = 0

Unknown value

NONE = 1

None

MILD = 2

A small amount

MODERATE = 3

A moderate amount

INTENSE = 4

An intense amount

class AppStream.ControlKind(value)

Bases: GObject.GEnum

Kind of an input method for users to control software

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.ControlKind or AppStream.ControlKind.UNKNOWN for unknown

Return type:

AppStream.ControlKind

Converts the text representation to an enumerated value.

New in version 0.12.11.

classmethod to_string(kind)
Parameters:

kind (AppStream.ControlKind) – the AppStream.ControlKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.12.11.

UNKNOWN = 0

Unknown kind

POINTING = 1

Mouse/cursors/other precision pointing device

KEYBOARD = 2

Keyboard input

CONSOLE = 3

Console / command-line interface

TOUCH = 4

Touch input

GAMEPAD = 5

Gamepad input (any game controller with wheels/buttons/joysticks)

VOICE = 6

Control via voice recognition/activation

VISION = 7

Computer vision / visual object and sign detection

TV_REMOTE = 8

Input via a television remote

TABLET = 9

Graphics tablet input

class AppStream.DisplaySideKind(value)

Bases: GObject.GEnum

Side a display_length requirement is for.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.DisplaySideKind or AppStream.DisplaySideKind.UNKNOWN for unknown

Return type:

AppStream.DisplaySideKind

Converts the text representation to an enumerated value.

New in version 0.12.12.

classmethod to_string(kind)
Parameters:

kind (AppStream.DisplaySideKind) – the AppStream.DisplaySideKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.12.12.

UNKNOWN = 0

Unknown

SHORTEST = 1

Shortest side of the display rectangle.

LONGEST = 2

Longest side of the display rectangle.

class AppStream.FormatKind(value)

Bases: GObject.GEnum

Format of the AppStream metadata.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.FormatKind or AppStream.FormatKind.UNKNOWN for unknown

Return type:

AppStream.FormatKind

Converts the text representation to an enumerated value.

New in version 0.10.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.FormatKind) – the AppStream.FormatKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.10.0.

UNKNOWN = 0

Unknown metadata format.

XML = 1

AppStream XML metadata.

YAML = 2

AppStream YAML (DEP-11) metadata.

DESKTOP_ENTRY = 3

XDG Desktop Entry data.

class AppStream.FormatStyle(value)

Bases: GObject.GEnum

There are a few differences between AppStream’s metainfo files (shipped by upstream projects) and the catalog metadata (shipped by distributors). The data source kind indicates which style we should process. Usually you do not want to set this explicitly.

UNKNOWN = 0

The format style is unknown.

METAINFO = 1

Parse AppStream upstream metadata (metainfo files)

CATALOG = 2

Parse AppStream metadata catalog (shipped by software distributors)

class AppStream.FormatVersion(value)

Bases: GObject.GEnum

Format version / API level of the AppStream metadata.

classmethod from_string(version_str)
Parameters:

version_str (str) – the string.

Returns:

a AppStream.FormatVersion. For unknown, the highest version number is assumed.

Return type:

AppStream.FormatVersion

Converts the text representation to an enumerated value.

New in version 0.10.0.

classmethod to_string(version)
Parameters:

version (AppStream.FormatVersion) – the AppStream.FormatKind.

Returns:

string version of version

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.10.0.

UNKNOWN = 0

Unknown format version

V1_0 = 1

1.0

class AppStream.IconKind(value)

Bases: GObject.GEnum

The icon type.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.IconKind or AppStream.IconKind.UNKNOWN for unknown

Return type:

AppStream.IconKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.IconKind) – the AppStream.IconKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown icon kind

STOCK = 1

Stock icon name

CACHED = 2

Icon in the internal caches

LOCAL = 3

Local icon name

REMOTE = 4

Remote icon URL

class AppStream.ImageKind(value)

Bases: GObject.GEnum

The image type.

classmethod from_string(kind)
Parameters:

kind (str) – the string.

Returns:

a AppStream.ImageKind, or AppStream.ImageKind.UNKNOWN for unknown.

Return type:

AppStream.ImageKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ImageKind) – the AppStream.ImageKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Type invalid or not known

SOURCE = 1

The source image at full resolution

THUMBNAIL = 2

A thumbnail at reduced resolution

class AppStream.InternetKind(value)

Bases: GObject.GEnum

Different internet connectivity requirements or recommendations for an application.

New in version 0.15.5.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.InternetKind or AppStream.InternetKind.UNKNOWN for unknown

Return type:

AppStream.InternetKind

Converts the text representation to an enumerated value.

New in version 0.15.5.

classmethod to_string(kind)
Parameters:

kind (AppStream.InternetKind) – the AppStream.InternetKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.15.5.

UNKNOWN = 0

Unknown

ALWAYS = 1

Always requires/recommends internet

OFFLINE_ONLY = 2

Application is offline-only

FIRST_RUN = 3

Requires/Recommends internet on first run only

class AppStream.IssueKind(value)

Bases: GObject.GEnum

Checksums supported by AppStream.Release

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.IssueKind or AppStream.IssueKind.UNKNOWN for unknown

Return type:

AppStream.IssueKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.IssueKind) – the AppStream.IssueKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown issue type

GENERIC = 1

Generic issue type

CVE = 2

Common Vulnerabilities and Exposures issue

class AppStream.IssueSeverity(value)

Bases: GObject.GEnum

The severity of an issue found by AppStream.Validator

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.IssueSeverity, or AppStream.IssueSeverity.UNKNOWN for unknown.

Return type:

AppStream.IssueSeverity

Converts the text representation to an enumerated value.

classmethod to_string(severity)
Parameters:

severity (AppStream.IssueSeverity) – the AppStream.IssueSeverity.

Returns:

string version of severity

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

The severity is unknown.

PEDANTIC = 1

Pedantic information about ways to improve the data, but could also be ignored.

INFO = 2

Non-essential information on how to improve metadata, no immediate action needed.

WARNING = 3

Something metadata issue which should be fixed as soon as possible.

ERROR = 4

There is a serious, fatal error in your metadata

class AppStream.LaunchableKind(value)

Bases: GObject.GEnum

Type of launch system the entries belong to.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.LaunchableKind or AppStream.LaunchableKind.UNKNOWN for unknown

Return type:

AppStream.LaunchableKind

Converts the text representation to an enumerated value.

New in version 0.11.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.LaunchableKind) – the AppStream.LaunchableKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.11.0.

UNKNOWN = 0

Unknown kind

DESKTOP_ID = 1

Launch by desktop-id

SERVICE = 2

A systemd/SysV-init service name

COCKPIT_MANIFEST = 3

A Cockpit manifest / package name

URL = 4

A web HTTPS URL to launch a web application from

class AppStream.MarkupKind(value)

Bases: GObject.GEnum

Text markup types.

UNKNOWN = 0

Unknown markup.

XML = 1

XML markup.

TEXT = 2

Simple text with unicode symbols.

MARKDOWN = 3

Markdown

class AppStream.MergeKind(value)

Bases: GObject.GEnum

Defines how AppStream.Component data should be merged if the component is set for merge.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.MergeKind or AppStream.MergeKind.NONE for unknown

Return type:

AppStream.MergeKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.MergeKind) – the AppStream.MergeKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

NONE = 0

No merge is happening.

REPLACE = 1

Merge replacing data of target.

APPEND = 2

Merge appending data to target.

REMOVE_COMPONENT = 3

Remove the entire component if it matches.

class AppStream.MetadataError(value)

Bases: GObject.GEnum

A metadata processing error.

classmethod quark()
Returns:

An error quark.

Return type:

int

FAILED = 0

Generic failure.

PARSE = 1

Unable to parse the metadata file.

FORMAT_UNEXPECTED = 2

Expected catalog metadata but got metainfo metadata, or vice versa.

NO_COMPONENT = 3

We expected a component in the pool, but couldn’t find one.

VALUE_MISSING = 4

A essential value is missing in the source document.

class AppStream.MetadataLocation(value)

Bases: GObject.GEnum

The flags used when installing and removing metadata files.

UNKNOWN = 0

An unknown/invalid location.

SHARED = 1

Installed by the vendor, shared

STATE = 2

Installed as metadata into /var/lib, shared

CACHE = 3

Installed as metadata into /var/cache, shared

USER = 4

Installed for the current user

class AppStream.PoolError(value)

Bases: GObject.GEnum

A metadata pool error.

classmethod quark()
Returns:

An error quark.

Return type:

int

FAILED = 0

Generic failure

INCOMPLETE = 1

The pool was loaded, but we had to ignore some metadata.

COLLISION = 2

An AppStream-ID collision occured (a component with that ID already existed in the pool)

CACHE_WRITE_FAILED = 3

Unable to write to *any* cache file (not even tmpfs writes worked)

CACHE_DAMAGED = 4

The disk cache was broken and we could not automatically recover.

class AppStream.ProvidedKind(value)

Bases: GObject.GEnum

Type of the public interface components can provide.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.ProvidedKind or AppStream.ProvidedKind.UNKNOWN for unknown

Return type:

AppStream.ProvidedKind

Converts the text representation to an enumerated value.

classmethod to_l10n_string(kind)
Parameters:

kind (AppStream.ProvidedKind) – the AppStream.ProvidedKind.

Returns:

Pluralized, l10n string version of kind

Return type:

str

Converts the enumerated value to a localized text representation, using the plural forms (e.g. “Libraries” instead of “Library”).

This can be useful when displaying provided items in GUI dialogs.

classmethod to_string(kind)
Parameters:

kind (AppStream.ProvidedKind) – the AppStream.ProvidedKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

UNKNOWN = 0

Unknown kind

LIBRARY = 1

A shared library

FIRMWARE_FLASHED = 10

Firmware flashed permanently to the device.

ID = 11

An AppStream component

BINARY = 2

A binary installed into a directory in PATH

MEDIATYPE = 3

Provides a handler for a mimetype

FONT = 4

A font

MODALIAS = 5

A modalias

PYTHON = 6

A Python 3 module

DBUS_SYSTEM = 7

A DBus service name on the system bus.

DBUS_USER = 8

A DBus service name on the user/session bus.

FIRMWARE_RUNTIME = 9

Firmware flashed at runtime.

class AppStream.ReferenceKind(value)

Bases: GObject.GEnum

A reference type.

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.ReferenceKind or AppStream.ReferenceKind.UNKNOWN for unknown

Return type:

AppStream.ReferenceKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ReferenceKind) – the AppStream.ReferenceKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 1.0.0.

UNKNOWN = 0

Unknown reference kind.

DOI = 1

Digital Object Identifier

CITATION_CFF = 2

Web URL to a Citation File Format file

REGISTRY = 3

A generic registry.

class AppStream.RelationCompare(value)

Bases: GObject.GEnum

The relational comparison type.

classmethod from_string(compare_str)
Parameters:

compare_str (str) – the string.

Returns:

a AppStream.RelationCompare, or AppStream.RelationCompare.UNKNOWN for unknown.

Return type:

AppStream.RelationCompare

Converts the text representation to an enumerated value.

New in version 0.12.0.

classmethod to_string(compare)
Parameters:

compare (AppStream.RelationCompare) – the AppStream.RelationCompare.

Returns:

string version of compare

Return type:

str

Converts the enumerated value to an text representation. The enum is converted into a two-letter identifier (“eq”, “ge”, etc.) for use in the XML representation.

New in version 0.12.0.

classmethod to_symbols_string(compare)
Parameters:

compare (AppStream.RelationCompare) – the AppStream.RelationCompare.

Returns:

string version of compare

Return type:

str

Converts the enumerated value to an text representation. The enum is converted into an identifier consisting of two mathematical comparison operators (“==”, “>=”, etc.) for use in the YAML representation and user interfaces.

New in version 0.12.0.

UNKNOWN = 0

Comparison predicate invalid or not known

EQ = 1

Equal to

NE = 2

Not equal to

LT = 3

Less than

GT = 4

Greater than

LE = 5

Less than or equal to

GE = 6

Greater than or equal to

class AppStream.RelationError(value)

Bases: GObject.GEnum

The error type.

classmethod quark()
Returns:

An error quark.

Return type:

int

New in version 0.16.0.

FAILED = 0

Generic failure

BAD_VALUE = 1

A metadata value was bad.

NOT_IMPLEMENTED = 2

Some check was not (yet) implemented.

class AppStream.RelationItemKind(value)

Bases: GObject.GEnum

Type of the item an AppStream.Relation is for.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.RelationItemKind or AppStream.RelationItemKind.UNKNOWN for unknown

Return type:

AppStream.RelationItemKind

Converts the text representation to an enumerated value.

New in version 0.12.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.RelationItemKind) – the AppStream.RelationKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.12.0.

UNKNOWN = 0

Unknown kind

ID = 1

A component ID

MODALIAS = 2

A hardware modalias

KERNEL = 3

An operating system kernel (like Linux)

MEMORY = 4

A system RAM requirement

FIRMWARE = 5

A device firmware requirement (used by fwupd)

CONTROL = 6

An input method for users to control software

DISPLAY_LENGTH = 7

Display edge length

HARDWARE = 8

A Computer Hardware ID (CHID) to depend on system hardware

INTERNET = 9

Internet connectivity

New in version 0.15.5.

class AppStream.RelationKind(value)

Bases: GObject.GEnum

Type of a component’s relation to other items.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.RelationKind or AppStream.RelationKind.UNKNOWN for unknown

Return type:

AppStream.RelationKind

Converts the text representation to an enumerated value.

New in version 0.12.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.RelationKind) – the AppStream.RelationKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

New in version 0.12.0.

UNKNOWN = 0

Unknown kind

REQUIRES = 1

The referenced item is required by the component

RECOMMENDS = 2

The referenced item is recommended

SUPPORTS = 3

The referenced item is supported

class AppStream.RelationStatus(value)

Bases: GObject.GEnum

Status of a relation check result.

UNKNOWN = 0

Unknown status.

ERROR = 1

An error occured and the status could not be checked.

NOT_SATISFIED = 2

The relation is not satisfied.

SATISFIED = 3

The relation is satisfied.

class AppStream.ReleaseKind(value)

Bases: GObject.GEnum

The release kind.

New in version 0.12.0.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

an AppStream.ReleaseKind or AppStream.ReleaseKind.UNKNOWN for unknown

Return type:

AppStream.ReleaseKind

Converts the text representation to an enumerated value.

New in version 0.12.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.ReleaseKind) – the AppStream.ReleaseKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.12.0.

UNKNOWN = 0

Unknown release type

STABLE = 1

A stable release for end-users

DEVELOPMENT = 2

A development release or pre-release for testing

SNAPSHOT = 3

A snapshot of a software being worked on

class AppStream.ReleaseListKind(value)

Bases: GObject.GEnum

The kind of a releases block.

New in version 0.16.0.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

an AppStream.ReleaseKind or AppStream.ReleaseKind.UNKNOWN for unknown

Return type:

AppStream.ReleaseListKind

Converts the text representation to an enumerated value.

New in version 0.16.0.

classmethod to_string(kind)
Parameters:

kind (AppStream.ReleaseListKind) – the AppStream.ReleaseKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.16.0.

UNKNOWN = 0

Unknown releases type

EMBEDDED = 1

Release info is embedded in metainfo file

EXTERNAL = 2

Release info is split to a separate file

class AppStream.ReleaseUrlKind(value)

Bases: GObject.GEnum

AppStream.ReleaseUrlKind.UNKNOWN Unknown release web URL type The release URL kinds.

New in version 0.12.5.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

an AppStream.ReleaseUrlKind or AppStream.ReleaseUrlKind.UNKNOWN for unknown

Return type:

AppStream.ReleaseUrlKind

Converts the text representation to an enumerated value.

New in version 0.12.5.

classmethod to_string(kind)
Parameters:

kind (AppStream.ReleaseUrlKind) – the AppStream.ReleaseUrlKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.12.5.

UNKNOWN = 0
DETAILS = 1

Weblink to detailed release notes.

class AppStream.ScreenshotKind(value)

Bases: GObject.GEnum

The screenshot type.

classmethod from_string(kind)
Parameters:

kind (str) – the string.

Returns:

a AppStream.ScreenshotKind, or AppStream.ScreenshotKind.UNKNOWN if not known.

Return type:

AppStream.ScreenshotKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.ScreenshotKind) – the AppStream.ScreenshotKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Type invalid or not known

DEFAULT = 1

The primary screenshot to show by default

EXTRA = 2

Optional screenshot

class AppStream.ScreenshotMediaKind(value)

Bases: GObject.GEnum

The media kind contained in this screenshot.

UNKNOWN = 0

Media kind is unknown

IMAGE = 1

The screenshot contains images

VIDEO = 2

The screenshot contains videos

class AppStream.SizeKind(value)

Bases: GObject.GEnum

The artifact size kind.

New in version 0.8.6.

classmethod from_string(size_kind)
Parameters:

size_kind (str) – the string.

Returns:

an AppStream.SizeKind or AppStream.SizeKind.UNKNOWN for unknown

Return type:

AppStream.SizeKind

Converts the text representation to an enumerated value.

classmethod to_string(size_kind)
Parameters:

size_kind (AppStream.SizeKind) – the AppStream.SizeKind.

Returns:

string version of size_kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown size

DOWNLOAD = 1

Size of download of component

INSTALLED = 2

Size of installed component

class AppStream.SuggestedKind(value)

Bases: GObject.GEnum

The suggested type.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.SuggestedKind or AppStream.SuggestedKind.UNKNOWN for unknown

Return type:

AppStream.SuggestedKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.SuggestedKind) – the AppStream.SuggestedKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown suggested kind

UPSTREAM = 1

Suggestions provided by the upstream project.

HEURISTIC = 2

Suggestions provided by automatic heuristics.

class AppStream.SystemInfoError(value)

Bases: GObject.GEnum

The error type.

classmethod quark()
Returns:

An error quark.

Return type:

int

New in version 0.16.0.

FAILED = 0

Generic failure

NOT_FOUND = 1

Information was not found.

class AppStream.TranslationKind(value)

Bases: GObject.GEnum

The translation type.

classmethod from_string(kind_str)
Parameters:

kind_str (str) – the string.

Returns:

a AppStream.TranslationKind or AppStream.TranslationKind.UNKNOWN for unknown

Return type:

AppStream.TranslationKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.TranslationKind) – the AppStream.TranslationKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to a text representation.

UNKNOWN = 0

Type invalid or not known

GETTEXT = 1

Gettext translation domain

QT = 2

Qt translation domain

class AppStream.UrgencyKind(value)

Bases: GObject.GEnum

The urgency of an AppStream.Release

classmethod from_string(urgency_kind)
Parameters:

urgency_kind (str) – the string.

Returns:

a AppStream.UrgencyKind or AppStream.UrgencyKind.UNKNOWN for unknown

Return type:

AppStream.UrgencyKind

Converts the text representation to an enumerated value.

New in version 0.6.5.

classmethod to_string(urgency_kind)
Parameters:

urgency_kind (AppStream.UrgencyKind) – the AppStream.UrgencyKind.

Returns:

string version of urgency_kind

Return type:

str

Converts the enumerated value to an text representation.

New in version 0.6.5.

UNKNOWN = 0

Urgency is unknown or not set

LOW = 1

Low urgency

MEDIUM = 2

Medium urgency

HIGH = 3

High urgency

CRITICAL = 4

Critical urgency

class AppStream.UrlKind(value)

Bases: GObject.GEnum

The URL type.

classmethod from_string(url_kind)
Parameters:

url_kind (str) – the string.

Returns:

a AppStream.UrlKind or AppStream.UrlKind.UNKNOWN for unknown

Return type:

AppStream.UrlKind

Converts the text representation to an enumerated value.

classmethod to_string(url_kind)
Parameters:

url_kind (AppStream.UrlKind) – the AppStream.UrlKind.

Returns:

string version of url_kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Type invalid or not known

HOMEPAGE = 1

Project homepage

BUGTRACKER = 2

Bugtracker

FAQ = 3

FAQ page

HELP = 4

Help manual

DONATION = 5

Page with information about how to donate to the project

TRANSLATE = 6

Page with instructions on how to translate the project / submit translations.

CONTACT = 7

Contact the developers

VCS_BROWSER = 8

Browse the source code

CONTRIBUTE = 9

Help developing

class AppStream.UtilsError(value)

Bases: GObject.GEnum

The error type.

classmethod quark()
Returns:

An error quark.

Return type:

int

New in version 0.14.0.

FAILED = 0

Generic failure

class AppStream.ValidatorError(value)

Bases: GObject.GEnum

The error type.

classmethod quark()
Returns:

An error quark.

Return type:

int

New in version 0.15.4.

FAILED = 0

Generic failure

INVALID_OVERRIDE = 1

The issue override was not accepted.

INVALID_FILENAME = 2

The filename was invalid.

class AppStream.VideoCodecKind(value)

Bases: GObject.GEnum

Supported video codecs.

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.VideoCodecKind, or AppStream.VideoCodecKind.UNKNOWN for unknown.

Return type:

AppStream.VideoCodecKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.VideoCodecKind) – the AppStream.VideoCodecKind.

Returns:

string version of codec

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown video codec

VP9 = 1

The VP9 video codec

AV1 = 2

The AV1 video codec

class AppStream.VideoContainerKind(value)

Bases: GObject.GEnum

Supported video codecs.

classmethod from_string(str)
Parameters:

str (str) – the string.

Returns:

a AppStream.VideoContainerKind, or AppStream.VideoContainerKind.UNKNOWN for unknown.

Return type:

AppStream.VideoContainerKind

Converts the text representation to an enumerated value.

classmethod to_string(kind)
Parameters:

kind (AppStream.VideoContainerKind) – the AppStream.VideoContainerKind.

Returns:

string version of kind

Return type:

str

Converts the enumerated value to an text representation.

UNKNOWN = 0

Unknown video container

MKV = 1

The Matroska video (MKV) container

WEBM = 2

The WebM video container