Client

---

Object Hierarchy:

Description:

Content:

Properties:

• public string daemon_version { get; }
  The daemon version number.
• public string host_machine_id { get; }
  The host machine-id string
• public string host_product { get; }
  The host product string
• public string host_security_id { get; }
  The host machine-id string
• public bool interactive { get; }
  If the daemon is running in an interactive terminal
• public uint percentage { get; set; }
  The last-reported percentage of the daemon.
• public Object soup_session { owned get; }
  The libsoup session, now unused.
• 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 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 bool connect (Cancellable? cancellable = null) throws Error
  Sets up the client ready for use.
• 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 bool ensure_networking () throws Error
  Sets up the client networking support ready for use.
• 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 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 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 it's 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_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 unowned string get_host_security_id ()
  Gets the string that represents the host machine ID
• public MainContext get_main_context ()
  Gets the internal MainContext to use for synchronous methods.
• public uint get_percentage ()
  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 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, Cancellable? cancellable = null) throws Error
  Installs a new release on a device, downloading the firmware if required.
• public bool install_release2 (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 void install_release2_async (Device device, Release release, InstallFlags install_flags, ClientDownloadFlags download_flags, Cancellable? cancellable)
  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, Cancellable? cancellable) throws Error
  Installs a new release on a device, downloading the firmware if required.
• public bool modify_config (string key, string value, Cancellable? cancellable = null) throws Error
  Modifies a daemon config option.
• public async bool modify_config_async (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 bool refresh_remote (Remote remote, Cancellable? cancellable = null) throws Error
  Refreshes a remote by downloading new metadata.
• public async bool refresh_remote_async (Remote remote, Cancellable? cancellable) throws Error
  Refreshes a remote by downloading new metadata.
• 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 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_main_context (MainContext? main_ctx)
  Sets the internal MainContext to use for returning progress signals.
• 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 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 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 status_changed (uint status)

Inherited Members: