gio.dbus_message

Module for [DBusMessage] class

Types 3

A type for representing D-Bus messages that can be sent or received on a [gio.dbus_connection.DBusConnection].

Methods
GType _gType() @property
DBusMessage self()Returns `this`, for use in `with` statements.
DBusMessageGidBuilder builder()Get builder for [gio.dbus_message.DBusMessage] Returns: New builder object
bool locked() @property
gio.dbus_message.DBusMessage newFromBlob(ubyte[] blob, gio.types.DBusCapabilityFlags capabilities)Creates a new #GDBusMessage from the data stored at blob. The byte order that the message was in can be retrieved using [gio.dbus_message.DBusMessage.getByteOrder].
gio.dbus_message.DBusMessage newMethodCall(string name, string path, string interface_, string method)Creates a new #GDBusMessage for a method call.
gio.dbus_message.DBusMessage newSignal(string path, string interface_, string signal)Creates a new #GDBusMessage for a signal emission.
ptrdiff_t bytesNeeded(ubyte[] blob)Utility function to calculate how many bytes are needed to completely deserialize the D-Bus message stored at blob.
gio.dbus_message.DBusMessage copy()Copies message. The copy is a deep copy and the returned #GDBusMessage is completely identical except that it is guaranteed to not be locked.
string getArg0()Convenience to get the first item in the body of message.
string getArg0Path()Convenience to get the first item in the body of message.
glib.variant.Variant getBody()Gets the body of a message. Returns: A #GVariant or null if the body is empty. Do not free, it is owned by message.
gio.types.DBusMessageByteOrder getByteOrder()Gets the byte order of message. Returns: The byte order.
string getDestination()Convenience getter for the [gio.types.DBusMessageHeaderField.Destination] header field. Returns: The value.
string getErrorName()Convenience getter for the [gio.types.DBusMessageHeaderField.ErrorName] header field. Returns: The value.
gio.types.DBusMessageFlags getFlags()Gets the flags for message. Returns: Flags that are set (typically values from the #GDBusMessageFlags enumeration bitwise ORed together).
glib.variant.Variant getHeader(gio.types.DBusMessageHeaderField headerField)Gets a header field on message.
ubyte[] getHeaderFields()Gets an array of all header fields on message that are set. Returns: An array of header fields terminated by [gio.types.DBusMessageHeaderField.Invalid]. Each element is a #guchar. Free with [glib....
string getInterface()Convenience getter for the [gio.types.DBusMessageHeaderField.Interface] header field. Returns: The value.
bool getLocked()Checks whether message is locked. To monitor changes to this value, conncet to the #GObject::notify signal to listen for changes on the #GDBusMessage:locked property. Returns: true if message is lo...
string getMember()Convenience getter for the [gio.types.DBusMessageHeaderField.Member] header field. Returns: The value.
gio.types.DBusMessageType getMessageType()Gets the type of message. Returns: A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
uint getNumUnixFds()Convenience getter for the [gio.types.DBusMessageHeaderField.NumUnixFds] header field. Returns: The value.
string getPath()Convenience getter for the [gio.types.DBusMessageHeaderField.Path] header field. Returns: The value.
uint getReplySerial()Convenience getter for the [gio.types.DBusMessageHeaderField.ReplySerial] header field. Returns: The value.
string getSender()Convenience getter for the [gio.types.DBusMessageHeaderField.Sender] header field. Returns: The value.
uint getSerial()Gets the serial for message. Returns: A #guint32.
string getSignature()Convenience getter for the [gio.types.DBusMessageHeaderField.Signature] header field.
gio.unix_fdlist.UnixFDList getUnixFdList()Gets the UNIX file descriptors associated with message, if any.
void lock()If message is locked, does nothing. Otherwise locks the message.
gio.dbus_message.DBusMessage newMethodErrorLiteral(string errorName, string errorMessage)Creates a new #GDBusMessage that is an error reply to methodcallmessage.
gio.dbus_message.DBusMessage newMethodReply()Creates a new #GDBusMessage that is a reply to methodcallmessage. Returns: #GDBusMessage. Free with [gobject.object.ObjectWrap.unref].
string print(uint indent)Produces a human-readable multi-line description of message.
void setBody(glib.variant.Variant body_)Sets the body message. As a side-effect the [gio.types.DBusMessageHeaderField.Signature] header field is set to the type string of body (or cleared if body is null).
void setByteOrder(gio.types.DBusMessageByteOrder byteOrder)Sets the byte order of message.
void setDestination(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Destination] header field.
void setErrorName(string value)Convenience setter for the [gio.types.DBusMessageHeaderField.ErrorName] header field.
void setFlags(gio.types.DBusMessageFlags flags)Sets the flags to set on message.
void setHeader(gio.types.DBusMessageHeaderField headerField, glib.variant.Variant value = null)Sets a header field on message.
void setInterface(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Interface] header field.
void setMember(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Member] header field.
void setMessageType(gio.types.DBusMessageType type)Sets message to be of type.
void setNumUnixFds(uint value)Convenience setter for the [gio.types.DBusMessageHeaderField.NumUnixFds] header field.
void setPath(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Path] header field.
void setReplySerial(uint value)Convenience setter for the [gio.types.DBusMessageHeaderField.ReplySerial] header field.
void setSender(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Sender] header field.
void setSerial(uint serial)Sets the serial for message.
void setSignature(string value = null)Convenience setter for the [gio.types.DBusMessageHeaderField.Signature] header field.
void setUnixFdList(gio.unix_fdlist.UnixFDList fdList = null)Sets the UNIX file descriptors associated with message. As a side-effect the [gio.types.DBusMessageHeaderField.NumUnixFds] header field is set to the number of fds in fdlist (or cleared if fdlist i...
ubyte[] toBlob(gio.types.DBusCapabilityFlags capabilities)Serializes message to a blob. The byte order returned by [gio.dbus_message.DBusMessage.getByteOrder] will be used.
bool toGerror()If message is not of type [gio.types.DBusMessageType.Error] does nothing and returns false.
Constructors
this(void * ptr, Flag!"Take" take)
this()Creates a new empty #GDBusMessage. Returns: A #GDBusMessage. Free with [gobject.object.ObjectWrap.unref].

Fluent builder for [gio.dbus_message.DBusMessage]