Fwupd.Release¶
- Subclasses:
None
Methods¶
- Inherited:
- Structs:
Virtual Methods¶
- Inherited:
Properties¶
Name |
Type |
Flags |
Short Description |
---|---|---|---|
r/w |
Signals¶
- Inherited:
Fields¶
- Inherited:
Name |
Type |
Access |
Description |
---|---|---|---|
parent_instance |
r |
Class Details¶
- class Fwupd.Release(**kwargs)¶
- Bases:
- Abstract:
No
- Structure:
A firmware release with a specific version.
Devices can have more than one release, and the releases are typically ordered by their version.
See also: [class`FwupdDevice`]
- classmethod array_filter_flags(rels, include, exclude)[source]¶
- Parameters:
rels ([
Fwupd.Release
]) – releasesinclude (
Fwupd.ReleaseFlags
) –Fwupd.ReleaseFlags
, orFwupd.ReleaseFlags.NONE
exclude (
Fwupd.ReleaseFlags
) –Fwupd.ReleaseFlags
, orFwupd.ReleaseFlags.NONE
- Raises:
- Returns:
releases
- Return type:
Creates an array of new releases that match using
Fwupd.Release.match_flags
().New in version 1.9.3.
- classmethod flag_from_string(release_flag)[source]¶
- Parameters:
- Returns:
enumerated value
- Return type:
Converts a string to an enumerated release flag.
New in version 1.2.6.
- classmethod flag_to_string(release_flag)[source]¶
- Parameters:
release_flag (
Fwupd.ReleaseFlags
) – a release flag, e.g.Fwupd.ReleaseFlags.TRUSTED_PAYLOAD
- Returns:
identifier string
- Return type:
Converts an enumerated release flag to a string.
New in version 1.2.6.
- classmethod new()[source]¶
- Returns:
a new
Fwupd.Release
- Return type:
Creates a new release.
New in version 0.9.3.
- classmethod urgency_from_string(release_urgency)[source]¶
- Parameters:
- Returns:
enumerated value
- Return type:
Converts a string to an enumerated release urgency value.
New in version 1.4.0.
- classmethod urgency_to_string(release_urgency)[source]¶
- Parameters:
release_urgency (
Fwupd.ReleaseUrgency
) – a release urgency, e.g.Fwupd.ReleaseUrgency.HIGH
- Returns:
identifier string
- Return type:
Converts an enumerated release urgency to a string.
New in version 1.4.0.
- add_category(category)[source]¶
- Parameters:
category (
str
) – the update category, e.g.X-EmbeddedController
Adds the update category.
New in version 1.2.7.
- add_checksum(checksum)[source]¶
- Parameters:
checksum (
str
) – the update container checksum
Sets the update checksum.
New in version 0.9.3.
- add_flag(flag)[source]¶
- Parameters:
flag (
Fwupd.ReleaseFlags
) – theFwupd.ReleaseFlags
Adds a specific release flag to the release.
New in version 1.2.6.
- add_issue(issue)[source]¶
- Parameters:
issue (
str
) – the update issue, e.g.CVE-2019-12345
Adds an resolved issue to this release.
New in version 1.3.2.
- add_location(location)[source]¶
- Parameters:
location (
str
) – the update URI
Adds an update URI, i.e. where you can download the firmware from.
New in version 1.5.6.
- add_report(report)[source]¶
- Parameters:
report (
Fwupd.Report
) – aFwupd.Report
Adds a report for this release.
New in version 1.8.8.
- add_tag(tag)[source]¶
- Parameters:
tag (
str
) – the update tag, e.g.vendor-factory-2021q1
Adds a specific release tag.
New in version 1.7.3.
- get_categories()[source]¶
- Returns:
the categories, which may be empty
- Return type:
[
str
]
Gets the release categories.
New in version 1.2.7.
- get_checksums()[source]¶
- Returns:
the checksums, which may be empty
- Return type:
[
str
]
Gets the release container checksums.
New in version 0.9.3.
- get_created()[source]¶
- Returns:
UTC timestamp in UNIX format, or 0 if unset
- Return type:
Gets when the update was created.
New in version 1.4.0.
- get_description()[source]¶
-
Gets the update description in AppStream markup format.
New in version 0.9.3.
- get_detach_caption()[source]¶
-
Gets the optional text caption used to manually detach the device.
New in version 1.3.3.
- get_detach_image()[source]¶
-
Gets the optional image used to manually detach the device.
New in version 1.3.3.
- get_flags()[source]¶
- Returns:
release flags, or 0 if unset
- Return type:
Gets the release flags.
New in version 1.2.6.
- get_id()[source]¶
-
Gets the release ID, which allows identifying the specific uploaded component.
New in version 1.7.2.
- get_install_duration()[source]¶
- Returns:
the estimated time to flash this release (or 0 if unset)
- Return type:
Gets the time estimate for firmware installation (in seconds)
New in version 1.2.1.
- get_issues()[source]¶
- Returns:
the issues, which may be empty
- Return type:
[
str
]
Gets the list of issues fixed in this release.
New in version 1.3.2.
- get_locations()[source]¶
- Returns:
the URIs
- Return type:
[
str
]
Gets the update URI, i.e. where you can download the firmware from.
Typically the first URI will be the main HTTP mirror, but all URIs may not be valid HTTP URIs. For example, “ipns://QmSrPmba” is valid here.
New in version 1.5.6.
- get_reports()[source]¶
- Returns:
array of reports
- Return type:
Gets all the reports for this release.
New in version 1.8.8.
- get_size()[source]¶
- Returns:
the update size in bytes, or 0 if unset
- Return type:
Gets the update size.
New in version 0.9.3.
- get_source_url()[source]¶
-
Gets the URL of the source code used to build this release.
New in version 1.2.4.
- get_tags()[source]¶
- Returns:
the tags, which may be empty
- Return type:
[
str
]
Gets the release tags.
New in version 1.7.3.
- get_urgency()[source]¶
- Returns:
the release urgency, or 0 if unset
- Return type:
Gets the release urgency.
New in version 1.4.0.
- has_category(category)[source]¶
- Parameters:
category (
str
) – the update category, e.g.X-EmbeddedController
- Returns:
True
if the release matches- Return type:
Finds out if the release has the update category.
New in version 1.2.7.
- has_checksum(checksum)[source]¶
-
Finds out if the release has the update container checksum.
New in version 1.2.6.
- has_flag(flag)[source]¶
- Parameters:
flag (
Fwupd.ReleaseFlags
) – theFwupd.ReleaseFlags
- Returns:
True
if the flag is set- Return type:
Finds if the release has a specific release flag.
New in version 1.2.6.
- has_tag(tag)[source]¶
- Parameters:
tag (
str
) – the update tag, e.g.vendor-factory-2021q1
- Returns:
True
if the release matches- Return type:
Finds out if the release has a specific tag.
New in version 1.7.3.
- match_flags(include, exclude)[source]¶
- Parameters:
include (
Fwupd.ReleaseFlags
) –Fwupd.ReleaseFlags
, orFwupd.ReleaseFlags.NONE
exclude (
Fwupd.ReleaseFlags
) –Fwupd.ReleaseFlags
, orFwupd.ReleaseFlags.NONE
- Returns:
True
if the release flags match- Return type:
Check if the release flags match.
New in version 1.9.3.
- remove_flag(flag)[source]¶
- Parameters:
flag (
Fwupd.ReleaseFlags
) – theFwupd.ReleaseFlags
Removes a specific release flag from the release.
New in version 1.2.6.
- set_appstream_id(appstream_id)[source]¶
- Parameters:
appstream_id (
str
orNone
) – the AppStream component ID, e.g.org.hughski.ColorHug2.firmware
Sets the AppStream ID.
New in version 0.9.3.
- set_created(created)[source]¶
- Parameters:
created (
int
) – UTC timestamp in UNIX format
Sets when the update was created.
New in version 1.4.0.
- set_detach_caption(detach_caption)[source]¶
-
Sets the optional text caption used to manually detach the device.
New in version 1.3.3.
- set_detach_image(detach_image)[source]¶
-
Sets the optional image used to manually detach the device.
New in version 1.3.3.
- set_details_url(details_url)[source]¶
-
Sets the URL for the online update notes.
New in version 1.2.4.
- set_flags(flags)[source]¶
- Parameters:
flags (
Fwupd.ReleaseFlags
) – release flags, e.g.Fwupd.ReleaseFlags.TRUSTED_PAYLOAD
Sets the release flags.
New in version 1.2.6.
- set_id(id)[source]¶
-
Sets the ID, which allows identifying the specific uploaded component.
New in version 1.7.2.
- set_install_duration(duration)[source]¶
- Parameters:
duration (
int
) – amount of time in seconds
Sets the time estimate for firmware installation (in seconds)
New in version 1.2.1.
- set_name_variant_suffix(name_variant_suffix)[source]¶
-
Sets the update variant suffix.
New in version 1.3.2.
- set_remote_id(remote_id)[source]¶
- Parameters:
remote_id (
str
) – the release ID, e.g.USB:foo
Sets the remote ID that can be used for downloading.
New in version 0.9.3.
- set_size(size)[source]¶
- Parameters:
size (
int
) – the update size in bytes
Sets the update size.
New in version 0.9.3.
- set_source_url(source_url)[source]¶
-
Sets the URL of the source code used to build this release.
New in version 1.2.4.
- set_urgency(urgency)[source]¶
- Parameters:
urgency (
Fwupd.ReleaseUrgency
) – the release urgency, e.g.Fwupd.ReleaseFlags.TRUSTED_PAYLOAD
Sets the release urgency.
New in version 1.4.0.