Top | ![]() |
![]() |
![]() |
![]() |
gboolean fwupd_client_connect (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
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.
[skip]
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.1
GPtrArray * fwupd_client_get_devices (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets all the devices registered with the daemon.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.2
GPtrArray * fwupd_client_get_plugins (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets all the plugins being used the daemon.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.0
GPtrArray * fwupd_client_get_history (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets all the history.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.0.4
GPtrArray * fwupd_client_get_releases (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Gets all the releases for a specific device
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.3
GPtrArray * fwupd_client_get_downgrades (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Gets all the downgrades for a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.8
GPtrArray * fwupd_client_get_upgrades (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Gets all the upgrades for a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.8
GPtrArray * fwupd_client_get_details (FwupdClient *self
,const gchar *filename
,GCancellable *cancellable
,GError **error
);
Gets details about a specific firmware file.
self |
||
filename |
the firmware filename, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.0.0
GPtrArray * fwupd_client_get_details_bytes (FwupdClient *self
,GBytes *bytes
,GCancellable *cancellable
,GError **error
);
Gets details about a specific firmware file.
self |
||
bytes |
the firmware archive |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.0
gboolean fwupd_client_verify (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Verify a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.0
gboolean fwupd_client_verify_update (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Update the verification record for a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.8.0
gboolean fwupd_client_unlock (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Unlocks a specific device so firmware can be read or wrote.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.0
gboolean fwupd_client_modify_config (FwupdClient *self
,const gchar *key
,const gchar *value
,GCancellable *cancellable
,GError **error
);
Modifies a daemon config option. The daemon will only respond to this request with proper permissions.
self |
||
key |
config key, e.g. |
|
value |
config value, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.2.8
gboolean fwupd_client_activate (FwupdClient *self
,GCancellable *cancellable
,const gchar *device_id
,GError **error
);
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.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
device_id |
a device |
|
error |
optional return location for an error. |
[nullable] |
Since: 1.2.6
gboolean fwupd_client_clear_results (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Clears the results for a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.0
FwupdDevice * fwupd_client_get_results (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Gets the results of a previous firmware update for a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.0
GPtrArray * fwupd_client_get_host_security_attrs (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets all the host security attributes from the daemon.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.0
GPtrArray * fwupd_client_get_host_security_events (FwupdClient *self
,guint limit
,GCancellable *cancellable
,GError **error
);
Gets all the host security events from the daemon.
self |
||
limit |
maximum number of events, or 0 for no limit |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.7.1
FwupdDevice * fwupd_client_get_device_by_id (FwupdClient *self
,const gchar *device_id
,GCancellable *cancellable
,GError **error
);
Gets a device by its device ID.
self |
||
device_id |
the device ID, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.3
GPtrArray * fwupd_client_get_devices_by_guid (FwupdClient *self
,const gchar *guid
,GCancellable *cancellable
,GError **error
);
Gets any devices that provide a specific GUID. An error is returned if no devices contains this GUID.
self |
||
guid |
the GUID, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.1
gboolean fwupd_client_install (FwupdClient *self
,const gchar *device_id
,const gchar *filename
,FwupdInstallFlags install_flags
,GCancellable *cancellable
,GError **error
);
Install a file onto a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
filename |
the filename to install |
|
install_flags |
install flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.7.0
gboolean fwupd_client_install_bytes (FwupdClient *self
,const gchar *device_id
,GBytes *bytes
,FwupdInstallFlags install_flags
,GCancellable *cancellable
,GError **error
);
Install firmware onto a specific device.
self |
||
device_id |
the device ID. |
[not nullable] |
bytes |
cabinet archive |
|
install_flags |
install flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
gboolean fwupd_client_install_release (FwupdClient *self
,FwupdDevice *device
,FwupdRelease *release
,FwupdInstallFlags install_flags
,GCancellable *cancellable
,GError **error
);
fwupd_client_install_release
has been deprecated since version 1.5.6 and should not be used in newly-written code.
Installs a new release on a device, downloading the firmware if required.
self |
||
device |
a device |
|
release |
a release |
|
install_flags |
install flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
gboolean fwupd_client_install_release2 (FwupdClient *self
,FwupdDevice *device
,FwupdRelease *release
,FwupdInstallFlags install_flags
,FwupdClientDownloadFlags download_flags
,GCancellable *cancellable
,GError **error
);
Installs a new release on a device, downloading the firmware if required.
self |
||
device |
a device |
|
release |
a release |
|
install_flags |
install flags, e.g. |
|
download_flags |
download flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.6
gboolean fwupd_client_update_metadata (FwupdClient *self
,const gchar *remote_id
,const gchar *metadata_fn
,const gchar *signature_fn
,GCancellable *cancellable
,GError **error
);
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.
self |
||
remote_id |
the remote ID, e.g. |
|
metadata_fn |
the XML metadata filename |
|
signature_fn |
the GPG signature file |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.0.0
gboolean fwupd_client_update_metadata_bytes (FwupdClient *self
,const gchar *remote_id
,GBytes *metadata
,GBytes *signature
,GCancellable *cancellable
,GError **error
);
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.
self |
||
remote_id |
remote ID, e.g. |
|
metadata |
XML metadata data |
|
signature |
signature data |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
gboolean fwupd_client_refresh_remote (FwupdClient *self
,FwupdRemote *remote
,GCancellable *cancellable
,GError **error
);
Refreshes a remote by downloading new metadata.
self |
||
remote |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
gboolean fwupd_client_modify_remote (FwupdClient *self
,const gchar *remote_id
,const gchar *key
,const gchar *value
,GCancellable *cancellable
,GError **error
);
Modifies a system remote in a specific way.
NOTE: User authentication may be required to complete this action.
self |
||
remote_id |
the remote ID, e.g. |
|
key |
the key, e.g. |
|
value |
the key, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.8
gboolean fwupd_client_modify_device (FwupdClient *self
,const gchar *device_id
,const gchar *key
,const gchar *value
,GCancellable *cancellable
,GError **error
);
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
.
NOTE: User authentication may be required to complete this action.
self |
||
device_id |
the device ID. |
[not nullable] |
key |
the key, e.g. |
[not nullable] |
value |
the key, e.g. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.0.4
GHashTable * fwupd_client_get_report_metadata (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets all the report metadata from the daemon.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.0
GPtrArray * fwupd_client_get_remotes (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets the list of remotes that have been configured for the system.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.3
FwupdRemote * fwupd_client_get_remote_by_id (FwupdClient *self
,const gchar *remote_id
,GCancellable *cancellable
,GError **error
);
Gets a specific remote that has been configured for the system.
self |
||
remote_id |
the remote ID, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 0.9.3
gchar ** fwupd_client_get_approved_firmware (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets the list of approved firmware.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.2.6
gboolean fwupd_client_set_approved_firmware (FwupdClient *self
,gchar **checksums
,GCancellable *cancellable
,GError **error
);
Sets the list of approved firmware.
self |
||
checksums |
Array of checksums. |
[not nullable] |
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.2.6
gchar ** fwupd_client_get_blocked_firmware (FwupdClient *self
,GCancellable *cancellable
,GError **error
);
Gets the list of blocked firmware.
self |
||
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.6
gboolean fwupd_client_set_blocked_firmware (FwupdClient *self
,gchar **checksums
,GCancellable *cancellable
,GError **error
);
Sets the list of approved firmware.
self |
||
checksums |
Array of checksums |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.6
gchar * fwupd_client_self_sign (FwupdClient *self
,const gchar *value
,FwupdSelfSignFlags flags
,GCancellable *cancellable
,GError **error
);
Signs the data using the client self-signed certificate.
self |
||
value |
a string to sign, typically a JSON blob. |
[not nullable] |
flags |
signing flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.2.6
gboolean fwupd_client_set_feature_flags (FwupdClient *self
,FwupdFeatureFlags feature_flags
,GCancellable *cancellable
,GError **error
);
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.
self |
||
feature_flags |
feature flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
GBytes * fwupd_client_download_bytes (FwupdClient *self
,const gchar *url
,FwupdClientDownloadFlags flags
,GCancellable *cancellable
,GError **error
);
Downloads data from a remote server. The [methodClient.set_user_agent
] function
should be called before this method is used.
self |
||
url |
the remote URL. |
[not nullable] |
flags |
download flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5
gboolean fwupd_client_download_file (FwupdClient *self
,const gchar *url
,GFile *file
,FwupdClientDownloadFlags flags
,GCancellable *cancellable
,GError **error
);
Downloads data from a remote server. The [methodClient.set_user_agent
] function
should be called before this method is used.
self |
||
url |
the remote URL. |
[not nullable] |
file |
a file. |
[not nullable] |
flags |
download flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.5.2
GBytes * fwupd_client_upload_bytes (FwupdClient *self
,const gchar *url
,const gchar *payload
,const gchar *signature
,FwupdClientUploadFlags flags
,GCancellable *cancellable
,GError **error
);
Uploads data to a remote server. The [methodClient.set_user_agent
] function
should be called before this method is used.
self |
||
url |
the remote URL. |
[not nullable] |
payload |
payload string. |
[not nullable] |
signature |
signature string. |
[nullable] |
flags |
download flags, e.g. |
|
cancellable |
optional GCancellable. |
[nullable] |
error |
optional return location for an error. |
[nullable] |
Since: 1.4.5