FwupdClient: libfwupd Reference Manual

FwupdClient

Functions

FwupdClient *	fwupd_client_new ()
gboolean	fwupd_client_connect ()
GPtrArray *	fwupd_client_get_devices ()
GPtrArray *	fwupd_client_get_updates ()
GPtrArray *	fwupd_client_get_details_local ()
gboolean	fwupd_client_verify ()
gboolean	fwupd_client_verify_update ()
gboolean	fwupd_client_unlock ()
gboolean	fwupd_client_clear_results ()
FwupdResult *	fwupd_client_get_results ()
FwupdResult *	fwupd_client_get_details ()
gboolean	fwupd_client_install ()
gboolean	fwupd_client_update_metadata ()
FwupdStatus	fwupd_client_get_status ()
guint	fwupd_client_get_percentage ()
const gchar *	fwupd_client_get_daemon_version ()

Properties

gchar *	daemon-version	Read
guint	percentage	Read / Write
guint	status	Read / Write

Signals

void	changed	Run Last
void	device-added	Run Last
void	device-changed	Run Last
void	device-removed	Run Last
void	status-changed	Run Last

Types and Values

#define	FWUPD_TYPE_CLIENT
struct	FwupdClientClass
	FwupdClient

Object Hierarchy

    GObject
    ╰── FwupdClient

Description

Functions

fwupd_client_new ()

FwupdClient *
fwupd_client_new (void);

Creates a new client.

Returns

a new FwupdClient

Since: 0.7.0

fwupd_client_connect ()

gboolean
fwupd_client_connect (FwupdClient *client,
                      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.

Parameters

client	A FwupdClient
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for success

Since: 0.7.1

fwupd_client_get_devices ()

GPtrArray *
fwupd_client_get_devices (FwupdClient *client,
                          GCancellable *cancellable,
                          GError **error);

Gets all the devices registered with the daemon.

Parameters

client	A FwupdClient
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

results.

[element-type FwupdResult][transfer container]

Since: 0.7.0

fwupd_client_get_updates ()

GPtrArray *
fwupd_client_get_updates (FwupdClient *client,
                          GCancellable *cancellable,
                          GError **error);

Gets all the devices with known updates.

Parameters

client	A FwupdClient
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

results.

[element-type FwupdResult][transfer container]

Since: 0.7.0

fwupd_client_get_details_local ()

GPtrArray *
fwupd_client_get_details_local (FwupdClient *client,
                                const gchar *filename,
                                GCancellable *cancellable,
                                GError **error);

Gets details about a specific firmware file.

Parameters

client	A FwupdClient
filename	the firmware filename, e.g. "firmware.cab"
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

an array of results.

[transfer container][element-type FwupdResult]

Since: 0.7.2

fwupd_client_verify ()

gboolean
fwupd_client_verify (FwupdClient *client,
                     const gchar *device_id,
                     GCancellable *cancellable,
                     GError **error);

Verify a specific device.

Parameters

client	A FwupdClient
device_id	the device ID
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for verification success

Since: 0.7.0

fwupd_client_verify_update ()

gboolean
fwupd_client_verify_update (FwupdClient *client,
                            const gchar *device_id,
                            GCancellable *cancellable,
                            GError **error);

Update the verification record for a specific device.

Parameters

client	A FwupdClient
device_id	the device ID
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for verification success

Since: 0.8.0

fwupd_client_unlock ()

gboolean
fwupd_client_unlock (FwupdClient *client,
                     const gchar *device_id,
                     GCancellable *cancellable,
                     GError **error);

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

Parameters

client	A FwupdClient
device_id	the device ID
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for success

Since: 0.7.0

fwupd_client_clear_results ()

gboolean
fwupd_client_clear_results (FwupdClient *client,
                            const gchar *device_id,
                            GCancellable *cancellable,
                            GError **error);

Clears the results for a specific device.

Parameters

client	A FwupdClient
device_id	the device ID
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for success

Since: 0.7.0

fwupd_client_get_results ()

FwupdResult *
fwupd_client_get_results (FwupdClient *client,
                          const gchar *device_id,
                          GCancellable *cancellable,
                          GError **error);

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

Parameters

client	A FwupdClient
device_id	the device ID
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

a FwupdResult, or NULL for failure.

[transfer full]

Since: 0.7.0

fwupd_client_get_details ()

FwupdResult *
fwupd_client_get_details (FwupdClient *client,
                          const gchar *filename,
                          GCancellable *cancellable,
                          GError **error);

fwupd_client_get_details is deprecated and should not be used in newly-written code.

Gets details about a specific firmware file.

Parameters

client	A FwupdClient
filename	the firmware filename, e.g. "firmware.cab"
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

a FwupdResult, or NULL for failure.

[transfer full]

Since: 0.7.0

fwupd_client_install ()

gboolean
fwupd_client_install (FwupdClient *client,
                      const gchar *device_id,
                      const gchar *filename,
                      FwupdInstallFlags install_flags,
                      GCancellable *cancellable,
                      GError **error);

Install a file onto a specific device.

Parameters

client	A FwupdClient
device_id	the device ID
filename	the filename to install
install_flags	the FwupdInstallFlags, e.g. `FWUPD_INSTALL_FLAG_ALLOW_REINSTALL`
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for success

Since: 0.7.0

fwupd_client_update_metadata ()

gboolean
fwupd_client_update_metadata (FwupdClient *client,
                              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.

Parameters

client	A FwupdClient
metadata_fn	the XML metadata filename
signature_fn	the GPG signature file
cancellable	the GCancellable, or `NULL`
error	the GError, or `NULL`

Returns

TRUE for success

Since: 0.7.0

fwupd_client_get_status ()

FwupdStatus
fwupd_client_get_status (FwupdClient *client);

Gets the last returned status value.

Parameters

client

A FwupdClient

Returns

a FwupdStatus, or FWUPD_STATUS_UNKNOWN for unknown.

Since: 0.7.3

fwupd_client_get_percentage ()

guint
fwupd_client_get_percentage (FwupdClient *client);

Gets the last returned percentage value.

Parameters

client

A FwupdClient

Returns

a percentage, or 0 for unknown.

Since: 0.7.3

fwupd_client_get_daemon_version ()

const gchar *
fwupd_client_get_daemon_version (FwupdClient *client);

Gets the daemon version number.

Parameters

client

A FwupdClient

Returns

a string, or NULL for unknown.

Since: 0.9.6

Types and Values

FWUPD_TYPE_CLIENT

#define FWUPD_TYPE_CLIENT (fwupd_client_get_type ())

struct FwupdClientClass

struct FwupdClientClass {
	GObjectClass		 parent_class;
	void			(*changed)		(FwupdClient *client);
	void			(*status_changed) (FwupdClient *client,
							 FwupdStatus	 status);
	void			(*device_added)		(FwupdClient *client,
							 FwupdResult *result);
	void			(*device_removed) (FwupdClient *client,
							 FwupdResult *result);
	void			(*device_changed) (FwupdClient *client,
							 FwupdResult *result);
};

FwupdClient

typedef struct _FwupdClient FwupdClient;

Property Details

The `“daemon-version”` property

  “daemon-version”           gchar *

The daemon version number.

Flags: Read

Default value: NULL

Since: 0.9.6

The `“percentage”` property

  “percentage”               guint

The last-reported percentage of the daemon.

Flags: Read / Write

Allowed values: <= 100

Default value: 0

Since: 0.7.3

The `“status”` property

  “status”                   guint

The last-reported status of the daemon.

Flags: Read / Write

Allowed values: <= 8

Default value: 0

Since: 0.7.0

Signal Details

The `“changed”` signal

void
user_function (FwupdClient *client,
               gpointer     user_data)

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

Parameters

client	the FwupdClient instance that emitted the signal
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 0.7.0

The `“device-added”` signal

void
user_function (FwupdClient *client,
               FwupdResult *result,
               gpointer     user_data)

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

Parameters

client	the FwupdClient instance that emitted the signal
result	the FwupdResult
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 0.7.1

The `“device-changed”` signal

void
user_function (FwupdClient *client,
               FwupdResult *result,
               gpointer     user_data)

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

Parameters

client	the FwupdClient instance that emitted the signal
result	the FwupdResult
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 0.7.1

The `“device-removed”` signal

void
user_function (FwupdClient *client,
               FwupdResult *result,
               gpointer     user_data)

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

Parameters

client	the FwupdClient instance that emitted the signal
result	the FwupdResult
user_data	user data set when the signal handler was connected.

Flags: Run Last

Since: 0.7.1

The `“status-changed”` signal

void
user_function (FwupdClient *fwupdclient,
               guint        arg1,
               gpointer     user_data)

Flags: Run Last

FwupdClient

Functions

Properties

Signals

Types and Values

Object Hierarchy

Description

Functions

fwupd_client_new ()

Returns

fwupd_client_connect ()

Parameters

Returns

fwupd_client_get_devices ()

Parameters

Returns

fwupd_client_get_updates ()

Parameters

Returns

fwupd_client_get_details_local ()

Parameters

Returns

fwupd_client_verify ()

Parameters

Returns

fwupd_client_verify_update ()

Parameters

Returns

fwupd_client_unlock ()

Parameters

Returns

fwupd_client_clear_results ()

Parameters

Returns

fwupd_client_get_results ()

Parameters

Returns

fwupd_client_get_details ()

Parameters

Returns

fwupd_client_install ()

Parameters

Returns

fwupd_client_update_metadata ()

Parameters

Returns

fwupd_client_get_status ()

Parameters

Returns

fwupd_client_get_percentage ()

Parameters

Returns

fwupd_client_get_daemon_version ()

Parameters

Returns

Types and Values

FWUPD_TYPE_CLIENT

struct FwupdClientClass

FwupdClient

Property Details

The “daemon-version” property

The “percentage” property

The “status” property

Signal Details

The “changed” signal

Parameters

The “device-added” signal

Parameters

The “device-changed” signal

Parameters

The “device-removed” signal

Parameters

The “status-changed” signal

The `“daemon-version”` property

The `“percentage”` property

The `“status”` property

The `“changed”` signal

The `“device-added”` signal

The `“device-changed”` signal

The `“device-removed”` signal

The `“status-changed”` signal