Fwupd.Client

g Fwupd.Client Fwupd.Client GObject.Object GObject.Object GObject.Object->Fwupd.Client

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new ()

activate (cancellable, device_id)

activate_async (device_id, cancellable, callback, *callback_data)

activate_finish (res)

add_hint (key, value)

build_report_devices (devices, metadata)

clear_results (device_id, cancellable)

clear_results_async (device_id, cancellable, callback, *callback_data)

clear_results_finish (res)

connect_async (cancellable, callback, *callback_data)

connect_finish (res)

download_bytes (url, flags, cancellable)

download_bytes_async (url, flags, cancellable, callback, *callback_data)

download_bytes_finish (res)

download_file (url, file, flags, cancellable)

download_set_retries (retries)

emulation_load (data, cancellable)

emulation_load_async (data, cancellable, callback, *callback_data)

emulation_load_finish (res)

emulation_save (cancellable)

emulation_save_async (cancellable, callback, *callback_data)

emulation_save_finish (res)

ensure_networking ()

fix_host_security_attr (appstream_id, cancellable)

fix_host_security_attr_async (appstream_id, cancellable, callback, *callback_data)

fix_host_security_attr_finish (res)

get_approved_firmware (cancellable)

get_approved_firmware_async (cancellable, callback, *callback_data)

get_approved_firmware_finish (res)

get_battery_level ()

get_battery_threshold ()

get_bios_settings (cancellable)

get_bios_settings_async (cancellable, callback, *callback_data)

get_bios_settings_finish (res)

get_blocked_firmware (cancellable)

get_blocked_firmware_async (cancellable, callback, *callback_data)

get_blocked_firmware_finish (res)

get_daemon_interactive ()

get_daemon_version ()

get_details (filename, cancellable)

get_details_bytes (bytes, cancellable)

get_details_bytes_async (bytes, cancellable, callback, *callback_data)

get_details_bytes_finish (res)

get_device_by_id (device_id, cancellable)

get_device_by_id_async (device_id, cancellable, callback, *callback_data)

get_device_by_id_finish (res)

get_devices (cancellable)

get_devices_async (cancellable, callback, *callback_data)

get_devices_by_guid (guid, cancellable)

get_devices_by_guid_async (guid, cancellable, callback, *callback_data)

get_devices_by_guid_finish (res)

get_devices_finish (res)

get_downgrades (device_id, cancellable)

get_downgrades_async (device_id, cancellable, callback, *callback_data)

get_downgrades_finish (res)

get_history (cancellable)

get_history_async (cancellable, callback, *callback_data)

get_history_finish (res)

get_host_bkc ()

get_host_machine_id ()

get_host_product ()

get_host_security_attrs (cancellable)

get_host_security_attrs_async (cancellable, callback, *callback_data)

get_host_security_attrs_finish (res)

get_host_security_events (limit, cancellable)

get_host_security_events_async (limit, cancellable, callback, *callback_data)

get_host_security_events_finish (res)

get_host_security_id ()

get_host_vendor ()

get_main_context ()

get_only_trusted ()

get_percentage ()

get_plugins (cancellable)

get_plugins_async (cancellable, callback, *callback_data)

get_plugins_finish (res)

get_releases (device_id, cancellable)

get_releases_async (device_id, cancellable, callback, *callback_data)

get_releases_finish (res)

get_remote_by_id (remote_id, cancellable)

get_remote_by_id_async (remote_id, cancellable, callback, *callback_data)

get_remote_by_id_finish (res)

get_remotes (cancellable)

get_remotes_async (cancellable, callback, *callback_data)

get_remotes_finish (res)

get_report_metadata (cancellable)

get_report_metadata_async (cancellable, callback, *callback_data)

get_report_metadata_finish (res)

get_results (device_id, cancellable)

get_results_async (device_id, cancellable, callback, *callback_data)

get_results_finish (res)

get_status ()

get_tainted ()

get_upgrades (device_id, cancellable)

get_upgrades_async (device_id, cancellable, callback, *callback_data)

get_upgrades_finish (res)

get_user_agent ()

inhibit (reason, cancellable)

inhibit_async (reason, cancellable, callback, *callback_data)

inhibit_finish (res)

install (device_id, filename, install_flags, cancellable)

install_async (device_id, filename, install_flags, cancellable, callback, *callback_data)

install_bytes (device_id, bytes, install_flags, cancellable)

install_bytes_async (device_id, bytes, install_flags, cancellable, callback, *callback_data)

install_bytes_finish (res)

install_finish (res)

install_release (device, release, install_flags, cancellable)

install_release2 (device, release, install_flags, download_flags, cancellable)

install_release2_async (device, release, install_flags, download_flags, cancellable, callback, *callback_data)

install_release_async (device, release, install_flags, cancellable, callback, *callback_data)

install_release_finish (res)

modify_bios_setting (settings, cancellable)

modify_bios_setting_async (settings, cancellable, callback, *callback_data)

modify_bios_setting_finish (res)

modify_config (key, value, cancellable)

modify_config_async (key, value, cancellable, callback, *callback_data)

modify_config_finish (res)

modify_device (device_id, key, value, cancellable)

modify_device_async (device_id, key, value, cancellable, callback, *callback_data)

modify_device_finish (res)

modify_remote (remote_id, key, value, cancellable)

modify_remote_async (remote_id, key, value, cancellable, callback, *callback_data)

modify_remote_finish (res)

quit_async (cancellable, callback, *callback_data)

quit_finish (res)

refresh_remote (remote, cancellable)

refresh_remote2 (remote, download_flags, cancellable)

refresh_remote2_async (remote, download_flags, cancellable, callback, *callback_data)

refresh_remote_async (remote, cancellable, callback, *callback_data)

refresh_remote_finish (res)

self_sign (value, flags, cancellable)

self_sign_async (value, flags, cancellable, callback, *callback_data)

self_sign_finish (res)

set_approved_firmware (checksums, cancellable)

set_approved_firmware_async (checksums, cancellable, callback, *callback_data)

set_approved_firmware_finish (res)

set_blocked_firmware (checksums, cancellable)

set_blocked_firmware_async (checksums, cancellable, callback, *callback_data)

set_blocked_firmware_finish (res)

set_daemon_version (daemon_version)

set_feature_flags (feature_flags, cancellable)

set_feature_flags_async (feature_flags, cancellable, callback, *callback_data)

set_feature_flags_finish (res)

set_main_context (main_ctx)

set_user_agent (user_agent)

set_user_agent_for_package (package_name, package_version)

undo_host_security_attr (appstream_id, cancellable)

undo_host_security_attr_async (appstream_id, cancellable, callback, *callback_data)

undo_host_security_attr_finish (res)

uninhibit (inhibit_id, cancellable)

uninhibit_async (inhibit_id, cancellable, callback, *callback_data)

uninhibit_finish (res)

unlock (device_id, cancellable)

unlock_async (device_id, cancellable, callback, *callback_data)

unlock_finish (res)

update_metadata (remote_id, metadata_fn, signature_fn, cancellable)

update_metadata_bytes (remote_id, metadata, signature, cancellable)

update_metadata_bytes_async (remote_id, metadata, signature, cancellable, callback, *callback_data)

update_metadata_bytes_finish (res)

upload_bytes (url, payload, signature, flags, cancellable)

upload_bytes_async (url, payload, signature, flags, cancellable, callback, *callback_data)

upload_bytes_finish (res)

upload_report (url, payload, signature, flags, cancellable)

upload_report_async (url, payload, signature, flags, cancellable, callback, *callback_data)

upload_report_finish (res)

verify (device_id, cancellable)

verify_async (device_id, cancellable, callback, *callback_data)

verify_finish (res)

verify_update (device_id, cancellable)

verify_update_async (device_id, cancellable, callback, *callback_data)

verify_update_finish (res)

Virtual Methods

Inherited:

GObject.Object (7)

do_changed ()

do_device_added (result)

do_device_changed (result)

do_device_removed (result)

do_device_request (request)

do_status_changed (status)

Properties

Name

Type

Flags

Short Description

battery-level

int

r/w

battery-threshold

int

r/w

daemon-version

str

r

host-bkc

str

r/w

host-machine-id

str

r/w

host-product

str

r/w

host-security-id

str

r/w

host-vendor

str

r/w

interactive

bool

r

only-trusted

bool

r

percentage

int

r/w

soup-session

GObject.Object

r

status

int

r/w

tainted

bool

r

Signals

Inherited:

GObject.Object (1)

Name

Short Description

changed

The ::changed signal is emitted when the daemon internal has changed, for instance when a device has been added or removed.

device-added

The ::device-added signal is emitted when a device has been added.

device-changed

The ::device-changed signal is emitted when a device has been changed in some way, e.g.

device-removed

The ::device-removed signal is emitted when a device has been removed.

device-request

The ::device-request signal is emitted when a device has been emitted some kind of event, e.g.

status-changed

Fields

Inherited:

GObject.Object (1)

Name

Type

Access

Description

parent_instance

GObject.Object

r

Class Details

class Fwupd.Client(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Fwupd.ClientClass

Allow client code to call the daemon methods.

See also: [class`FwupdDevice`]

classmethod new()[source]
Returns:

a new Fwupd.Client

Return type:

Fwupd.Client

Creates a new client.

New in version 0.7.0.

activate(cancellable, device_id)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Activates up a device, which normally means the device switches to a new firmware version. This should only be called when data loss cannot occur.

New in version 1.2.6.

activate_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Activates up a device, which normally means the device switches to a new firmware version. This should only be called when data loss cannot occur.

New in version 1.5.0.

activate_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.activate_async].

New in version 1.5.0.

add_hint(key, value)[source]
Parameters:

  • key (str) – the key, e.g. locale

  • value (str or None) – the value key should be set

Sets optional hints from the client that may affect the list of devices.

New in version 1.7.1.

build_report_devices(devices, metadata)[source]
Parameters:
Raises:

GLib.Error

Returns:

a string, or None if the ID is not present

Return type:

str

Builds a JSON report for the list of devices.

This function should be called *before* asking the interactive user if they want to upload a report – as this function filters devices and may return an error if there is nothing to do.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.9.20.

clear_results(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Clears the results for a specific device.

New in version 0.7.0.

clear_results_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Clears the results for a specific device.

New in version 1.5.0.

clear_results_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.clear_results_async].

New in version 1.5.0.

connect_async(cancellable, callback, *callback_data)[source]
Parameters:

Sets up the client ready for use. This is probably the first method you call when wanting to use libfwupd in an asynchronous manner.

Other methods such as [method`FwupdClient`.get_devices_async] should only be called after [method`FwupdClient`.connect_finish] has been called without an error.

New in version 1.5.0.

connect_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`Client`.connect_async].

New in version 1.5.0.

download_bytes(url, flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

downloaded data, or None for error

Return type:

GLib.Bytes

Downloads data from a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

New in version 1.4.5.

download_bytes_async(url, flags, cancellable, callback, *callback_data)[source]
Parameters:

Downloads data from a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

You must have called [method`Client`.connect_async] on self before using this method.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

download_bytes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

downloaded data, or None for error

Return type:

GLib.Bytes

Gets the result of [method`FwupdClient`.download_bytes_async].

New in version 1.5.0.

download_file(url, file, flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True if the file was written

Return type:

bool

Downloads data from a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

New in version 1.5.2.

download_set_retries(retries)[source]
Parameters:

retries (int) – number of tries, defaulting to 0

Sets the number of retries should be attempted on transient download errors.

New in version 1.9.19.

emulation_load(data, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Loads an emulated device into the daemon backend that has the phases set by the JSON data, for instance, having one USB device emulated for the bootloader and another emulated for the runtime interface.

New in version 1.8.11.

emulation_load_async(data, cancellable, callback, *callback_data)[source]
Parameters:

Loads an emulated device into the daemon backend that has the phases set by the JSON data, for instance, having one USB device emulated for the bootloader and another emulated for the runtime interface.

New in version 1.8.11.

emulation_load_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.emulation_load_async].

New in version 1.8.11.

emulation_save(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

archive data

Return type:

GLib.Bytes

Gets the captured data from all filtered devices for all recorded phases. The data is returned in a ZIP archive of JSON output.

NOTE: Device events are not automatically recorded for all devices. You must call something like ModifyDevice(device_id, 'flags','emulation-tag') to start the recording the backend.

Once the device has been re-inserted then the emulation data will be available using this API call.

New in version 1.8.11.

emulation_save_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets the captured data from all filtered devices for all recorded phases. The data is returned in a ZIP archive of JSON output.

NOTE: Device events are not automatically recorded for all devices. You must call something like ModifyDevice(device_id, 'flags','emulation-tag') to start the recording the backend.

Once the device has been re-inserted then the emulation data will be available using this API call.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.8.11.

emulation_save_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

archive data

Return type:

GLib.Bytes

Gets the result of [method`FwupdClient`.emulation_save_async].

New in version 1.8.11.

ensure_networking()[source]
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Sets up the client networking support ready for use. Most other download and upload methods call this automatically, and do you only need to call this if the session is being used outside the [class`FwupdClient`].

New in version 1.4.5.

fix_host_security_attr(appstream_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Fix one specific security attribute.

New in version 1.9.6.

fix_host_security_attr_async(appstream_id, cancellable, callback, *callback_data)[source]
Parameters:

Fix one specific security attribute.

New in version 1.9.6.

fix_host_security_attr_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.fix_host_security_attr_async].

New in version 1.9.6.

get_approved_firmware(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

checksums, or None for error

Return type:

[str]

Gets the list of approved firmware.

New in version 1.2.6.

get_approved_firmware_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets the list of approved firmware.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_approved_firmware_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

checksums, or None for error

Return type:

[str]

Gets the result of [method`FwupdClient`.get_approved_firmware_async].

New in version 1.5.0.

get_battery_level()[source]
Returns:

value in percent

Return type:

int

Returns the system battery level.

New in version 1.8.1.

get_battery_threshold()[source]
Returns:

value in percent

Return type:

int

Returns the system battery threshold under which a firmware update cannot be performed.

New in version 1.8.1.

get_bios_settings(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.BiosSetting]

Gets all the BIOS settings from the daemon.

New in version 1.8.4.

get_bios_settings_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the host security attributes from the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.8.4.

get_bios_settings_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.BiosSetting]

Gets the result of [method`FwupdClient`.get_bios_settings_async].

New in version 1.8.4.

get_blocked_firmware(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

checksums, or None for error

Return type:

[str]

Gets the list of blocked firmware.

New in version 1.4.6.

get_blocked_firmware_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets the list of blocked firmware.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_blocked_firmware_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

checksums, or None for error

Return type:

[str]

Gets the result of [method`FwupdClient`.get_blocked_firmware_async].

New in version 1.5.0.

get_daemon_interactive()[source]
Returns:

True if the daemon is running in an interactive terminal

Return type:

bool

Gets if the daemon is running in an interactive terminal.

New in version 1.3.4.

get_daemon_version()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the daemon version number.

New in version 0.9.6.

get_details(filename, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

an array of results

Return type:

[Fwupd.Device]

Gets details about a specific firmware file.

New in version 1.0.0.

get_details_bytes(bytes, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

an array of results

Return type:

[Fwupd.Device]

Gets details about a specific firmware file.

New in version 1.5.0.

get_details_bytes_async(bytes, cancellable, callback, *callback_data)[source]
Parameters:

Gets details about a specific firmware file.

New in version 1.5.0.

get_details_bytes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

an array of results

Return type:

[Fwupd.Device]

Gets the result of [method`FwupdClient`.get_details_bytes_async].

New in version 1.5.0.

get_device_by_id(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a device or None

Return type:

Fwupd.Device

Gets a device by its device ID.

New in version 0.9.3.

get_device_by_id_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets a device by it’s device ID.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_device_by_id_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a device, or None for failure

Return type:

Fwupd.Device

Gets the result of [method`FwupdClient`.get_device_by_id_async].

New in version 1.5.0.

get_devices(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Device]

Gets all the devices registered with the daemon.

New in version 0.9.2.

get_devices_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the devices registered with the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_devices_by_guid(guid, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

devices or None

Return type:

[Fwupd.Device]

Gets any devices that provide a specific GUID. An error is returned if no devices contains this GUID.

New in version 1.4.1.

get_devices_by_guid_async(guid, cancellable, callback, *callback_data)[source]
Parameters:

Gets any devices that provide a specific GUID. An error is returned if no devices contains this GUID.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_devices_by_guid_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets the result of [method`FwupdClient`.get_devices_by_guid_async].

New in version 1.5.0.

get_devices_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Device]

Gets the result of [method`FwupdClient`.get_devices_async].

New in version 1.5.0.

get_downgrades(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets all the downgrades for a specific device.

New in version 0.9.8.

get_downgrades_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets all the downgrades for a specific device.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_downgrades_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets the result of [method`FwupdClient`.get_downgrades_async].

New in version 1.5.0.

get_history(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Device]

Gets all the history.

New in version 1.0.4.

get_history_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the history.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_history_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Device]

Gets the result of [method`FwupdClient`.get_history_async].

New in version 1.5.0.

get_host_bkc()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the host best known configuration, e.g. vendor-factory-2021q1,mycompany-2023.

New in version 1.7.3.

get_host_machine_id()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the string that represents the host machine ID

New in version 1.3.2.

get_host_product()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the string that represents the host running fwupd

New in version 1.3.1.

get_host_security_attrs(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.SecurityAttr]

Gets all the host security attributes from the daemon.

New in version 1.5.0.

get_host_security_attrs_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the host security attributes from the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_host_security_attrs_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.SecurityAttr]

Gets the result of [method`FwupdClient`.get_host_security_attrs_async].

New in version 1.5.0.

get_host_security_events(limit, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.SecurityAttr]

Gets all the host security events from the daemon.

New in version 1.7.1.

get_host_security_events_async(limit, cancellable, callback, *callback_data)[source]
Parameters:

Gets all the host security events from the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.7.1.

get_host_security_events_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

attributes

Return type:

[Fwupd.SecurityAttr]

Gets the result of [method`FwupdClient`.get_host_security_events_async].

New in version 1.7.1.

get_host_security_id()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the string that represents the host machine ID

New in version 1.5.0.

get_host_vendor()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the string that represents the vendor of the host running fwupd

New in version 1.8.2.

get_main_context()[source]
Returns:

the main context

Return type:

GLib.MainContext

Gets the internal GLib.MainContext to use for synchronous methods. By default the value is set a new GLib.MainContext.

New in version 1.5.3.

get_only_trusted()[source]
Returns:

True if the daemon is checking signatures

Return type:

bool

Gets if the daemon is verifying signatures from a trusted authority.

New in version 1.8.0.

get_percentage()[source]
Returns:

a percentage, or 0 for unknown.

Return type:

int

Gets the last returned percentage value.

New in version 0.7.3.

get_plugins(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Plugin]

Gets all the plugins being used the daemon.

New in version 1.5.0.

get_plugins_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the plugins being used by the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_plugins_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Device]

Gets the result of [method`FwupdClient`.get_plugins_async].

New in version 1.5.0.

get_releases(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets all the releases for a specific device

New in version 0.9.3.

get_releases_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets all the releases for a specific device

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_releases_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets the result of [method`FwupdClient`.get_releases_async].

New in version 1.5.0.

get_remote_by_id(remote_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a Fwupd.Remote, or None if not found

Return type:

Fwupd.Remote

Gets a specific remote that has been configured for the system.

New in version 0.9.3.

get_remote_by_id_async(remote_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets a specific remote that has been configured for the system.

New in version 1.5.0.

get_remote_by_id_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a Fwupd.Remote, or None if not found

Return type:

Fwupd.Remote

Gets the result of [method`FwupdClient`.get_remote_by_id_async].

New in version 1.5.0.

get_remotes(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

list of remotes, or None

Return type:

[Fwupd.Remote]

Gets the list of remotes that have been configured for the system.

New in version 0.9.3.

get_remotes_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets the list of remotes that have been configured for the system.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_remotes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Remote]

Gets the result of [method`FwupdClient`.get_remotes_async].

New in version 1.5.0.

get_report_metadata(cancellable)[source]
Parameters:

cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

attributes

Return type:

{object: object}

Gets all the report metadata from the daemon.

New in version 1.5.0.

get_report_metadata_async(cancellable, callback, *callback_data)[source]
Parameters:

Gets all the report metadata from the daemon.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_report_metadata_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

attributes

Return type:

{object: object}

Gets the result of [method`FwupdClient`.get_report_metadata_async].

New in version 1.5.0.

get_results(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a device, or None for failure

Return type:

Fwupd.Device

Gets the results of a previous firmware update for a specific device.

New in version 0.7.0.

get_results_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets the results of a previous firmware update for a specific device.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_results_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a device, or None for failure

Return type:

Fwupd.Device

Gets the result of [method`FwupdClient`.get_results_async].

New in version 1.5.0.

get_status()[source]
Returns:

a Fwupd.Status, or Fwupd.Status.UNKNOWN for unknown.

Return type:

Fwupd.Status

Gets the last returned status value.

New in version 0.7.3.

get_tainted()[source]
Returns:

True if the daemon is unsupported

Return type:

bool

Gets if the daemon has been tainted by 3rd party code.

New in version 1.2.4.

get_upgrades(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets all the upgrades for a specific device.

New in version 0.9.8.

get_upgrades_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Gets all the upgrades for a specific device.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

get_upgrades_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

results

Return type:

[Fwupd.Release]

Gets the result of [method`FwupdClient`.get_upgrades_async].

New in version 1.5.0.

get_user_agent()[source]
Returns:

a string, or None for unknown.

Return type:

str

Gets the string that represents the user agent that is used for uploading and downloading. The user agent will contain the runtime version of fwupd somewhere in the provided string.

New in version 1.5.2.

inhibit(reason, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a string to use for [method`FwupdClient`.uninhibit_async], or None for failure

Return type:

str

Marks all devices as unavailable for update. Update is only available if there is no other inhibit imposed by other applications or by the system (e.g. low power state).

The same application can inhibit the system multiple times.

New in version 1.8.11.

inhibit_async(reason, cancellable, callback, *callback_data)[source]
Parameters:

Marks all devices as unavailable for update. Update is only available if there is no other inhibit imposed by other applications or by the system (e.g. low power state).

The same application can inhibit the system multiple times.

New in version 1.8.11.

inhibit_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a string to use for [method`FwupdClient`.uninhibit_async], or None for failure

Return type:

str

Gets the result of [method`FwupdClient`.inhibit_async].

New in version 1.8.11.

install(device_id, filename, install_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Install a file onto a specific device.

New in version 0.7.0.

install_async(device_id, filename, install_flags, cancellable, callback, *callback_data)[source]
Parameters:

Install firmware onto a specific device.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

install_bytes(device_id, bytes, install_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Install firmware onto a specific device.

New in version 1.4.5.

install_bytes_async(device_id, bytes, install_flags, cancellable, callback, *callback_data)[source]
Parameters:

Install firmware onto a specific device.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

install_bytes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.install_bytes_async].

New in version 1.5.0.

install_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.install_async].

New in version 1.5.0.

install_release(device, release, install_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Installs a new release on a device, downloading the firmware if required.

New in version 1.4.5.

Deprecated since version 1.5.6.

install_release2(device, release, install_flags, download_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Installs a new release on a device, downloading the firmware if required.

New in version 1.5.6.

install_release2_async(device, release, install_flags, download_flags, cancellable, callback, *callback_data)[source]
Parameters:

Installs a new release on a device, downloading the firmware if required.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.6.

install_release_async(device, release, install_flags, cancellable, callback, *callback_data)[source]
Parameters:

Installs a new release on a device, downloading the firmware if required.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

Deprecated since version 1.5.6.

install_release_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.install_release_async].

New in version 1.5.0.

modify_bios_setting(settings, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Modifies a BIOS setting using kernel API. The daemon will only respond to this request with proper permissions.

New in version 1.8.4.

modify_bios_setting_async(settings, cancellable, callback, *callback_data)[source]
Parameters:

Modifies a BIOS setting using kernel API. The daemon will only respond to this request with proper permissions.

New in version 1.8.4.

modify_bios_setting_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.modify_bios_setting_async].

New in version 1.8.4.

modify_config(key, value, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Modifies a daemon config option. The daemon will only respond to this request with proper permissions.

New in version 1.2.8.

modify_config_async(key, value, cancellable, callback, *callback_data)[source]
Parameters:

Modifies a daemon config option. The daemon will only respond to this request with proper permissions.

New in version 1.5.0.

modify_config_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.modify_config_async].

New in version 1.5.0.

modify_device(device_id, key, value, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Modifies a device in a specific way. Not all properties on the Fwupd.Device are settable by the client, and some may have other restrictions on value.

NOTE: User authentication may be required to complete this action.

New in version 1.0.4.

modify_device_async(device_id, key, value, cancellable, callback, *callback_data)[source]
Parameters:

Modifies a device in a specific way. Not all properties on the Fwupd.Device are settable by the client, and some may have other restrictions on value.

New in version 1.5.0.

modify_device_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.modify_device_async].

New in version 1.5.0.

modify_remote(remote_id, key, value, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Modifies a system remote in a specific way.

NOTE: User authentication may be required to complete this action.

New in version 0.9.8.

modify_remote_async(remote_id, key, value, cancellable, callback, *callback_data)[source]
Parameters:

Modifies a system remote in a specific way.

New in version 1.5.0.

modify_remote_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.modify_remote_async].

New in version 1.5.0.

quit_async(cancellable, callback, *callback_data)[source]
Parameters:

Asks the daemon to quit. This can only be called by the root user.

NOTE: This will only actually quit if an install is not already in progress.

New in version 1.8.11.

quit_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.quit_async].

New in version 1.8.11.

refresh_remote(remote, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Refreshes a remote by downloading new metadata.

New in version 1.4.5.

refresh_remote2(remote, download_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Refreshes a remote by downloading new metadata.

New in version 1.9.4.

refresh_remote2_async(remote, download_flags, cancellable, callback, *callback_data)[source]
Parameters:

Refreshes a remote by downloading new metadata.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.9.4.

refresh_remote_async(remote, cancellable, callback, *callback_data)[source]
Parameters:

Refreshes a remote by downloading new metadata.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

refresh_remote_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.refresh_remote_async].

New in version 1.5.0.

self_sign(value, flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a signature, or None for failure

Return type:

str

Signs the data using the client self-signed certificate.

New in version 1.2.6.

self_sign_async(value, flags, cancellable, callback, *callback_data)[source]
Parameters:

Signs the data using the client self-signed certificate.

You must have called [method`Client`.connect_async] on self before using this method.

New in version 1.5.0.

self_sign_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a signature, or None for failure

Return type:

str

Gets the result of [method`FwupdClient`.self_sign_async].

New in version 1.5.0.

set_approved_firmware(checksums, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Sets the list of approved firmware.

New in version 1.2.6.

set_approved_firmware_async(checksums, cancellable, callback, *callback_data)[source]
Parameters:

Sets the list of approved firmware.

New in version 1.5.0.

set_approved_firmware_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.set_approved_firmware_async].

New in version 1.5.0.

set_blocked_firmware(checksums, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Sets the list of approved firmware.

New in version 1.4.6.

set_blocked_firmware_async(checksums, cancellable, callback, *callback_data)[source]
Parameters:

Sets the list of blocked firmware.

New in version 1.5.0.

set_blocked_firmware_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.set_blocked_firmware_async].

New in version 1.5.0.

set_daemon_version(daemon_version)[source]
Parameters:

daemon_version (str) – A semantic version, e.g. “1.2.3”

Sets the daemon version number.

New in version 1.8.11.

set_feature_flags(feature_flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Sets the features the client supports. This allows firmware to depend on specific front-end features, for instance showing the user an image on how to detach the hardware.

Clients can call this none or multiple times.

New in version 1.4.5.

set_feature_flags_async(feature_flags, cancellable, callback, *callback_data)[source]
Parameters:

Sets the features the client supports. This allows firmware to depend on specific front-end features, for instance showing the user an image on how to detach the hardware.

New in version 1.5.0.

set_feature_flags_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.set_feature_flags_async].

New in version 1.5.0.

set_main_context(main_ctx)[source]
Parameters:

main_ctx (GLib.MainContext or None) – the global default main context to use

Sets the internal main context to use for returning progress signals.

New in version 1.5.3.

set_user_agent(user_agent)[source]
Parameters:

user_agent (str) – the user agent ID, e.g. gnome-software/3.34.1

Manually sets the user agent that is used for downloading. The user agent should contain the runtime version of fwupd somewhere in the provided string.

New in version 1.4.5.

set_user_agent_for_package(package_name, package_version)[source]
Parameters:

  • package_name (str) – client program name, e.g. gnome-software

  • package_version (str) – client program version, e.g. 3.28.1

Builds a user-agent to use for the download.

Supplying harmless details to the server means it knows more about each client. This allows the web service to respond in a different way, for instance sending a different metadata file for old versions of fwupd, or returning an error for Solaris machines.

Before freaking out about theoretical privacy implications, much more data than this is sent to each and every website you visit.

New in version 1.4.5.

undo_host_security_attr(appstream_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Revert the fix to one specific security attribute.

New in version 1.9.6.

undo_host_security_attr_async(appstream_id, cancellable, callback, *callback_data)[source]
Parameters:

Reverts the fix to one specific security attribute.

New in version 1.9.6.

undo_host_security_attr_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.undo_host_security_attr_async].

New in version 1.9.6.

uninhibit(inhibit_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Removes the inhibit token added by the application.

New in version 1.8.11.

uninhibit_async(inhibit_id, cancellable, callback, *callback_data)[source]
Parameters:

Removes the inhibit token added by the application.

New in version 1.8.11.

uninhibit_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.uninhibit_async].

New in version 1.8.11.

unlock(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Unlocks a specific device so firmware can be read or wrote.

New in version 0.7.0.

unlock_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Unlocks a specific device so firmware can be read or wrote.

New in version 1.5.0.

unlock_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.unlock_async].

New in version 1.5.0.

update_metadata(remote_id, metadata_fn, signature_fn, cancellable)[source]
Parameters:

  • remote_id (str) – the remote ID, e.g. lvfs-testing

  • metadata_fn (str) – the XML metadata filename

  • signature_fn (str) – the GPG signature file

  • cancellable (Gio.Cancellable or None) – optional Gio.Cancellable

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Updates the metadata. This allows a session process to download the metadata and metadata signing file to be passed into the daemon to be checked and parsed.

The remote_id allows the firmware to be tagged so that the remote can be matched when the firmware is downloaded.

New in version 1.0.0.

update_metadata_bytes(remote_id, metadata, signature, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Updates the metadata. This allows a session process to download the metadata and metadata signing file to be passed into the daemon to be checked and parsed.

The remote_id allows the firmware to be tagged so that the remote can be matched when the firmware is downloaded.

New in version 1.4.5.

update_metadata_bytes_async(remote_id, metadata, signature, cancellable, callback, *callback_data)[source]
Parameters:

Updates the metadata. This allows a session process to download the metadata and metadata signing file to be passed into the daemon to be checked and parsed.

The remote_id allows the firmware to be tagged so that the remote can be matched when the firmware is downloaded.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

update_metadata_bytes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.update_metadata_bytes_async].

New in version 1.5.0.

upload_bytes(url, payload, signature, flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

response data, or None for error

Return type:

GLib.Bytes

Uploads data to a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

New in version 1.4.5.

upload_bytes_async(url, payload, signature, flags, cancellable, callback, *callback_data)[source]
Parameters:

Uploads data to a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

You must have called [method`Client`.connect_async] on self before using this method.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.5.0.

upload_bytes_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

response data, or None for error

Return type:

GLib.Bytes

Gets the result of [method`FwupdClient`.upload_bytes_async].

New in version 1.5.0.

upload_report(url, payload, signature, flags, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

a URI (perhaps an empty string), or None for error

Return type:

str

Uploads a report to a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

New in version 1.9.20.

upload_report_async(url, payload, signature, flags, cancellable, callback, *callback_data)[source]
Parameters:

Uploads a report to a remote server. The [method`Client`.set_user_agent] function should be called before this method is used.

You must have called [method`Client`.connect_async] on self before using this method.

NOTE: This method is thread-safe, but progress signals will be emitted in the global default main context, if not explicitly set with [method`Client`.set_main_context].

New in version 1.9.20.

upload_report_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

a URI (perhaps an empty string), or None for error

Return type:

str

Gets the result of [method`FwupdClient`.upload_report_async].

New in version 1.9.20.

verify(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for verification success

Return type:

bool

Verify a specific device.

New in version 0.7.0.

verify_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Verify a specific device.

New in version 1.5.0.

verify_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.verify_async].

New in version 1.5.0.

verify_update(device_id, cancellable)[source]
Parameters:
Raises:

GLib.Error

Returns:

True for verification success

Return type:

bool

Update the verification record for a specific device.

New in version 0.8.0.

verify_update_async(device_id, cancellable, callback, *callback_data)[source]
Parameters:

Update the verification record for a specific device.

New in version 1.5.0.

verify_update_finish(res)[source]
Parameters:

res (Gio.AsyncResult) – the asynchronous result

Raises:

GLib.Error

Returns:

True for success

Return type:

bool

Gets the result of [method`FwupdClient`.verify_update_async].

New in version 1.5.0.

do_changed() virtual
do_device_added(result) virtual
Parameters:

result (Fwupd.Device) –

do_device_changed(result) virtual
Parameters:

result (Fwupd.Device) –

do_device_removed(result) virtual
Parameters:

result (Fwupd.Device) –

do_device_request(request) virtual
Parameters:

request (Fwupd.Request) –

do_status_changed(status) virtual
Parameters:

status (Fwupd.Status) –

Signal Details

Fwupd.Client.signals.changed(client)
Signal Name:

changed

Flags:

RUN_LAST

Parameters:

client (Fwupd.Client) – The object which received the signal

The ::changed signal is emitted when the daemon internal has changed, for instance when a device has been added or removed.

New in version 0.7.0.

Fwupd.Client.signals.device_added(client, result)
Signal Name:

device-added

Flags:

RUN_LAST

Parameters:

The ::device-added signal is emitted when a device has been added.

New in version 0.7.1.

Fwupd.Client.signals.device_changed(client, result)
Signal Name:

device-changed

Flags:

RUN_LAST

Parameters:

The ::device-changed signal is emitted when a device has been changed in some way, e.g. the version number is updated.

New in version 0.7.1.

Fwupd.Client.signals.device_removed(client, result)
Signal Name:

device-removed

Flags:

RUN_LAST

Parameters:

The ::device-removed signal is emitted when a device has been removed.

New in version 0.7.1.

Fwupd.Client.signals.device_request(client, msg)
Signal Name:

device-request

Flags:

RUN_LAST

Parameters:

The ::device-request signal is emitted when a device has been emitted some kind of event, e.g. a manual action is required.

New in version 1.6.2.

Fwupd.Client.signals.status_changed(client, object)
Signal Name:

status-changed

Flags:

RUN_LAST

Parameters:

  • client (Fwupd.Client) – The object which received the signal

  • object (int) –

Property Details

Fwupd.Client.props.battery_level
Name:

battery-level

Type:

int

Default Value:

101

Flags:

READABLE, WRITABLE

The system battery level in percent.

New in version 1.8.1.

Fwupd.Client.props.battery_threshold
Name:

battery-threshold

Type:

int

Default Value:

101

Flags:

READABLE, WRITABLE

The system battery threshold in percent.

New in version 1.8.1.

Fwupd.Client.props.daemon_version
Name:

daemon-version

Type:

str

Default Value:

None

Flags:

READABLE

The daemon version number.

New in version 0.9.6.

Fwupd.Client.props.host_bkc
Name:

host-bkc

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The host best known configuration.

New in version 1.7.3.

Fwupd.Client.props.host_machine_id
Name:

host-machine-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The host machine-id string

New in version 1.3.2.

Fwupd.Client.props.host_product
Name:

host-product

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The host product string

New in version 1.3.1.

Fwupd.Client.props.host_security_id
Name:

host-security-id

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The host machine-id string

New in version 1.5.0.

Fwupd.Client.props.host_vendor
Name:

host-vendor

Type:

str

Default Value:

None

Flags:

READABLE, WRITABLE

The host vendor string

New in version 1.8.2.

Fwupd.Client.props.interactive
Name:

interactive

Type:

bool

Default Value:

False

Flags:

READABLE

If the daemon is running in an interactive terminal

New in version 1.3.4.

Fwupd.Client.props.only_trusted
Name:

only-trusted

Type:

bool

Default Value:

True

Flags:

READABLE

If the daemon is verifying signatures from a trusted authority.

New in version 1.8.0.

Fwupd.Client.props.percentage
Name:

percentage

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

The last-reported percentage of the daemon.

New in version 0.7.3.

Fwupd.Client.props.soup_session
Name:

soup-session

Type:

GObject.Object

Default Value:

None

Flags:

READABLE

The libsoup session, now unused.

New in version 1.4.5.

Fwupd.Client.props.status
Name:

status

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

The last-reported status of the daemon.

New in version 0.7.0.

Fwupd.Client.props.tainted
Name:

tainted

Type:

bool

Default Value:

False

Flags:

READABLE

If the daemon is tainted by 3rd party code.

New in version 1.2.4.