ModemManager.GdbusModemMessaging

Implementations:

ModemManager.GdbusModemMessagingProxy, ModemManager.GdbusModemMessagingSkeleton

Methods

class	interface_info ()
class	override_properties (klass, property_id_begin)
	call_create (arg_properties, cancellable, callback, *user_data)
	call_create_finish (res)
	call_create_sync (arg_properties, cancellable)
	call_delete (arg_path, cancellable, callback, *user_data)
	call_delete_finish (res)
	call_delete_sync (arg_path, cancellable)
	call_list (cancellable, callback, *user_data)
	call_list_finish (res)
	call_list_sync (cancellable)
	complete_create (invocation, path)
	complete_delete (invocation)
	complete_list (invocation, result)
	emit_added (arg_path, arg_received)
	emit_deleted (arg_path)

Virtual Methods

	do_added (arg_path, arg_received)
	do_deleted (arg_path)
	do_handle_create (invocation, arg_properties)
	do_handle_delete (invocation, arg_path)
	do_handle_list (invocation)

Properties

Name	Type	Flags	Short Description
default-storage	int	r/w	DefaultStorage
messages	[str]	r/w	Messages
supported-storages	GLib.Variant	r/w	SupportedStorages

Signals

Name	Short Description
added	On the client-side, this signal is emitted whenever the D-Bus signal ‘“Added” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Added]’ is received.
deleted	On the client-side, this signal is emitted whenever the D-Bus signal ‘“Deleted” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Deleted]’ is received.
handle-create	Signal emitted when a remote caller is invoking the ‘Create() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Create]’ D-Bus method.
handle-delete	Signal emitted when a remote caller is invoking the ‘Delete() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Delete]’ D-Bus method.
handle-list	Signal emitted when a remote caller is invoking the ‘List() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.List]’ D-Bus method.

Fields

None

Class Details

class ModemManager.GdbusModemMessaging

Bases:

GObject.GInterface

Structure:

ModemManager.GdbusModemMessagingIface

Abstract interface type for the D-Bus interface ‘org.freedesktop.ModemManager1.Modem.Messaging [gdbus-interface-org-freedesktop-ModemManager1-Modem-Messaging.top_of_page]’.

classmethod interface_info()

Returns:

A Gio.DBusInterfaceInfo. Do not free.

Return type:

Gio.DBusInterfaceInfo

Gets a machine-readable description of the ‘org.freedesktop.ModemManager1.Modem.Messaging [gdbus-interface-org-freedesktop-ModemManager1-Modem-Messaging.top_of_page]’ D-Bus interface.

classmethod override_properties(klass, property_id_begin)

Parameters:

• klass (GObject.ObjectClass) – The class structure for a GObject.Object derived class.

• property_id_begin (int) – The property id to assign to the first overridden property.

Returns:

The last property id.

Return type:

int

Overrides all GObject.Object properties in the ModemManager.GdbusModemMessaging interface for a concrete class. The properties are overridden in the order they are defined.

call_create(arg_properties, cancellable, callback, *user_data)

Parameters:

• arg_properties (GLib.Variant) – Argument to pass with the method invocation.

• 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 invokes the ‘Create() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Create]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call ModemManager.GdbusModemMessaging.call_create_finish() to get the result of the operation.

See ModemManager.GdbusModemMessaging.call_create_sync() for the synchronous, blocking version of this method.

call_create_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.GdbusModemMessaging.call_create().

Raises:

GLib.Error

Returns:

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

out_path:

Return location for return parameter or None to ignore.

Return type:

(bool, out_path: str)

Finishes an operation started with ModemManager.GdbusModemMessaging.call_create().

call_create_sync(arg_properties, cancellable)

Parameters:

• arg_properties (GLib.Variant) – Argument to pass with the method invocation.

• cancellable (Gio.Cancellable or None) – A Gio.Cancellable or None.

Raises:

GLib.Error

Returns:

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

out_path:

Return location for return parameter or None to ignore.

Return type:

(bool, out_path: str)

Synchronously invokes the ‘Create() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Create]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See ModemManager.GdbusModemMessaging.call_create() for the asynchronous version of this method.

call_delete(arg_path, cancellable, callback, *user_data)

Parameters:

• arg_path (str) – Argument to pass with the method invocation.

• 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 invokes the ‘Delete() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Delete]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call ModemManager.GdbusModemMessaging.call_delete_finish() to get the result of the operation.

See ModemManager.GdbusModemMessaging.call_delete_sync() for the synchronous, blocking version of this method.

call_delete_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.GdbusModemMessaging.call_delete().

Raises:

GLib.Error

Returns:

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

Return type:

bool

Finishes an operation started with ModemManager.GdbusModemMessaging.call_delete().

call_delete_sync(arg_path, cancellable)

Parameters:

• arg_path (str) – Argument to pass with the method invocation.

• 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 invokes the ‘Delete() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Delete]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See ModemManager.GdbusModemMessaging.call_delete() for the asynchronous version of this method.

call_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 invokes the ‘List() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.List]’ D-Bus method on self. When the operation is finished, callback will be invoked in the thread-default main loop of the thread you are calling this method from (see GLib.MainContext.push_thread_default()). You can then call ModemManager.GdbusModemMessaging.call_list_finish() to get the result of the operation.

See ModemManager.GdbusModemMessaging.call_list_sync() for the synchronous, blocking version of this method.

call_list_finish(res)

Parameters:

res (Gio.AsyncResult) – The Gio.AsyncResult obtained from the Gio.AsyncReadyCallback passed to ModemManager.GdbusModemMessaging.call_list().

Raises:

GLib.Error

Returns:

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

out_result:

Return location for return parameter or None to ignore.

Return type:

(bool, out_result: [str])

Finishes an operation started with ModemManager.GdbusModemMessaging.call_list().

call_list_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.

out_result:

Return location for return parameter or None to ignore.

Return type:

(bool, out_result: [str])

Synchronously invokes the ‘List() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.List]’ D-Bus method on self. The calling thread is blocked until a reply is received.

See ModemManager.GdbusModemMessaging.call_list() for the asynchronous version of this method.

complete_create(invocation, path)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• path (str) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘Create() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Create]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_delete(invocation)

Parameters:

invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Helper function used in service implementations to finish handling invocations of the ‘Delete() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Delete]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

complete_list(invocation, result)

Parameters:

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• result (str) – Parameter to return.

Helper function used in service implementations to finish handling invocations of the ‘List() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.List]’ D-Bus method. If you instead want to finish handling an invocation by returning an error, use g_dbus_method_invocation_return_error() or similar.

This method will free invocation, you cannot use it afterwards.

emit_added(arg_path, arg_received)

Parameters:

• arg_path (str) – Argument to pass with the signal.

• arg_received (bool) – Argument to pass with the signal.

Emits the ‘“Added” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Added]’ D-Bus signal.

emit_deleted(arg_path)

Parameters:

arg_path (str) – Argument to pass with the signal.

Emits the ‘“Deleted” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Deleted]’ D-Bus signal.

do_added(arg_path, arg_received) virtual

Parameters:

• arg_path (str) –

• arg_received (bool) –

do_deleted(arg_path) virtual

Parameters:

arg_path (str) –

do_handle_create(invocation, arg_properties) virtual

Parameters:

• invocation (Gio.DBusMethodInvocation) –

• arg_properties (GLib.Variant) –

Return type:

bool

do_handle_delete(invocation, arg_path) virtual

Parameters:

• invocation (Gio.DBusMethodInvocation) –

• arg_path (str) –

Return type:

bool

do_handle_list(invocation) virtual

Parameters:

invocation (Gio.DBusMethodInvocation) –

Return type:

bool

Signal Details

ModemManager.GdbusModemMessaging.signals.added(gdbus_modem_messaging, arg_path, arg_received)

Signal Name:

added

Flags:

RUN_LAST

Parameters:

• gdbus_modem_messaging (ModemManager.GdbusModemMessaging) – The object which received the signal

• arg_path (str) – Argument.

• arg_received (bool) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“Added” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Added]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

ModemManager.GdbusModemMessaging.signals.deleted(gdbus_modem_messaging, arg_path)

Signal Name:

deleted

Flags:

RUN_LAST

Parameters:

• gdbus_modem_messaging (ModemManager.GdbusModemMessaging) – The object which received the signal

• arg_path (str) – Argument.

On the client-side, this signal is emitted whenever the D-Bus signal ‘“Deleted” [gdbus-signal-org-freedesktop-ModemManager1-Modem-Messaging.Deleted]’ is received.

On the service-side, this signal can be used with e.g. g_signal_emit_by_name() to make the object emit the D-Bus signal.

ModemManager.GdbusModemMessaging.signals.handle_create(gdbus_modem_messaging, invocation, arg_properties)

Signal Name:

handle-create

Flags:

RUN_LAST

Parameters:

• gdbus_modem_messaging (ModemManager.GdbusModemMessaging) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• arg_properties (GLib.Variant) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Create() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Create]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call ModemManager.GdbusModemMessaging.complete_create() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

ModemManager.GdbusModemMessaging.signals.handle_delete(gdbus_modem_messaging, invocation, arg_path)

Signal Name:

handle-delete

Flags:

RUN_LAST

Parameters:

• gdbus_modem_messaging (ModemManager.GdbusModemMessaging) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

• arg_path (str) – Argument passed by remote caller.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘Delete() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.Delete]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call ModemManager.GdbusModemMessaging.complete_delete() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

ModemManager.GdbusModemMessaging.signals.handle_list(gdbus_modem_messaging, invocation)

Signal Name:

handle-list

Flags:

RUN_LAST

Parameters:

• gdbus_modem_messaging (ModemManager.GdbusModemMessaging) – The object which received the signal

• invocation (Gio.DBusMethodInvocation) – A Gio.DBusMethodInvocation.

Returns:

Gio.DBUS_METHOD_INVOCATION_HANDLED or True if the invocation was handled, Gio.DBUS_METHOD_INVOCATION_UNHANDLED or False to let other signal handlers run.

Return type:

bool

Signal emitted when a remote caller is invoking the ‘List() [gdbus-method-org-freedesktop-ModemManager1-Modem-Messaging.List]’ D-Bus method.

If a signal handler returns True, it means the signal handler will handle the invocation (e.g. take a reference to invocation and eventually call ModemManager.GdbusModemMessaging.complete_list() or e.g. g_dbus_method_invocation_return_error() on it) and no other signal handlers will run. If no signal handler handles the invocation, the Gio.DBusError.UNKNOWN_METHOD error is returned.

Property Details

ModemManager.GdbusModemMessaging.props.default_storage

Name:

default-storage

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE

Represents the D-Bus property ‘“DefaultStorage” [gdbus-property-org-freedesktop-ModemManager1-Modem-Messaging.DefaultStorage]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

ModemManager.GdbusModemMessaging.props.messages

Name:

messages

Type:

[str]

Default Value:

[]

Flags:

READABLE, WRITABLE

Represents the D-Bus property ‘“Messages” [gdbus-property-org-freedesktop-ModemManager1-Modem-Messaging.Messages]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.

ModemManager.GdbusModemMessaging.props.supported_storages

Name:

supported-storages

Type:

GLib.Variant

Default Value:

None

Flags:

READABLE, WRITABLE

Represents the D-Bus property ‘“SupportedStorages” [gdbus-property-org-freedesktop-ModemManager1-Modem-Messaging.SupportedStorages]’.

Since the D-Bus property for this GObject.Object property is readable but not writable, it is meaningful to read from it on both the client- and service-side. It is only meaningful, however, to write to it on the service-side.