@gtkx/ffi 0.1.45 → 0.1.47

package/dist/generated/gio/dbus-message.d.ts

@@ -3,55 +3,326 @@ import { DBusCapabilityFlags, DBusMessageByteOrder, DBusMessageFlags, DBusMessag
 import { UnixFDList } from "./unix-fdlist.js";
 import * as GLib from "../glib/index.js";
 import * as GObject from "../gobject/index.js";
+/**
+ * A type for representing D-Bus messages that can be sent or received
+ * on a [class@Gio.DBusConnection].
+ */
 export declare class DBusMessage extends GObject.GObject {
+    /**
+     * Creates a new empty #GDBusMessage.
+     */
     constructor(...args: unknown[]);
+    /**
+     * Creates a new #GDBusMessage from the data stored at @blob. The byte
+     * order that the message was in can be retrieved using
+     * g_dbus_message_get_byte_order().
+     *
+     * If the `blob` cannot be parsed, contains invalid fields, or contains invalid
+     * headers, %G_IO_ERROR_INVALID_ARGUMENT will be returned.
+     * @param blob - A blob representing a binary D-Bus message.
+     * @param blobLen - The length of @blob.
+     * @param capabilities - A #GDBusCapabilityFlags describing what protocol features are supported.
+     */
     static messageNewFromBlob(blob: number[], blobLen: number, capabilities: DBusCapabilityFlags): DBusMessage;
+    /**
+     * Creates a new #GDBusMessage for a method call.
+     * @param name - A valid D-Bus name or %NULL.
+     * @param path - A valid object path.
+     * @param interface_ - A valid D-Bus interface name or %NULL.
+     * @param method - A valid method name.
+     */
     static messageNewMethodCall(path: string, method: string, name?: string | null, interface_?: string | null): DBusMessage;
+    /**
+     * Creates a new #GDBusMessage for a signal emission.
+     * @param path - A valid object path.
+     * @param interface_ - A valid D-Bus interface name.
+     * @param signal - A valid signal name.
+     */
     static messageNewSignal(path: string, interface_: string, signal: string): DBusMessage;
     protected createPtr(_args: unknown[]): unknown;
+    /**
+     * Utility function to calculate how many bytes are needed to
+     * completely deserialize the D-Bus message stored at @blob.
+     * @param blob - A blob representing a binary D-Bus message.
+     * @param blobLen - The length of `blob` (must be at least 16).
+     */
     static bytesNeeded(blob: number[], blobLen: number): number;
+    /**
+     * Copies @message. The copy is a deep copy and the returned
+     * #GDBusMessage is completely identical except that it is guaranteed
+     * to not be locked.
+     *
+     * This operation can fail if e.g. `message` contains file descriptors
+     * and the per-process or system-wide open files limit is reached.
+     */
     copy(): DBusMessage;
+    /**
+     * Convenience to get the first item in the body of @message.
+     *
+     * See [method@Gio.DBusMessage.get_arg0_path] for returning object-path-typed
+     * arg0 values.
+     */
     getArg0(): string | null;
+    /**
+     * Convenience to get the first item in the body of @message.
+     *
+     * See [method@Gio.DBusMessage.get_arg0] for returning string-typed arg0 values.
+     */
     getArg0Path(): string | null;
+    /**
+     * Gets the body of a message.
+     */
     getBody(): GLib.Variant | null;
+    /**
+     * Gets the byte order of @message.
+     */
     getByteOrder(): DBusMessageByteOrder;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
+     */
     getDestination(): string | null;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
+     */
     getErrorName(): string | null;
+    /**
+     * Gets the flags for @message.
+     */
     getFlags(): DBusMessageFlags;
+    /**
+     * Gets a header field on @message.
+     *
+     * The caller is responsible for checking the type of the returned #GVariant
+     * matches what is expected.
+     * @param headerField - A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
+     */
     getHeader(headerField: DBusMessageHeaderField): GLib.Variant | null;
+    /**
+     * Gets an array of all header fields on `message` that are set.
+     */
     getHeaderFields(): number[];
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
+     */
     getInterface(): string | null;
+    /**
+     * Checks whether `message` is locked. To monitor changes to this
+     * value, connect to the #GObject::notify signal to listen for changes
+     * on the #GDBusMessage:locked property.
+     */
     getLocked(): boolean;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
+     */
     getMember(): string | null;
+    /**
+     * Gets the type of @message.
+     */
     getMessageType(): DBusMessageType;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
+     */
     getNumUnixFds(): number;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
+     */
     getPath(): string | null;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
+     */
     getReplySerial(): number;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
+     */
     getSender(): string | null;
+    /**
+     * Gets the serial for @message.
+     */
     getSerial(): number;
+    /**
+     * Convenience getter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
+     *
+     * This will always be non-%NULL, but may be an empty string.
+     */
     getSignature(): string;
+    /**
+     * Gets the UNIX file descriptors associated with @message, if any.
+     *
+     * This method is only available on UNIX.
+     *
+     * The file descriptors normally correspond to %G_VARIANT_TYPE_HANDLE
+     * values in the body of the message. For example,
+     * if g_variant_get_handle() returns 5, that is intended to be a reference
+     * to the file descriptor that can be accessed by
+     * `g_unix_fd_list_get (list, 5, ...)`.
+     */
     getUnixFdList(): UnixFDList | null;
+    /**
+     * If `message` is locked, does nothing. Otherwise locks the message.
+     */
     lock(): void;
+    /**
+     * Creates a new #GDBusMessage that is an error reply to @method_call_message.
+     * @param errorName - A valid D-Bus error name.
+     * @param errorMessage - The D-Bus error message.
+     */
     newMethodErrorLiteral(errorName: string, errorMessage: string): DBusMessage;
+    /**
+     * Creates a new #GDBusMessage that is a reply to @method_call_message.
+     */
     newMethodReply(): DBusMessage;
+    /**
+     * Produces a human-readable multi-line description of @message.
+     *
+     * The contents of the description has no ABI guarantees, the contents
+     * and formatting is subject to change at any time. Typical output
+     * looks something like this:
+     * ```
+     * Flags:   none
+     * Version: 0
+     * Serial:  4
+     * Headers:
+     * path -> objectpath '/org/gtk/GDBus/TestObject'
+     * interface -> 'org.gtk.GDBus.TestInterface'
+     * member -> 'GimmeStdout'
+     * destination -> ':1.146'
+     * Body: ()
+     * UNIX File Descriptors:
+     * (none)
+     * ```
+     * or
+     * ```
+     * Flags:   no-reply-expected
+     * Version: 0
+     * Serial:  477
+     * Headers:
+     * reply-serial -> uint32 4
+     * destination -> ':1.159'
+     * sender -> ':1.146'
+     * num-unix-fds -> uint32 1
+     * Body: ()
+     * UNIX File Descriptors:
+     * fd 12: dev=0:10,mode=020620,ino=5,uid=500,gid=5,rdev=136:2,size=0,atime=1273085037,mtime=1273085851,ctime=1272982635
+     * ```
+     * @param indent - Indentation level.
+     */
     print(indent: number): string;
+    /**
+     * Sets the body @message. As a side-effect the
+     * %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field is set to the
+     * type string of `body` (or cleared if `body` is %NULL).
+     *
+     * If `body` is floating, `message` assumes ownership of @body.
+     * @param body - Either %NULL or a #GVariant that is a tuple.
+     */
     setBody(body: GLib.Variant): void;
+    /**
+     * Sets the byte order of @message.
+     * @param byteOrder - The byte order.
+     */
     setByteOrder(byteOrder: DBusMessageByteOrder): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_DESTINATION header field.
+     * @param value - The value to set.
+     */
     setDestination(value?: string | null): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field.
+     * @param value - The value to set.
+     */
     setErrorName(value: string): void;
+    /**
+     * Sets the flags to set on @message.
+     * @param flags - Flags for `message` that are set (typically values from the #GDBusMessageFlags
+     */
     setFlags(flags: DBusMessageFlags): void;
+    /**
+     * Sets a header field on @message.
+     *
+     * If `value` is floating, `message` assumes ownership of @value.
+     * @param headerField - A 8-bit unsigned integer (typically a value from the #GDBusMessageHeaderField enumeration)
+     * @param value - A #GVariant to set the header field or %NULL to clear the header field.
+     */
     setHeader(headerField: DBusMessageHeaderField, value?: GLib.Variant | null): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_INTERFACE header field.
+     * @param value - The value to set.
+     */
     setInterface(value?: string | null): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_MEMBER header field.
+     * @param value - The value to set.
+     */
     setMember(value?: string | null): void;
+    /**
+     * Sets `message` to be of @type.
+     * @param type - A 8-bit unsigned integer (typically a value from the #GDBusMessageType enumeration).
+     */
     setMessageType(type: DBusMessageType): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header field.
+     * @param value - The value to set.
+     */
     setNumUnixFds(value: number): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_PATH header field.
+     * @param value - The value to set.
+     */
     setPath(value?: string | null): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_REPLY_SERIAL header field.
+     * @param value - The value to set.
+     */
     setReplySerial(value: number): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SENDER header field.
+     * @param value - The value to set.
+     */
     setSender(value?: string | null): void;
+    /**
+     * Sets the serial for @message.
+     *
+     * The D-Bus specification
+     * does not allow the `serial` to be zero.
+     * @param serial - A #guint32, which must not be zero.
+     */
     setSerial(serial: number): void;
+    /**
+     * Convenience setter for the %G_DBUS_MESSAGE_HEADER_FIELD_SIGNATURE header field.
+     * @param value - The value to set.
+     */
     setSignature(value?: string | null): void;
+    /**
+     * Sets the UNIX file descriptors associated with @message. As a
+     * side-effect the %G_DBUS_MESSAGE_HEADER_FIELD_NUM_UNIX_FDS header
+     * field is set to the number of fds in `fd_list` (or cleared if
+     * `fd_list` is %NULL).
+     *
+     * This method is only available on UNIX.
+     *
+     * When designing D-Bus APIs that are intended to be interoperable,
+     * please note that non-GDBus implementations of D-Bus can usually only
+     * access file descriptors if they are referenced by a value of type
+     * %G_VARIANT_TYPE_HANDLE in the body of the message.
+     * @param fdList - A #GUnixFDList or %NULL.
+     */
     setUnixFdList(fdList?: UnixFDList | null): void;
+    /**
+     * Serializes `message` to a blob. The byte order returned by
+     * g_dbus_message_get_byte_order() will be used.
+     * @param outSize - Return location for size of generated blob.
+     * @param capabilities - A #GDBusCapabilityFlags describing what protocol features are supported.
+     */
     toBlob(outSize: Ref<number>, capabilities: DBusCapabilityFlags): number[];
+    /**
+     * If `message` is not of type %G_DBUS_MESSAGE_TYPE_ERROR does
+     * nothing and returns %FALSE.
+     *
+     * Otherwise this method encodes the error in `message` as a #GError
+     * using g_dbus_error_set_dbus_error() using the information in the
+     * %G_DBUS_MESSAGE_HEADER_FIELD_ERROR_NAME header field of `message` as
+     * well as the first string item in @message's body.
+     */
     toGerror(): boolean;
     connect(signal: "notify", handler: (self: DBusMessage, pspec: GObject.ParamSpec) => void, after?: boolean): number;
     connect(signal: string, handler: (...args: any[]) => any, after?: boolean): number;