ModemManager.Manager¶

Subclasses:: None

Methods¶

Inherited:: ModemManager.GdbusObjectManagerClient (7), Gio.DBusObjectManagerClient (10), GObject.Object (37), Gio.AsyncInitable (4), Gio.DBusObjectManager (4), Gio.Initable (2)
Structs:: GObject.ObjectClass (5)

class	`new` (connection, flags, cancellable, callback, *user_data)
class	`new_finish` (res)
class	`new_sync` (connection, flags, cancellable)
	`get_proxy` ()
	`get_version` ()
	`inhibit_device` (uid, cancellable, callback, *user_data)
	`inhibit_device_finish` (res)
	`inhibit_device_sync` (uid, cancellable)
	`peek_proxy` ()
	`report_kernel_event` (properties, cancellable, callback, *user_data)
	`report_kernel_event_finish` (res)
	`report_kernel_event_sync` (properties, cancellable)
	`scan_devices` (cancellable, callback, *user_data)
	`scan_devices_finish` (res)
	`scan_devices_sync` (cancellable)
	`set_logging` (level, cancellable, callback, *user_data)
	`set_logging_finish` (res)
	`set_logging_sync` (level, cancellable)
	`uninhibit_device` (uid, cancellable, callback, *user_data)
	`uninhibit_device_finish` (res)
	`uninhibit_device_sync` (uid, cancellable)

Virtual Methods¶

Inherited:: Gio.DBusObjectManagerClient (2), GObject.Object (7), Gio.AsyncInitable (2), Gio.DBusObjectManager (8), Gio.Initable (1)

Properties¶

Inherited:: Gio.DBusObjectManagerClient (9)

Signals¶

Inherited:: Gio.DBusObjectManagerClient (2), GObject.Object (1), Gio.DBusObjectManager (4)

Fields¶

Inherited:: Gio.DBusObjectManagerClient (2), GObject.Object (1), Gio.DBusObjectManager (4)

Name	Type	Access	Description
parent	`ModemManager.GdbusObjectManagerClient`	r

Class Details¶

class ModemManager.Manager(**kwargs)¶

Bases:: ModemManager.GdbusObjectManagerClient
Abstract:: No
Structure:: ModemManager.ManagerClass

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

classmethod new(connection, flags, cancellable, callback, *user_data)¶

Parameters:

connection (Gio.DBusConnection) – A Gio.DBusConnection.
flags (Gio.DBusObjectManagerClientFlags) – Flags from the Gio.DBusObjectManagerClientFlags enumeration.
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.
user_data (object or None) – User data to pass to callback.

Asynchronously creates a ModemManager.Manager.

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.Manager.new_finish() to get the result of the operation.

See ModemManager.Manager.new_sync() for the synchronous, blocking version of this constructor.

New in version 1.0.

classmethod new_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.new().
Raises:: GLib.Error
Returns:: The constructed object manager client or None if error is set.
Return type:: ModemManager.Manager

Finishes an operation started with ModemManager.Manager.new().

New in version 1.0.

classmethod new_sync(connection, flags, cancellable)¶

Parameters:

connection (Gio.DBusConnection) – A Gio.DBusConnection.
flags (Gio.DBusObjectManagerClientFlags) – Flags from the Gio.DBusObjectManagerClientFlags enumeration.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

The constructed object manager client or None if error is set.

Return type:

ModemManager.Manager

Synchronously creates a ModemManager.Manager.

The calling thread is blocked until a reply is received.

See ModemManager.Manager.new() for the asynchronous version of this constructor.

New in version 1.0.

get_proxy()¶

Returns:: The Gio.DBusProxy interface of self, or None if none. The returned object must be freed with GObject.Object.unref().
Return type:: Gio.DBusProxy

Gets the Gio.DBusProxy interface of the self.

New in version 1.0.

get_version()¶

Returns:: The version, or None if none available. Do not free the returned value, it belongs to self.
Return type:: str

Gets the ModemManager version, as reported by the daemon.

It is safe to assume this value never changes during runtime.

New in version 1.0.

inhibit_device(uid, cancellable, callback, *user_data)¶

Parameters:

uid (str) – the unique ID of the physical device.
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 requests to add an inhibition on the device identified by uid.

The uid must be the unique ID retrieved from an existing ModemManager.Modem using ModemManager.Modem.get_device(). The caller should keep track of this uid and use it in the ModemManager.Manager.uninhibit_device() call when the inhibition is no longer required.

The inhibition added with this method may also be automatically removed when the caller program disappears from the bus (e.g. if the program ends before having called ModemManager.Manager.uninhibit_device() explicitly).

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.Manager.inhibit_device_finish() to get the result of the operation.

See ModemManager.Manager.inhibit_device_sync() for the synchronous, blocking version of this method.

New in version 1.10.

inhibit_device_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.inhibit_device().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Manager.inhibit_device().

New in version 1.10.

inhibit_device_sync(uid, cancellable)¶

Parameters:

uid (str) – the unique ID of the physical device.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously requests to add an inhibition on the device identified by uid.

The uid must be the unique ID retrieved from an existing ModemManager.Modem using ModemManager.Modem.get_device(). The caller should keep track of this uid and use it in the ModemManager.Manager.uninhibit_device_sync() call when the inhibition is no longer required.

The inhibition added with this method may also be automatically removed when the caller program disappears from the bus (e.g. if the program ends before having called ModemManager.Manager.uninhibit_device_sync() explicitly).

See ModemManager.Manager.inhibit_device() for the asynchronous version of this method.

New in version 1.10.

peek_proxy()¶

Returns:: The Gio.DBusProxy interface of self, or None if none. Do not free the returned object, it is owned by self.
Return type:: Gio.DBusProxy

Gets the Gio.DBusProxy interface of the self.

New in version 1.0.

report_kernel_event(properties, cancellable, callback, *user_data)¶

Parameters:

properties (ModemManager.KernelEventProperties) – the properties of the kernel event.
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 report kernel event.

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.Manager.report_kernel_event_finish() to get the result of the operation.

See ModemManager.Manager.report_kernel_event_sync() for the synchronous, blocking version of this method.

New in version 1.8.

report_kernel_event_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.report_kernel_event().
Raises:: GLib.Error
Returns:: True if the operation succeeded, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Manager.report_kernel_event().

New in version 1.8.

report_kernel_event_sync(properties, cancellable)¶

Parameters:

properties (ModemManager.KernelEventProperties) – the properties of the kernel event.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the operation succeeded, False if error is set.

Return type:

bool

Synchronously report kernel event.

The calling thread is blocked until a reply is received.

See ModemManager.Manager.report_kernel_event() for the asynchronous version of this method.

New in version 1.8.

scan_devices(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 requests to scan looking for devices.

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.Manager.scan_devices_finish() to get the result of the operation.

See ModemManager.Manager.scan_devices_sync() for the synchronous, blocking version of this method.

New in version 1.0.

scan_devices_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.scan_devices().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Manager.scan_devices().

New in version 1.0.

scan_devices_sync(cancellable)¶

Parameters:: cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Synchronously requests to scan looking for devices.

The calling thread is blocked until a reply is received.

See ModemManager.Manager.scan_devices() for the asynchronous version of this method.

New in version 1.0.

set_logging(level, cancellable, callback, *user_data)¶

Parameters:

level (str) – the login level to set.
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 requests to set the specified logging level in the daemon.

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.Manager.set_logging_finish() to get the result of the operation.

See ModemManager.Manager.set_logging_sync() for the synchronous, blocking version of this method.

New in version 1.0.

set_logging_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.set_logging().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Manager.set_logging().

New in version 1.0.

set_logging_sync(level, cancellable)¶

Parameters:

level (str) – the login level to set.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously requests to set the specified logging level in the daemon.

The calling thread is blocked until a reply is received.

See ModemManager.Manager.set_logging() for the asynchronous version of this method.

New in version 1.0.

uninhibit_device(uid, cancellable, callback, *user_data)¶

Parameters:

uid (str) – the unique ID of the physical device.
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 requests to remove an inhibition on the device identified by uid.

The uid must be the same unique ID that was sent in the inhibition request.

Only the same program that placed an inhibition on a given device is able to remove the inhibition.

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.Manager.uninhibit_device_finish() to get the result of the operation.

See ModemManager.Manager.uninhibit_device_sync() for the synchronous, blocking version of this method.

New in version 1.10.

uninhibit_device_finish(res)¶

Parameters:: res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.Manager.uninhibit_device().
Raises:: GLib.Error
Returns:: True if the call succeeded, False if error is set.
Return type:: bool

Finishes an operation started with ModemManager.Manager.uninhibit_device().

New in version 1.10.

uninhibit_device_sync(uid, cancellable)¶

Parameters:

uid (str) – the unique ID of the physical device.
cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

True if the call succeeded, False if error is set.

Return type:

bool

Synchronously requests to remove an inhibition on the device identified by uid.

The uid must be the same unique ID that was sent in the inhibition request.

Only the same program that placed an inhibition on a given device is able to remove the inhibition.

See ModemManager.Manager.uninhibit_device() for the asynchronous version of this method.

New in version 1.10.