Class
FwupdClient
Description [src]
class Fwupd.Client : GObject.Object {
parent_instance: GObject
}Allow client code to call the daemon methods.
See also: FwupdDevice
Instance methods
fwupd_client_activate
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.
since: 1.2.6
fwupd_client_activate_async
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.
since: 1.5.0
fwupd_client_add_hint
Sets optional hints from the client that may affect the list of devices.
since: 1.7.1
fwupd_client_clear_results_finish
Gets the result of fwupd_client_clear_results_async().
since: 1.5.0
fwupd_client_connect
Sets up the client ready for use. Most other methods call this for you, and do you only need to call this if you are just watching the client.
since: 0.7.1
fwupd_client_connect_async
Sets up the client ready for use. This is probably the first method you call when wanting to use libfwupd in an asynchronous manner.
since: 1.5.0
fwupd_client_disconnect
Tears down client after use. You only need to call this method if you are:
since: 1.8.0
fwupd_client_download_bytes
Downloads data from a remote server. The fwupd_client_set_user_agent() function
should be called before this method is used.
since: 1.4.5
fwupd_client_download_bytes_async
Downloads data from a remote server. The fwupd_client_set_user_agent() function
should be called before this method is used.
since: 1.5.0
fwupd_client_download_bytes_finish
Gets the result of fwupd_client_download_bytes_async().
since: 1.5.0
fwupd_client_download_file
Downloads data from a remote server. The fwupd_client_set_user_agent() function
should be called before this method is used.
since: 1.5.2
fwupd_client_emulation_load
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.
since: 1.8.11
fwupd_client_emulation_load_async
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.
since: 1.8.11
fwupd_client_emulation_load_finish
Gets the result of fwupd_client_emulation_load_async().
since: 1.8.11
fwupd_client_emulation_save
Gets the captured data from all filtered devices for all recorded phases. The data is returned in a ZIP archive of JSON output.
since: 1.8.11
fwupd_client_emulation_save_async
Gets the captured data from all filtered devices for all recorded phases. The data is returned in a ZIP archive of JSON output.
since: 1.8.11
fwupd_client_emulation_save_finish
Gets the result of fwupd_client_emulation_save_async().
since: 1.8.11
fwupd_client_ensure_networking
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 FwupdClient.
since: 1.4.5
fwupd_client_fix_host_security_attr_finish
Gets the result of fwupd_client_fix_host_security_attr_async().
since: 1.9.6
fwupd_client_get_approved_firmware_finish
Gets the result of fwupd_client_get_approved_firmware_async().
since: 1.5.0
fwupd_client_get_battery_threshold
Returns the system battery threshold under which a firmware update cannot be performed.
since: 1.8.1
fwupd_client_get_bios_settings_async
Gets all the host security attributes from the daemon.
since: 1.8.4
fwupd_client_get_bios_settings_finish
Gets the result of fwupd_client_get_bios_settings_async().
since: 1.8.4
fwupd_client_get_blocked_firmware_finish
Gets the result of fwupd_client_get_blocked_firmware_async().
since: 1.5.0
fwupd_client_get_daemon_interactive
Gets if the daemon is running in an interactive terminal.
since: 1.3.4
fwupd_client_get_details_bytes_finish
Gets the result of fwupd_client_get_details_bytes_async().
since: 1.5.0
fwupd_client_get_device_by_id_finish
Gets the result of fwupd_client_get_device_by_id_async().
since: 1.5.0
fwupd_client_get_devices_by_guid
Gets any devices that provide a specific GUID. An error is returned if no devices contains this GUID.
since: 1.4.1
fwupd_client_get_devices_by_guid_async
Gets any devices that provide a specific GUID. An error is returned if no devices contains this GUID.
since: 1.5.0
fwupd_client_get_devices_by_guid_finish
Gets the result of fwupd_client_get_devices_by_guid_async().
since: 1.5.0
fwupd_client_get_downgrades_finish
Gets the result of fwupd_client_get_downgrades_async().
since: 1.5.0
fwupd_client_get_host_bkc
Gets the host best known configuration, e.g. vendor-factory-2021q1,mycompany-2023.
since: 1.7.3
fwupd_client_get_host_security_attrs
Gets all the host security attributes from the daemon.
since: 1.5.0
fwupd_client_get_host_security_attrs_async
Gets all the host security attributes from the daemon.
since: 1.5.0
fwupd_client_get_host_security_attrs_finish
Gets the result of fwupd_client_get_host_security_attrs_async().
since: 1.5.0
fwupd_client_get_host_security_events
Gets all the host security events from the daemon.
since: 1.7.1
fwupd_client_get_host_security_events_async
Gets all the host security events from the daemon.
since: 1.7.1
fwupd_client_get_host_security_events_finish
Gets the result of fwupd_client_get_host_security_events_async().
since: 1.7.1
fwupd_client_get_host_vendor
Gets the string that represents the vendor of the host running fwupd.
since: 1.8.2
fwupd_client_get_main_context
Gets the internal GMainContext to use for synchronous methods.
By default the value is set a new GMainContext.
since: 1.5.3
fwupd_client_get_only_trusted
Gets if the daemon is verifying signatures from a trusted authority.
since: 1.8.0
fwupd_client_get_remote_by_id
Gets a specific remote that has been configured for the system.
since: 0.9.3
fwupd_client_get_remote_by_id_async
Gets a specific remote that has been configured for the system.
since: 1.5.0
fwupd_client_get_remote_by_id_finish
Gets the result of fwupd_client_get_remote_by_id_async().
since: 1.5.0
fwupd_client_get_remotes
Gets the list of remotes that have been configured for the system.
since: 0.9.3
fwupd_client_get_remotes_async
Gets the list of remotes that have been configured for the system.
since: 1.5.0
fwupd_client_get_report_metadata_finish
Gets the result of fwupd_client_get_report_metadata_async().
since: 1.5.0
fwupd_client_get_results
Gets the results of a previous firmware update for a specific device.
since: 0.7.0
fwupd_client_get_results_async
Gets the results of a previous firmware update for a specific device.
since: 1.5.0
fwupd_client_get_user_agent
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.
since: 1.5.2
fwupd_client_inhibit
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).
since: 1.8.11
fwupd_client_inhibit_async
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).
since: 1.8.11
fwupd_client_install_bytes_finish
Gets the result of fwupd_client_install_bytes_async().
since: 1.5.0
fwupd_client_install_release
Installs a new release on a device, downloading the firmware if required.
deprecated: 1.5.6 since: 1.4.5
fwupd_client_install_release2
Installs a new release on a device, downloading the firmware if required.
since: 1.5.6
fwupd_client_install_release2_async
Installs a new release on a device, downloading the firmware if required.
since: 1.5.6
fwupd_client_install_release_async
Installs a new release on a device, downloading the firmware if required.
deprecated: 1.5.6 since: 1.5.0
fwupd_client_install_release_finish
Gets the result of fwupd_client_install_release_async().
since: 1.5.0
fwupd_client_modify_bios_setting
Modifies a BIOS setting using kernel API. The daemon will only respond to this request with proper permissions.
since: 1.8.4
fwupd_client_modify_bios_setting_async
Modifies a BIOS setting using kernel API. The daemon will only respond to this request with proper permissions.
since: 1.8.4
fwupd_client_modify_bios_setting_finish
Gets the result of fwupd_client_modify_bios_setting_async().
since: 1.8.4
fwupd_client_modify_config
Modifies a daemon config option. The daemon will only respond to this request with proper permissions.
since: 1.2.8
fwupd_client_modify_config_async
Modifies a daemon config option. The daemon will only respond to this request with proper permissions.
since: 1.5.0
fwupd_client_modify_config_finish
Gets the result of fwupd_client_modify_config_async().
since: 1.5.0
fwupd_client_modify_device
Modifies a device in a specific way. Not all properties on the FwupdDevice
are settable by the client, and some may have other restrictions on value.
since: 1.0.4
fwupd_client_modify_device_async
Modifies a device in a specific way. Not all properties on the FwupdDevice
are settable by the client, and some may have other restrictions on value.
since: 1.5.0
fwupd_client_modify_device_finish
Gets the result of fwupd_client_modify_device_async().
since: 1.5.0
fwupd_client_modify_remote_finish
Gets the result of fwupd_client_modify_remote_async().
since: 1.5.0
fwupd_client_quit_async
Asks the daemon to quit. This can only be called by the root user.
since: 1.8.11
fwupd_client_refresh_remote_finish
Gets the result of fwupd_client_refresh_remote_async().
since: 1.5.0
fwupd_client_set_approved_firmware_finish
Gets the result of fwupd_client_set_approved_firmware_async().
since: 1.5.0
fwupd_client_set_blocked_firmware_finish
Gets the result of fwupd_client_set_blocked_firmware_async().
since: 1.5.0
fwupd_client_set_feature_flags
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.
since: 1.4.5
fwupd_client_set_feature_flags_async
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.
since: 1.5.0
fwupd_client_set_feature_flags_finish
Gets the result of fwupd_client_set_feature_flags_async().
since: 1.5.0
fwupd_client_set_main_context
Sets the internal main context to use for returning progress signals.
since: 1.5.3
fwupd_client_set_user_agent
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.
since: 1.4.5
fwupd_client_undo_host_security_attr
Revert the fix to one specific security attribute.
since: 1.9.6
fwupd_client_undo_host_security_attr_async
Reverts the fix to one specific security attribute.
since: 1.9.6
fwupd_client_undo_host_security_attr_finish
Gets the result of fwupd_client_undo_host_security_attr_async().
since: 1.9.6
fwupd_client_update_metadata
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.
since: 1.0.0
fwupd_client_update_metadata_bytes
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.
since: 1.4.5
fwupd_client_update_metadata_bytes_async
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.
since: 1.5.0
fwupd_client_update_metadata_bytes_finish
Gets the result of fwupd_client_update_metadata_bytes_async().
since: 1.5.0
fwupd_client_upload_bytes
Uploads data to a remote server. The fwupd_client_set_user_agent() function
should be called before this method is used.
since: 1.4.5
fwupd_client_upload_bytes_async
Uploads data to a remote server. The fwupd_client_set_user_agent() function
should be called before this method is used.
since: 1.5.0
fwupd_client_verify_update_finish
Gets the result of fwupd_client_verify_update_async().
since: 1.5.0
Properties
Fwupd.Client:only-trusted
If the daemon is verifying signatures from a trusted authority.
since: 1.8.0
Signals
Fwupd.Client::changed
The ::changed signal is emitted when the daemon internal has changed, for instance when a device has been added or removed.
since: 0.7.0
Fwupd.Client::device-added
The ::device-added signal is emitted when a device has been added.
since: 0.7.1
Fwupd.Client::device-changed
The ::device-changed signal is emitted when a device has been changed in some way, e.g. the version number is updated.
since: 0.7.1
Fwupd.Client::device-removed
The ::device-removed signal is emitted when a device has been removed.
since: 0.7.1
Fwupd.Client::device-request
The ::device-request signal is emitted when a device has been emitted some kind of event, e.g. a manual action is required.
since: 1.6.2
Signals inherited from GObject (1)
GObject::notify
The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.
Class structure
struct FwupdClientClass {
GObjectClass parent_class;
void (* changed) (
FwupdClient* client
);
void (* status_changed) (
FwupdClient* client,
FwupdStatus status
);
void (* device_added) (
FwupdClient* client,
FwupdDevice* result
);
void (* device_removed) (
FwupdClient* client,
FwupdDevice* result
);
void (* device_changed) (
FwupdClient* client,
FwupdDevice* result
);
void (* device_request) (
FwupdClient* client,
FwupdRequest* request
);
void (* _fwupd_reserved1) (
void
);
void (* _fwupd_reserved2) (
void
);
void (* _fwupd_reserved3) (
void
);
void (* _fwupd_reserved4) (
void
);
void (* _fwupd_reserved5) (
void
);
void (* _fwupd_reserved6) (
void
);
}Class members
parent_class: GObjectClass- No description available.
changed: void (* changed) ( FwupdClient* client )- No description available.
status_changed: void (* status_changed) ( FwupdClient* client, FwupdStatus status )- No description available.
device_added: void (* device_added) ( FwupdClient* client, FwupdDevice* result )- No description available.
device_removed: void (* device_removed) ( FwupdClient* client, FwupdDevice* result )- No description available.
device_changed: void (* device_changed) ( FwupdClient* client, FwupdDevice* result )- No description available.
device_request: void (* device_request) ( FwupdClient* client, FwupdRequest* request )- No description available.
_fwupd_reserved1: void (* _fwupd_reserved1) ( void )- No description available.
_fwupd_reserved2: void (* _fwupd_reserved2) ( void )- No description available.
_fwupd_reserved3: void (* _fwupd_reserved3) ( void )- No description available.
_fwupd_reserved4: void (* _fwupd_reserved4) ( void )- No description available.
_fwupd_reserved5: void (* _fwupd_reserved5) ( void )- No description available.
_fwupd_reserved6: void (* _fwupd_reserved6) ( void )- No description available.