QDBusMessage¶

PyQt5.QtDBus.QDBusMessage

Description¶

The QDBusMessage class represents one message sent or received over the D-Bus bus.

This object can represent any of the four different types of messages (MessageType) that can occur on the bus:

Method calls
Method return values
Signal emissions
Error codes

Objects of this type are created with the static createError(), createMethodCall() and createSignal() functions. Use the QDBusConnection::send() function to send the messages.

Enums¶

MessageType

The possible message types:

Member	Value	Description
ErrorMessage	3	a message representing an error condition in response to a method call
InvalidMessage	0	an invalid message: this is never set on messages received from D-Bus
MethodCallMessage	1	a message representing an outgoing or incoming method call
ReplyMessage	2	a message representing the return values of a method call
SignalMessage	4	a message representing an outgoing or incoming signal emission

Methods¶

__init__(): Constructs an empty, invalid QDBusMessage object.

See also

createError(), createMethodCall().

__init__(QDBusMessage)

Constructs a copy of the object given by other.

Note: QDBusMessage objects are shared. Modifications made to the copy will affect the original one as well. See setDelayedReply() for more information.

arguments() → List[Any]: Returns the list of arguments that are going to be sent or were received from D-Bus.

See also

setArguments().

autoStartService() → bool: Returns the auto start flag, as set by setAutoStartService(). By default, this flag is true, which means Qt D-Bus will auto start a service, if it is not running already.

See also

setAutoStartService().

@staticmethod createError(QDBusError) → QDBusMessage: TODO

@staticmethod createError(str, str) → QDBusMessage: Constructs a new DBus message representing an error, with the given name and msg.

@staticmethod createError(ErrorType, str) → QDBusMessage: TODO

createErrorReply(QDBusError) → QDBusMessage: TODO

createErrorReply(str, str) → QDBusMessage: Constructs a new DBus message representing an error reply message, with the given name and msg.

createErrorReply(ErrorType, str) → QDBusMessage: TODO

@staticmethod createMethodCall(str, str, str, str) → QDBusMessage

Constructs a new DBus message representing a method call. A method call always informs its destination address (service, path, interface and method).

The DBus bus allows calling a method on a given remote object without specifying the destination interface, if the method name is unique. However, if two interfaces on the remote object export the same method name, the result is undefined (one of the two may be called or an error may be returned).

When using DBus in a peer-to-peer context (i.e., not on a bus), the service parameter is optional.

The QDBusInterface class provides a simpler abstraction to synchronous method calling.

This function returns a QDBusMessage object that can be sent with QDBusConnection::call().

createReply(arguments: Iterable[Any] = []) → QDBusMessage: TODO

createReply(Any) → QDBusMessage: TODO

@staticmethod createSignal(str, str, str) → QDBusMessage: TODO

@staticmethod createTargetedSignal(str, str, str, str) → QDBusMessage

Constructs a new DBus message with the given path, interface and name, representing a signal emission to a specific destination.

A DBus signal is emitted from one application and is received only by the application owning the destination service name.

The QDBusMessage object that is returned can be sent using the QDBusConnection::send() function.

errorMessage() → str: Returns the human-readable message associated with the error that was received.

errorName() → str: Returns the name of the error that was received.

interface() → str: Returns the interface of the method being called (in the case of a method call) or of the signal being received from.

isDelayedReply() → bool: Returns the delayed reply flag, as set by setDelayedReply(). By default, this flag is false, which means Qt D-Bus will generate automatic replies when necessary.

isInteractiveAuthorizationAllowed() → bool: Returns the interactive authorization allowed flag, as set by setInteractiveAuthorizationAllowed(). By default this flag is false and the other end is expected to make any authorization decisions non-interactively and promptly.

See also

setInteractiveAuthorizationAllowed().

isReplyRequired() → bool: Returns the flag that indicates if this message should see a reply or not. This is only meaningful for MethodCallMessage: any other kind of message cannot have replies and this function will always return false for them.

__lshift__(Any) → QDBusMessage: TODO

member() → str: Returns the name of the signal that was emitted or the name of the method that was called.

path() → str: Returns the path of the object that this message is being sent to (in the case of a method call) or being received from (for a signal).

service() → str: Returns the name of the service or the bus address of the remote method call.

setArguments(Iterable[Any]): Sets the arguments that are going to be sent over D-Bus to arguments. Those will be the arguments to a method call or the parameters in the signal.

See also

arguments().

setAutoStartService(bool)

Sets the auto start flag to enable. This flag only makes sense for method call messages, where it tells the D-Bus server to either auto start the service responsible for the service name, or not to auto start it.

By default this flag is true, i.e. a service is autostarted. This means:

When the service that this method call is sent to is already running, the method call is sent to it. If the service is not running yet, the D-Bus daemon is requested to autostart the service that is assigned to this service name. This is handled by .service files that are placed in a directory known to the D-Bus server. These files then each contain a service name and the path to a program that should be executed when this service name is requested.