ModemManager.ModemFirmware¶

Subclasses:	None

Methods¶

Inherited:	ModemManager.GdbusModemFirmwareProxy (6), Gio.DBusProxy (25), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusInterface (3), Gio.Initable (2), ModemManager.GdbusModemFirmware (10)
Structs:	GObject.ObjectClass (5)

	`dup_path` ()
	`get_path` ()
	`get_update_settings` ()
	`list` (cancellable, callback, *user_data)
	`list_finish` (res)
	`list_sync` (cancellable)
	`peek_update_settings` ()
	`select` (unique_id, cancellable, callback, *user_data)
	`select_finish` (res)
	`select_sync` (unique_id, cancellable)

Virtual Methods¶

Inherited:	Gio.DBusProxy (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusInterface (3), Gio.Initable (1), ModemManager.GdbusModemFirmware (2)

Properties¶

Inherited:	Gio.DBusProxy (9), ModemManager.GdbusModemFirmware (1)

Signals¶

Inherited:	Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModemFirmware (2)

Fields¶

Inherited:	Gio.DBusProxy (2), GObject.Object (1), ModemManager.GdbusModemFirmware (2)

Name	Type	Access	Description
parent	`ModemManager.GdbusModemFirmwareProxy`	r

Class Details¶

class ModemManager.ModemFirmware(**kwargs)¶

Bases:	`ModemManager.GdbusModemFirmwareProxy`
Abstract:	No
Structure:	`ModemManager.ModemFirmwareClass`

The ModemManager.ModemFirmware structure contains private data and should only be accessed using the provided API.

dup_path()¶

Returns:	The DBus path of the `ModemManager.Object`. The returned value should be freed with `GLib.free`().
Return type:	`str`

Gets a copy of the DBus path of the ModemManager.Object object which implements this interface.

New in version 1.0.

get_path()¶

Returns:	The DBus path of the `ModemManager.Object` object.
Return type:	`str`

Gets the DBus path of the ModemManager.Object which implements this interface.

New in version 1.0.

get_update_settings()¶

Returns:	A `ModemManager.FirmwareUpdateSettings` that must be freed with `GObject.Object.unref`() or `None` if unknown.
Return type:	`ModemManager.FirmwareUpdateSettings`

Gets a ModemManager.FirmwareUpdateSettings object specifying the expected update settings.

The values reported by self are not updated when the values in the interface change. Instead, the client is expected to call ModemManager.ModemFirmware.get_update_settings() again to get a new ModemManager.FirmwareUpdateSettings with the new values.

New in version 1.10.

list(cancellable, callback, *user_data)¶

Parameters:	cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously gets the list of available firmware images.

When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.ModemFirmware.list_finish() to get the result of the operation.

See ModemManager.ModemFirmware.list_sync() for the synchronous, blocking version of this method.

New in version 1.0.

list_finish(res)¶

Parameters: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.ModemFirmware.list().

Raises: GLib.Error

Returns:

True if the list was correctly retrieved, False if error is set.

selected:	The selected firmware slot, or `None` if no slot is selected (such as if all slots are empty, or no slots exist). The returned value should be freed with `GObject.Object.unref`().
installed:	A list of `ModemManager.FirmwareProperties` objects specifying the installed images. The returned value should be freed with g_list_free_full() using `GObject.Object.unref`() as `GLib.DestroyNotify`.

Return type: (bool, selected: ModemManager.FirmwareProperties, installed: [ModemManager.FirmwareProperties])

Finishes an operation started with ModemManager.ModemFirmware.list().

New in version 1.0.

list_sync(cancellable)¶

Parameters: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises: GLib.Error

Returns:

True if the list was correctly retrieved, False if error is set.

selected:	The selected firmware slot, or `None` if no slot is selected (such as if all slots are empty, or no slots exist). The returned value should be freed with `GObject.Object.unref`().
installed:	A list of `ModemManager.FirmwareProperties` objects specifying the installed images. The returned value should be freed with g_list_free_full() using `GObject.Object.unref`() as `GLib.DestroyNotify`.

Return type: (bool, selected: ModemManager.FirmwareProperties, installed: [ModemManager.FirmwareProperties])

Synchronously gets the list of available firmware images.

The calling thread is blocked until a reply is received. See ModemManager.ModemFirmware.list() for the asynchronous version of this method.

New in version 1.0.

peek_update_settings()¶

Returns:	A `ModemManager.FirmwareUpdateSettings`. Do not free the returned value, it belongs to self.
Return type:	`ModemManager.FirmwareUpdateSettings`

Gets a ModemManager.FirmwareUpdateSettings object specifying the expected update settings.

The returned value is only valid until the property changes so it is only safe to use this function on the thread where self was constructed. Use ModemManager.ModemFirmware.get_update_settings() if on another thread.

New in version 1.10.

select(unique_id, cancellable, callback, *user_data)¶

Parameters:	unique_id (`str`) – Unique ID of the firmware image to select. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`. callback (`Gio.AsyncReadyCallback` or `None`) – A `Gio.AsyncReadyCallback` to call when the request is satisfied or `None`. user_data (`object` or `None`) – User data to pass to callback.

Asynchronously selects a firmware image to boot.

The modem will possibly disappear once this action is run, as it needs to reboot in order to select the new image. When the operation is finished, callback will be invoked in the

thread-default main loop of the thread you are calling this method from. You can then call ModemManager.ModemFirmware.select_finish() to get the result of the operation.

See ModemManager.ModemFirmware.select_sync() for the synchronous, blocking version of this method.

New in version 1.0.

select_finish(res)¶

Parameters:	res (`Gio.AsyncResult`) – The `Gio.AsyncResult` obtained from the `Gio.AsyncReadyCallback` passed to `ModemManager.ModemFirmware.select`().
Raises:	`GLib.Error`
Returns:	`True` if the selection was successful, `False` if error is set.
Return type:	`bool`

Finishes an operation started with ModemManager.ModemFirmware.select().

New in version 1.0.

select_sync(unique_id, cancellable)¶

Parameters:	unique_id (`str`) – Unique ID of the firmware image to select. cancellable (`Gio.Cancellable` or `None`) – A `Gio.Cancellable` or `None`.
Raises:	`GLib.Error`
Returns:	`True` if the selection was successful, `False` if error is set.
Return type:	`bool`

Synchronously selects a firmware image to boot.

The modem will possibly disappear once this action is run, as it needs to reboot in order to select the new image. The calling thread is blocked until a reply is received. See ModemManager.ModemFirmware.select() for the asynchronous version of this method.

New in version 1.0.