Client

---

Object Hierarchy:

Description:

Content:

Properties:

• public uint battery_level { get; set; }
  The system battery level in percent.
• public uint battery_threshold { get; set; }
  The system battery threshold in percent.
• public string daemon_version { get; }
  The daemon version number.
• public string host_bkc { owned get; set; }
  The host best known configuration.
• public string host_machine_id { owned get; set; }
  The host machine-id string
• public string host_product { owned get; set; }
  The host product string
• public string host_security_id { get; set; }
  The host machine-id string
• public string host_vendor { owned get; set; }
  The host vendor string
• public bool interactive { get; }
  If the daemon is running in an interactive terminal
• public bool only_trusted { get; }
  If the daemon is verifying signatures from a trusted authority.
• public uint percentage { get; set; }
  The last-reported percentage of the daemon.
• public double percentage_full { get; set; }
  The last-reported percentage of the daemon.
• public uint status { get; set; }
  The last-reported status of the daemon.
• public bool tainted { get; }
  If the daemon is tainted by 3rd party code.

Creation methods:

• public Client ()
  Creates a new client.

Methods:

• public bool @unlock (string device_id, Cancellable? cancellable = null) throws Error
  Unlocks a specific device so firmware can be read or wrote.
• public bool activate (Cancellable? cancellable, string device_id) throws Error
  Activates up a device, which normally means the device switches to a new firmware version.
• public async bool activate_async (string device_id, Cancellable? cancellable) throws Error
  Activates up a device, which normally means the device switches to a new firmware version.
• public void add_hint (string key, string? value)
  Sets optional hints from the client that may affect the list of devices.
• public void add_hwid (string key, string? value)
  Adds a HwID entry.
• public string build_report_devices (GenericArray<Device> devices, HashTable<string,string> metadata) throws Error
  Builds a JSON report for the list of devices.
• public string build_report_history (GenericArray<Device> devices, Remote? remote, HashTable<string,string> metadata) throws Error
  Builds a JSON report for the list of devices.
• public string build_report_security (GenericArray<SecurityAttr> attrs, HashTable<string,string> metadata) throws Error
  Builds a JSON security report.
• public bool clean_remote (string remote_id, Cancellable? cancellable = null) throws Error
  Cleans a system remote, deleting metadata as required.
• public async bool clean_remote_async (string remote_id, Cancellable? cancellable) throws Error
  Cleans a system remote, deleting metadata as required.
• public bool clear_results (string device_id, Cancellable? cancellable = null) throws Error
  Clears the results for a specific device.
• public async bool clear_results_async (string device_id, Cancellable? cancellable) throws Error
  Clears the results for a specific device.
• public async bool connect_async (Cancellable? cancellable) throws Error
  Sets up the client ready for use.
• public Bytes download_bytes (string url, ClientDownloadFlags flags, Cancellable? cancellable = null) throws Error
  Downloads data from a remote server.
• public async Bytes download_bytes_async (string url, ClientDownloadFlags flags, Cancellable? cancellable) throws Error
  Downloads data from a remote server.
• public bool download_file (string url, File file, ClientDownloadFlags flags, Cancellable? cancellable = null) throws Error
  Downloads data from a remote server.
• public void download_set_retries (uint retries)
  Sets the number of retries should be attempted on transient download errors.
• public bool emulation_load (string filename, Cancellable? cancellable = null) throws Error
  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.
• public async bool emulation_load_async (string filename, Cancellable? cancellable) throws Error
  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.
• public bool emulation_save (string filename, Cancellable? cancellable = null) throws Error
  Gets the captured data from all filtered devices for all recorded phases.
• public async bool emulation_save_async (string filename, Cancellable? cancellable) throws Error
  Gets the captured data from all filtered devices for all recorded phases.
• public bool ensure_networking () throws Error
  Sets up the client networking support ready for use.
• public bool fix_host_security_attr (string appstream_id, Cancellable? cancellable = null) throws Error
  Fix one specific security attribute.
• public async bool fix_host_security_attr_async (string appstream_id, Cancellable? cancellable) throws Error
  Fix one specific security attribute.
• public string[] get_approved_firmware (Cancellable? cancellable = null) throws Error
  Gets the list of approved firmware.
• public async GenericArray<unowned string> get_approved_firmware_async (Cancellable? cancellable) throws Error
  Gets the list of approved firmware.
• public uint32 get_battery_level ()
  Returns the system battery level.
• public uint32 get_battery_threshold ()
  Returns the system battery threshold under which a firmware update cannot be performed.
• public GenericArray<unowned BiosSetting> get_bios_settings (Cancellable? cancellable = null) throws Error
  Gets all the BIOS settings from the daemon.
• public async GenericArray<unowned BiosSetting> get_bios_settings_async (Cancellable? cancellable) throws Error
  Gets all the host security attributes from the daemon.
• public string[] get_blocked_firmware (Cancellable? cancellable = null) throws Error
  Gets the list of blocked firmware.
• public async GenericArray<unowned string> get_blocked_firmware_async (Cancellable? cancellable) throws Error
  Gets the list of blocked firmware.
• public bool get_daemon_interactive ()
  Gets if the daemon is running in an interactive terminal.
• public unowned string get_daemon_version ()
  Gets the daemon version number.
• public GenericArray<unowned Device> get_details (string filename, Cancellable? cancellable = null) throws Error
  Gets details about a specific firmware file.
• public async GenericArray<unowned Device> get_details_async (string filename, Cancellable? cancellable) throws Error
  Gets details about a specific firmware file.
• public GenericArray<unowned Device> get_details_bytes (Bytes bytes, Cancellable? cancellable = null) throws Error
  Gets details about a specific firmware file.
• public async GenericArray<unowned Device> get_details_bytes_async (Bytes bytes, Cancellable? cancellable) throws Error
  Gets details about a specific firmware file.
• public Device get_device_by_id (string device_id, Cancellable? cancellable = null) throws Error
  Gets a device by its device ID.
• public async Device get_device_by_id_async (string device_id, Cancellable? cancellable) throws Error
  Gets a device by it's device ID.
• public GenericArray<unowned Device> get_devices (Cancellable? cancellable = null) throws Error
  Gets all the devices registered with the daemon.
• public async GenericArray<unowned Device> get_devices_async (Cancellable? cancellable) throws Error
  Gets all the devices registered with the daemon.
• public GenericArray<unowned Device> get_devices_by_guid (string guid, Cancellable? cancellable = null) throws Error
  Gets any devices that provide a specific GUID.
• public async GenericArray<unowned Release> get_devices_by_guid_async (string guid, Cancellable? cancellable) throws Error
  Gets any devices that provide a specific GUID.
• public GenericArray<unowned Release> get_downgrades (string device_id, Cancellable? cancellable = null) throws Error
  Gets all the downgrades for a specific device.
• public async GenericArray<unowned Release> get_downgrades_async (string device_id, Cancellable? cancellable) throws Error
  Gets all the downgrades for a specific device.
• public GenericArray<unowned Device> get_history (Cancellable? cancellable = null) throws Error
  Gets all the history.
• public async GenericArray<unowned Device> get_history_async (Cancellable? cancellable) throws Error
  Gets all the history.
• public unowned string get_host_bkc ()
  Gets the host best known configuration, e.
• public unowned string get_host_machine_id ()
  Gets the string that represents the host machine ID
• public unowned string get_host_product ()
  Gets the string that represents the host running fwupd
• public GenericArray<unowned SecurityAttr> get_host_security_attrs (Cancellable? cancellable = null) throws Error
  Gets all the host security attributes from the daemon.
• public async GenericArray<unowned SecurityAttr> get_host_security_attrs_async (Cancellable? cancellable) throws Error
  Gets all the host security attributes from the daemon.
• public GenericArray<unowned SecurityAttr> get_host_security_events (uint limit, Cancellable? cancellable = null) throws Error
  Gets all the host security events from the daemon.
• public async GenericArray<unowned SecurityAttr> get_host_security_events_async (uint limit, Cancellable? cancellable) throws Error
  Gets all the host security events from the daemon.
• public unowned string get_host_security_id ()
  Gets the string that represents the host machine ID
• public unowned string get_host_vendor ()
  Gets the string that represents the vendor of the host running fwupd
• public void get_hwids (out string[] keys, out string[] values)
  Gets the daemon hardware IDs, sometimes called CHIDs.
• public MainContext get_main_context ()
  Gets the internal MainContext to use for synchronous methods.
• public bool get_only_trusted ()
  Gets if the daemon is verifying signatures from a trusted authority.
• public uint get_percentage ()
  Gets the last returned percentage value.
• public double get_percentage_full ()
  Gets the last returned percentage value.
• public GenericArray<unowned Plugin> get_plugins (Cancellable? cancellable = null) throws Error
  Gets all the plugins being used the daemon.
• public async GenericArray<unowned Device> get_plugins_async (Cancellable? cancellable) throws Error
  Gets all the plugins being used by the daemon.
• public GenericArray<unowned Release> get_releases (string device_id, Cancellable? cancellable = null) throws Error
  Gets all the releases for a specific device
• public async GenericArray<unowned Release> get_releases_async (string device_id, Cancellable? cancellable) throws Error
  Gets all the releases for a specific device
• public Remote get_remote_by_id (string remote_id, Cancellable? cancellable = null) throws Error
  Gets a specific remote that has been configured for the system.
• public async Remote get_remote_by_id_async (string remote_id, Cancellable? cancellable) throws Error
  Gets a specific remote that has been configured for the system.
• public GenericArray<unowned Remote> get_remotes (Cancellable? cancellable = null) throws Error
  Gets the list of remotes that have been configured for the system.
• public async GenericArray<unowned Remote> get_remotes_async (Cancellable? cancellable) throws Error
  Gets the list of remotes that have been configured for the system.
• public HashTable<void*,void*> get_report_metadata (Cancellable? cancellable = null) throws Error
  Gets all the report metadata from the daemon.
• public async HashTable<void*,void*> get_report_metadata_async (Cancellable? cancellable) throws Error
  Gets all the report metadata from the daemon.
• public Device get_results (string device_id, Cancellable? cancellable = null) throws Error
  Gets the results of a previous firmware update for a specific device.
• public async Device get_results_async (string device_id, Cancellable? cancellable) throws Error
  Gets the results of a previous firmware update for a specific device.
• public Status get_status ()
  Gets the last returned status value.
• public bool get_tainted ()
  Gets if the daemon has been tainted by 3rd party code.
• public GenericArray<unowned Release> get_upgrades (string device_id, Cancellable? cancellable = null) throws Error
  Gets all the upgrades for a specific device.
• public async GenericArray<unowned Release> get_upgrades_async (string device_id, Cancellable? cancellable) throws Error
  Gets all the upgrades for a specific device.
• public unowned string get_user_agent ()
  Gets the string that represents the user agent that is used for uploading and downloading.
• public string inhibit (string reason, Cancellable? cancellable = null) throws Error
  Marks all devices as unavailable for update.
• public async string inhibit_async (string reason, Cancellable? cancellable) throws Error
  Marks all devices as unavailable for update.
• public bool install (string device_id, string filename, InstallFlags install_flags, Cancellable? cancellable = null) throws Error
  Install a file onto a specific device.
• public async bool install_async (string device_id, string filename, InstallFlags install_flags, Cancellable? cancellable) throws Error
  Install firmware onto a specific device.
• public bool install_bytes (string device_id, Bytes bytes, InstallFlags install_flags, Cancellable? cancellable = null) throws Error
  Install firmware onto a specific device.
• public async bool install_bytes_async (string device_id, Bytes bytes, InstallFlags install_flags, Cancellable? cancellable) throws Error
  Install firmware onto a specific device.
• public bool install_release (Device device, Release release, InstallFlags install_flags, ClientDownloadFlags download_flags, Cancellable? cancellable = null) throws Error
  Installs a new release on a device, downloading the firmware if required.
• public async bool install_release_async (Device device, Release release, InstallFlags install_flags, ClientDownloadFlags download_flags, Cancellable? cancellable) throws Error
  Installs a new release on a device, downloading the firmware if required.
• public bool modify_bios_setting (owned HashTable<void*,void*> settings, Cancellable? cancellable = null) throws Error
  Modifies a BIOS setting using kernel API.
• public async bool modify_bios_setting_async (owned HashTable<void*,void*> settings, Cancellable? cancellable) throws Error
  Modifies a BIOS setting using kernel API.
• public bool modify_config (string section, string key, string value, Cancellable? cancellable = null) throws Error
  Modifies a daemon config option.
• public async bool modify_config_async (string section, string key, string value, Cancellable? cancellable) throws Error
  Modifies a daemon config option.
• public bool modify_device (string device_id, string key, string value, Cancellable? cancellable = null) throws Error
  Modifies a device in a specific way.
• public async bool modify_device_async (string device_id, string key, string value, Cancellable? cancellable) throws Error
  Modifies a device in a specific way.
• public bool modify_remote (string remote_id, string key, string value, Cancellable? cancellable = null) throws Error
  Modifies a system remote in a specific way.
• public async bool modify_remote_async (string remote_id, string key, string value, Cancellable? cancellable) throws Error
  Modifies a system remote in a specific way.
• public async bool quit_async (Cancellable? cancellable) throws Error
  Asks the daemon to quit.
• public bool refresh_remote (Remote remote, ClientDownloadFlags download_flags, Cancellable? cancellable = null) throws Error
  Refreshes a remote by downloading new metadata.
• public async bool refresh_remote_async (Remote remote, ClientDownloadFlags download_flags, Cancellable? cancellable) throws Error
  Refreshes a remote by downloading new metadata.
• public bool reset_config (string section, Cancellable? cancellable = null) throws Error
  Resets a daemon config section.
• public async bool reset_config_async (string section, Cancellable? cancellable) throws Error
  Resets a daemon config section.
• public GenericArray<unowned Release> search (string token, Cancellable? cancellable = null) throws Error
  Gets all the releases that match a specific token.
• public async GenericArray<unowned Release> search_async (string token, Cancellable? cancellable) throws Error
  Gets all the releases that match a specific token.
• public string self_sign (string value, SelfSignFlags flags, Cancellable? cancellable = null) throws Error
  Signs the data using the client self-signed certificate.
• public async string self_sign_async (string value, SelfSignFlags flags, Cancellable? cancellable) throws Error
  Signs the data using the client self-signed certificate.
• public bool set_approved_firmware (string checksums, Cancellable? cancellable = null) throws Error
  Sets the list of approved firmware.
• public async bool set_approved_firmware_async (GenericArray<string> checksums, Cancellable? cancellable) throws Error
  Sets the list of approved firmware.
• public bool set_blocked_firmware (string checksums, Cancellable? cancellable = null) throws Error
  Sets the list of approved firmware.
• public async bool set_blocked_firmware_async (GenericArray<string> checksums, Cancellable? cancellable) throws Error
  Sets the list of blocked firmware.
• public void set_daemon_version (string daemon_version)
  Sets the daemon version number.
• public bool set_feature_flags (FeatureFlags feature_flags, Cancellable? cancellable = null) throws Error
  Sets the features the client supports.
• public async bool set_feature_flags_async (FeatureFlags feature_flags, Cancellable? cancellable) throws Error
  Sets the features the client supports.
• public void set_host_security_id (string host_security_id)
  Sets the string that represents the host machine ID.
• public void set_main_context (MainContext? main_ctx)
  Sets the internal main context to use for returning progress signals.
• public void set_sync_impl (ClientSyncImpl impl, void* userdata, DestroyNotify? userdata_destroy)
  Sets an override for synchronous client functionality.
• public void set_user_agent (string user_agent)
  Manually sets the user agent that is used for downloading.
• public void set_user_agent_for_package (string package_name, string package_version)
  Builds a user-agent to use for the download.
• public bool undo_host_security_attr (string appstream_id, Cancellable? cancellable = null) throws Error
  Revert the fix to one specific security attribute.
• public async bool undo_host_security_attr_async (string appstream_id, Cancellable? cancellable) throws Error
  Reverts the fix to one specific security attribute.
• public bool uninhibit (string inhibit_id, Cancellable? cancellable = null) throws Error
  Removes the inhibit token added by the application.
• public async bool uninhibit_async (string inhibit_id, Cancellable? cancellable) throws Error
  Removes the inhibit token added by the application.
• public async bool unlock_async (string device_id, Cancellable? cancellable) throws Error
  Unlocks a specific device so firmware can be read or wrote.
• public bool update_metadata (string remote_id, string metadata_fn, string signature_fn, Cancellable? cancellable = null) throws Error
  Updates the metadata.
• public bool update_metadata_bytes (string remote_id, Bytes metadata, Bytes signature, Cancellable? cancellable = null) throws Error
  Updates the metadata.
• public async bool update_metadata_bytes_async (string remote_id, Bytes metadata, Bytes signature, Cancellable? cancellable) throws Error
  Updates the metadata.
• public Bytes upload_bytes (string url, string payload, string? signature, ClientUploadFlags flags, Cancellable? cancellable = null) throws Error
  Uploads data to a remote server.
• public async Bytes upload_bytes_async (string url, string payload, string? signature, ClientUploadFlags flags, Cancellable? cancellable) throws Error
  Uploads data to a remote server.
• public string upload_report (string url, string payload, string? signature, ClientUploadFlags flags, Cancellable? cancellable = null) throws Error
  Uploads a report to a remote server.
• public async string upload_report_async (string url, string payload, string? signature, ClientUploadFlags flags, Cancellable? cancellable) throws Error
  Uploads a report to a remote server.
• public bool verify (string device_id, Cancellable? cancellable = null) throws Error
  Verify a specific device.
• public async bool verify_async (string device_id, Cancellable? cancellable) throws Error
  Verify a specific device.
• public bool verify_update (string device_id, Cancellable? cancellable = null) throws Error
  Update the verification record for a specific device.
• public async bool verify_update_async (string device_id, Cancellable? cancellable) throws Error
  Update the verification record for a specific device.

Signals:

• public virtual signal void changed ()
  The changed signal is emitted when the daemon internal has changed, for instance when a device has been added or removed.
• public virtual signal void device_added (Device result)
  The device_added signal is emitted when a device has been added.
• public virtual signal void device_changed (Device result)
  The device_changed signal is emitted when a device has been changed in some way, e.
• public virtual signal void device_removed (Device result)
  The device_removed signal is emitted when a device has been removed.
• public virtual signal void device_request (Request request)
  The device_request signal is emitted when a device has been emitted some kind of event, e.
• public virtual signal void status_changed (uint status)

Inherited Members: