RAGS - v1.10.0
    Preparing search index...

    Interface StatusNotifierItemProxy

    DBus proxy for StatusNotifierItem (system tray items).

    interface StatusNotifierItemProxy {
        new StatusNotifierItemProxy(...args: unknown[]): StatusNotifierItemProxy;
        new StatusNotifierItemProxy(...args: unknown[]): StatusNotifierItemProxy;
        ActivateAsync: (x: number, y: number) => Promise<void>;
        AttentionIconName: string;
        AttentionIconPixmap: [number, number, Uint8Array<ArrayBufferLike>][];
        Category: string;
        ContextMenuAsync: (x: number, y: number) => Promise<void>;
        IconName: string;
        IconPixmap: [number, number, Uint8Array<ArrayBufferLike>][];
        IconThemePath: string;
        Id: string;
        ItemIsMenu: boolean;
        Menu: string;
        ScrollAsync: (delta: number, orientation: string) => Promise<void>;
        SecondaryActivateAsync: (x: number, y: number) => Promise<void>;
        Status: string;
        Title: string;
        ToolTip: [
            string,
            [number, number, Uint8Array<ArrayBufferLike>],
            string,
            string,
        ];
        WindowId: number;
        set g_bus_type(val: BusType): void;
        get g_connection(): DBusConnection;
        get g_default_timeout(): number;
        set g_default_timeout(val: number): void;
        get g_flags(): DBusProxyFlags;
        get g_interface_info(): DBusInterfaceInfo;
        set g_interface_info(val: DBusInterfaceInfo): void;
        get g_interface_name(): string;
        get g_name(): string;
        get g_name_owner(): string;
        get g_object_path(): string;
        set gBusType(val: BusType): void;
        get gConnection(): DBusConnection;
        get gDefaultTimeout(): number;
        set gDefaultTimeout(val: number): void;
        get gFlags(): DBusProxyFlags;
        get gInterfaceInfo(): DBusInterfaceInfo;
        set gInterfaceInfo(val: DBusInterfaceInfo): void;
        get gInterfaceName(): string;
        get gName(): string;
        get gNameOwner(): string;
        get gObjectPath(): string;
        _init(...args: any[]): void;
        bind_property(
            source_property: string,
            target: Object,
            target_property: string,
            flags: BindingFlags | null,
        ): Binding;
        bind_property_full(
            source_property: string,
            target: Object,
            target_property: string,
            flags: BindingFlags | null,
            transform_to?: BindingTransformFunc | null,
            transform_from?: BindingTransformFunc | null,
            notify?: DestroyNotify | null,
        ): Binding;
        bind_property_full(...args: never[]): any;
        block_signal_handler(id: number): void;
        call(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            cancellable?: Cancellable | null,
        ): Promise<Variant<any>>;
        call(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            cancellable: Cancellable | null,
            callback: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void;
        call(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            cancellable?: Cancellable | null,
            callback?: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void | Promise<Variant<any>>;
        call_finish(res: AsyncResult): Variant;
        call_sync(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            cancellable?: Cancellable | null,
        ): Variant;
        call_with_unix_fd_list(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            fd_list?: UnixFDList | null,
            cancellable?: Cancellable | null,
        ): Promise<[Variant<any>, UnixFDList | null]>;
        call_with_unix_fd_list(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            fd_list: UnixFDList | null,
            cancellable: Cancellable | null,
            callback: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void;
        call_with_unix_fd_list(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            fd_list?: UnixFDList | null,
            cancellable?: Cancellable | null,
            callback?: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void | Promise<[Variant<any>, UnixFDList | null]>;
        call_with_unix_fd_list_finish(
            res: AsyncResult,
        ): [Variant<any>, UnixFDList | null];
        call_with_unix_fd_list_sync(
            method_name: string,
            parameters: Variant<any> | null,
            flags: DBusCallFlags | null,
            timeout_msec: number,
            fd_list?: UnixFDList | null,
            cancellable?: Cancellable | null,
        ): [Variant<any>, UnixFDList | null];
        connect<K extends keyof SignalSignatures>(
            signal: K,
            callback: SignalCallback<StatusNotifierItemProxy, SignalSignatures[K]>,
        ): number;
        connect(signal: string, callback: (...args: any[]) => any): number;
        connect_after<K extends keyof SignalSignatures>(
            signal: K,
            callback: SignalCallback<StatusNotifierItemProxy, SignalSignatures[K]>,
        ): number;
        connect_after(signal: string, callback: (...args: any[]) => any): number;
        connectSignal(proxy: this, name: string, args: any[]): any;
        disconnect(id: number): void;
        disconnectSignal(...args: any[]): any;
        emit<K extends keyof SignalSignatures>(
            signal: K,
            ...args: GjsParameters<SignalSignatures[K]> extends [any, ...Q[]]
                ? Q
                : never,
        ): void;
        emit(signal: string, ...args: any[]): void;
        force_floating(): void;
        freeze_notify(): void;
        get_cached_property(property_name: string): Variant<any> | null;
        get_cached_property_names(): string[] | null;
        get_connection(): DBusConnection;
        get_data(key: string): any;
        get_default_timeout(): number;
        get_flags(): DBusProxyFlags;
        get_info(): DBusInterfaceInfo;
        get_interface_info(): DBusInterfaceInfo | null;
        get_interface_name(): string;
        get_name(): string | null;
        get_name_owner(): string | null;
        get_object(): DBusObject | null;
        get_object_path(): string;
        get_property(property_name: string, value: any): any;
        get_qdata(quark: number): any;
        getv(names: string[], values: any[]): void;
        init(cancellable?: Cancellable | null): boolean;
        init_async(
            io_priority: number,
            cancellable?: Cancellable | null,
        ): Promise<boolean>;
        init_async(
            io_priority: number,
            cancellable: Cancellable | null,
            callback: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void;
        init_async(
            io_priority: number,
            cancellable?: Cancellable | null,
            callback?: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void | Promise<boolean>;
        init_finish(res: AsyncResult): boolean;
        is_floating(): boolean;
        new_finish(res: AsyncResult): DBusProxy;
        notify(property_name: string): void;
        notify_by_pspec(pspec: ParamSpec): void;
        ref(): Object;
        ref_sink(): Object;
        run_dispose(): void;
        set(properties: { [key: string]: any }): void;
        set_cached_property(
            property_name: string,
            value?: Variant<any> | null,
        ): void;
        set_data(key: string, data?: any): void;
        set_default_timeout(timeout_msec: number): void;
        set_interface_info(info?: DBusInterfaceInfo | null): void;
        set_object(object?: DBusObject | null): void;
        set_property(property_name: string, value: any): void;
        steal_data(key: string): any;
        steal_qdata(quark: number): any;
        stop_emission_by_name(detailedName: string): void;
        thaw_notify(): void;
        unblock_signal_handler(id: number): void;
        unref(): void;
        vfunc_constructed(): void;
        vfunc_dispatch_properties_changed(
            n_pspecs: number,
            pspecs: ParamSpec,
        ): void;
        vfunc_dispose(): void;
        vfunc_dup_object(): DBusObject | null;
        vfunc_finalize(): void;
        vfunc_g_properties_changed(
            changed_properties: Variant,
            invalidated_properties: string,
        ): void;
        vfunc_g_signal(
            sender_name: string,
            signal_name: string,
            parameters: Variant,
        ): void;
        vfunc_get_info(): DBusInterfaceInfo;
        vfunc_get_property(property_id: number, value: any, pspec: ParamSpec): void;
        vfunc_init(cancellable?: Cancellable | null): boolean;
        vfunc_init_async(
            io_priority: number,
            cancellable?: Cancellable | null,
            callback?: AsyncReadyCallback<StatusNotifierItemProxy> | null,
        ): void;
        vfunc_init_finish(res: AsyncResult): boolean;
        vfunc_notify(pspec: ParamSpec): void;
        vfunc_set_object(object?: DBusObject | null): void;
        vfunc_set_property(property_id: number, value: any, pspec: ParamSpec): void;
        watch_closure(closure: Closure): void;
        [key: string]: any;
    }

    Hierarchy

    • DBusProxy
      • StatusNotifierItemProxy

    Indexable

    • [key: string]: any
    Index

    Accessors

    Constructors

    Methods

    Properties

    Accessors

    • set g_bus_type(val: BusType): void

      If this property is not %G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property.

      Parameters

      • val: BusType

      Returns void

    • get g_connection(): DBusConnection

      The #GDBusConnection the proxy is for.

      Returns DBusConnection

    • get g_default_timeout(): number

      The timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

      This allows applications to set a proxy-wide timeout for all remote method invocations on the proxy. If this property is -1, the default timeout (typically 25 seconds) is used. If set to %G_MAXINT, then no timeout is used.

      Returns number

    • set g_default_timeout(val: number): void

      Parameters

      • val: number

      Returns void

    • get g_flags(): DBusProxyFlags

      Flags from the #GDBusProxyFlags enumeration.

      Returns DBusProxyFlags

    • get g_interface_info(): DBusInterfaceInfo

      Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the "expected interface".

      The checks performed are:

      • When completing a method call, if the type signature of the reply message isn't what's expected, the reply is discarded and the #GError is set to %G_IO_ERROR_INVALID_ARGUMENT.

      • Received signals that have a type signature mismatch are dropped and a warning is logged via g_warning().

      • Properties received via the initial GetAll() call or via the ::PropertiesChanged signal (on the org.freedesktop.DBus.Properties interface) or set using g_dbus_proxy_set_cached_property() with a type signature mismatch are ignored and a warning is logged via g_warning().

      Note that these checks are never done on methods, signals and properties that are not referenced in the given #GDBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.

      Returns DBusInterfaceInfo

    • set g_interface_info(val: DBusInterfaceInfo): void

      Parameters

      • val: DBusInterfaceInfo

      Returns void

    • get g_interface_name(): string

      The D-Bus interface name the proxy is for.

      Returns string

    • get g_name(): string

      The well-known or unique name that the proxy is for.

      Returns string

    • get g_name_owner(): string

      The unique name that owns #GDBusProxy:g-name or %NULL if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property.

      Returns string

    • get g_object_path(): string

      The object path the proxy is for.

      Returns string

    • set gBusType(val: BusType): void

      If this property is not %G_BUS_TYPE_NONE, then #GDBusProxy:g-connection must be %NULL and will be set to the #GDBusConnection obtained by calling g_bus_get() with the value of this property.

      Parameters

      • val: BusType

      Returns void

    • get gConnection(): DBusConnection

      The #GDBusConnection the proxy is for.

      Returns DBusConnection

    • get gDefaultTimeout(): number

      The timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

      This allows applications to set a proxy-wide timeout for all remote method invocations on the proxy. If this property is -1, the default timeout (typically 25 seconds) is used. If set to %G_MAXINT, then no timeout is used.

      Returns number

    • set gDefaultTimeout(val: number): void

      Parameters

      • val: number

      Returns void

    • get gFlags(): DBusProxyFlags

      Flags from the #GDBusProxyFlags enumeration.

      Returns DBusProxyFlags

    • get gInterfaceInfo(): DBusInterfaceInfo

      Ensure that interactions with this proxy conform to the given interface. This is mainly to ensure that malformed data received from the other peer is ignored. The given #GDBusInterfaceInfo is said to be the "expected interface".

      The checks performed are:

      • When completing a method call, if the type signature of the reply message isn't what's expected, the reply is discarded and the #GError is set to %G_IO_ERROR_INVALID_ARGUMENT.

      • Received signals that have a type signature mismatch are dropped and a warning is logged via g_warning().

      • Properties received via the initial GetAll() call or via the ::PropertiesChanged signal (on the org.freedesktop.DBus.Properties interface) or set using g_dbus_proxy_set_cached_property() with a type signature mismatch are ignored and a warning is logged via g_warning().

      Note that these checks are never done on methods, signals and properties that are not referenced in the given #GDBusInterfaceInfo, since extending a D-Bus interface on the service-side is not considered an ABI break.

      Returns DBusInterfaceInfo

    • set gInterfaceInfo(val: DBusInterfaceInfo): void

      Parameters

      • val: DBusInterfaceInfo

      Returns void

    • get gInterfaceName(): string

      The D-Bus interface name the proxy is for.

      Returns string

    • get gName(): string

      The well-known or unique name that the proxy is for.

      Returns string

    • get gNameOwner(): string

      The unique name that owns #GDBusProxy:g-name or %NULL if no-one currently owns that name. You may connect to #GObject::notify signal to track changes to this property.

      Returns string

    • get gObjectPath(): string

      The object path the proxy is for.

      Returns string

    Constructors

    Methods

    • Parameters

      • ...args: any[]

      Returns void

    • Creates a binding between source_property on source and target_property on target.

      Whenever the source_property is changed the target_property is updated using the same value. For instance:

        g_object_bind_property (action, "active", widget, "sensitive", 0);
      

      Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

      If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

      The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

      Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

      A #GObject can have multiple bindings.

      Parameters

      • source_property: string

        the property on

      • target: Object

        the target #GObject

      • target_property: string

        the property on

      • flags: BindingFlags | null

        flags to pass to #GBinding

      Returns Binding

      the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.

      to bind

      to bind

    • Complete version of g_object_bind_property().

      Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

      If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well. The transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

      The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the #GBinding instance; if you want to hold on to the #GBinding instance, you will need to hold a reference to it.

      To remove the binding, call g_binding_unbind().

      A #GObject can have multiple bindings.

      The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

      Parameters

      • source_property: string

        the property on

      • target: Object

        the target #GObject

      • target_property: string

        the property on

      • flags: BindingFlags | null

        flags to pass to #GBinding

      • Optionaltransform_to: BindingTransformFunc | null

        the transformation function from the

      • Optionaltransform_from: BindingTransformFunc | null

        the transformation function from the

      • Optionalnotify: DestroyNotify | null

        a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required

      Returns Binding

      the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.

      to bind

      to bind

      to the @target, or %NULL to use the default

      to the @source, or %NULL to use the default

    • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

      This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

      Parameters

      • ...args: never[]

      Returns any

      the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.

      to bind

      to bind

      to the @target, or %NULL to use the default

      to the @source, or %NULL to use the default

    • Blocks a handler of an instance so it will not be called during any signal emissions

      Parameters

      • id: number

        Handler ID of the handler to be blocked

      Returns void

    • Asynchronously invokes the method_name method on proxy.

      If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

      If the #GDBusConnection associated with proxy is closed then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

      If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

       g_dbus_proxy_call (proxy,
      "TwoStrings",
      g_variant_new ("(ss)",
      "Thing One",
      "Thing Two"),
      G_DBUS_CALL_FLAGS_NONE,
      -1,
      NULL,
      (GAsyncReadyCallback) two_strings_done,
      &data);

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

      This is an asynchronous method. When the operation is finished, callback will be invoked in the thread-default main context (see [methodGLib.MainContext.push_thread_default]) of the thread you are calling this method from. You can then call g_dbus_proxy_call_finish() to get the result of the operation. See g_dbus_proxy_call_sync() for the synchronous version of this method.

      If callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      Returns Promise<Variant<any>>

    • Asynchronously invokes the method_name method on proxy.

      If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

      If the #GDBusConnection associated with proxy is closed then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

      If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

       g_dbus_proxy_call (proxy,
      "TwoStrings",
      g_variant_new ("(ss)",
      "Thing One",
      "Thing Two"),
      G_DBUS_CALL_FLAGS_NONE,
      -1,
      NULL,
      (GAsyncReadyCallback) two_strings_done,
      &data);

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

      This is an asynchronous method. When the operation is finished, callback will be invoked in the thread-default main context (see [methodGLib.MainContext.push_thread_default]) of the thread you are calling this method from. You can then call g_dbus_proxy_call_finish() to get the result of the operation. See g_dbus_proxy_call_sync() for the synchronous version of this method.

      If callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • cancellable: Cancellable | null

        A #GCancellable or %NULL.

      • callback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

      Returns void

    • Asynchronously invokes the method_name method on proxy.

      If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

      If the #GDBusConnection associated with proxy is closed then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

      If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

       g_dbus_proxy_call (proxy,
      "TwoStrings",
      g_variant_new ("(ss)",
      "Thing One",
      "Thing Two"),
      G_DBUS_CALL_FLAGS_NONE,
      -1,
      NULL,
      (GAsyncReadyCallback) two_strings_done,
      &data);

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

      This is an asynchronous method. When the operation is finished, callback will be invoked in the thread-default main context (see [methodGLib.MainContext.push_thread_default]) of the thread you are calling this method from. You can then call g_dbus_proxy_call_finish() to get the result of the operation. See g_dbus_proxy_call_sync() for the synchronous version of this method.

      If callback is %NULL then the D-Bus method call message will be sent with the %G_DBUS_MESSAGE_FLAGS_NO_REPLY_EXPECTED flag set.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      • Optionalcallback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

      Returns void | Promise<Variant<any>>

    • Finishes an operation started with g_dbus_proxy_call().

      Parameters

      • res: AsyncResult

        A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call().

      Returns Variant

      %NULL if

      is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref().

    • Synchronously invokes the method_name method on proxy.

      If method_name contains any dots, then name is split into interface and method name parts. This allows using proxy for invoking methods on other interfaces.

      If the #GDBusConnection associated with proxy is disconnected then the operation will fail with %G_IO_ERROR_CLOSED. If cancellable is canceled, the operation will fail with %G_IO_ERROR_CANCELLED. If parameters contains a value not compatible with the D-Bus protocol, the operation fails with %G_IO_ERROR_INVALID_ARGUMENT.

      If the parameters #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.:

       g_dbus_proxy_call_sync (proxy,
      "TwoStrings",
      g_variant_new ("(ss)",
      "Thing One",
      "Thing Two"),
      G_DBUS_CALL_FLAGS_NONE,
      -1,
      NULL,
      &error);

      The calling thread is blocked until a reply is received. See g_dbus_proxy_call() for the asynchronous version of this method.

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and method_name is referenced by it, then the return value is checked against the return type.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      Returns Variant

      %NULL if

      is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref().

    • Like g_dbus_proxy_call() but also takes a #GUnixFDList object.

      This method is only available on UNIX.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalfd_list: UnixFDList | null

        A #GUnixFDList or %NULL.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      Returns Promise<[Variant<any>, UnixFDList | null]>

    • Like g_dbus_proxy_call() but also takes a #GUnixFDList object.

      This method is only available on UNIX.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • fd_list: UnixFDList | null

        A #GUnixFDList or %NULL.

      • cancellable: Cancellable | null

        A #GCancellable or %NULL.

      • callback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

      Returns void

    • Like g_dbus_proxy_call() but also takes a #GUnixFDList object.

      This method is only available on UNIX.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalfd_list: UnixFDList | null

        A #GUnixFDList or %NULL.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      • Optionalcallback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        A #GAsyncReadyCallback to call when the request is satisfied or %NULL if you don't care about the result of the method invocation.

      Returns void | Promise<[Variant<any>, UnixFDList | null]>

    • Finishes an operation started with g_dbus_proxy_call_with_unix_fd_list().

      Parameters

      • res: AsyncResult

        A #GAsyncResult obtained from the #GAsyncReadyCallback passed to g_dbus_proxy_call_with_unix_fd_list().

      Returns [Variant<any>, UnixFDList | null]

      %NULL if

      is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref().

    • Like g_dbus_proxy_call_sync() but also takes and returns #GUnixFDList objects.

      This method is only available on UNIX.

      Parameters

      • method_name: string

        Name of method to invoke.

      • parameters: Variant<any> | null

        A #GVariant tuple with parameters for the signal or %NULL if not passing parameters.

      • flags: DBusCallFlags | null

        Flags from the #GDBusCallFlags enumeration.

      • timeout_msec: number

        The timeout in milliseconds (with %G_MAXINT meaning "infinite") or -1 to use the proxy default timeout.

      • Optionalfd_list: UnixFDList | null

        A #GUnixFDList or %NULL.

      • Optionalcancellable: Cancellable | null

        A #GCancellable or %NULL.

      Returns [Variant<any>, UnixFDList | null]

      %NULL if

      is set. Otherwise a #GVariant tuple with return values. Free with g_variant_unref().

    • Type Parameters

      • K extends keyof SignalSignatures

      Parameters

      Returns number

    • Parameters

      • signal: string
      • callback: (...args: any[]) => any

      Returns number

    • Type Parameters

      • K extends keyof SignalSignatures

      Parameters

      Returns number

    • Parameters

      • signal: string
      • callback: (...args: any[]) => any

      Returns number

    • Parameters

      • proxy: this
      • name: string
      • args: any[]

      Returns any

    • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

      Parameters

      • id: number

        Handler ID of the handler to be disconnected

      Returns void

    • Parameters

      • ...args: any[]

      Returns any

    • Type Parameters

      • K extends keyof SignalSignatures

      Parameters

      • signal: K
      • ...args: GjsParameters<SignalSignatures[K]> extends [any, ...Q[]] ? Q : never

      Returns void

    • Parameters

      • signal: string
      • ...args: any[]

      Returns void

    • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

      Returns void

    • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

      This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

      Returns void

    • Looks up the value for a property from the cache. This call does no blocking IO.

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and property_name is referenced by it, then value is checked against the type of the property.

      Parameters

      • property_name: string

        Property name.

      Returns Variant<any> | null

      A reference to the #GVariant instance that holds the value for @property_name or %NULL if the value is not in the cache. The returned reference must be freed with g_variant_unref().

    • Gets the names of all cached properties on proxy.

      Returns string[] | null

      A %NULL-terminated array of strings or %NULL if

      has no cached properties. Free the returned array with g_strfreev().

    • Gets the connection proxy is for.

      Returns DBusConnection

      A #GDBusConnection owned by @proxy. Do not free.

    • Gets a named field from the objects table of associations (see g_object_set_data()).

      Parameters

      • key: string

        name of the key for that association

      Returns any

      the data if found, or %NULL if no such data exists.

    • Gets the timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

      See the #GDBusProxy:g-default-timeout property for more details.

      Returns number

      Timeout to use for @proxy.

    • Gets the flags that proxy was constructed with.

      Returns DBusProxyFlags

      Flags from the #GDBusProxyFlags enumeration.

    • Gets D-Bus introspection information for the D-Bus interface implemented by interface_.

      Returns DBusInterfaceInfo

      A #GDBusInterfaceInfo. Do not free.

    • Returns the #GDBusInterfaceInfo, if any, specifying the interface that proxy conforms to. See the #GDBusProxy:g-interface-info property for more details.

      Returns DBusInterfaceInfo | null

      A #GDBusInterfaceInfo or %NULL. Do not unref the returned object, it is owned by @proxy.

    • Gets the D-Bus interface name proxy is for.

      Returns string

      A string owned by @proxy. Do not free.

    • Gets the name that proxy was constructed for.

      When connected to a message bus, this will usually be non-%NULL. However, it may be %NULL for a proxy that communicates using a peer-to-peer pattern.

      Returns string | null

      A string owned by @proxy. Do not free.

    • The unique name that owns the name that proxy is for or %NULL if no-one currently owns that name. You may connect to the #GObject::notify signal to track changes to the #GDBusProxy:g-name-owner property.

      Returns string | null

      The name owner or %NULL if no name owner exists. Free with g_free().

    • Gets the #GDBusObject that interface_ belongs to, if any.

      Returns DBusObject | null

      A #GDBusObject or %NULL. The returned reference should be freed with g_object_unref().

    • Gets the object path proxy is for.

      Returns string

      A string owned by @proxy. Do not free.

    • Gets a property of an object.

      The value can be:

      • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
      • a GObject.Value initialized with the expected type of the property
      • a GObject.Value initialized with a type to which the expected type of the property can be transformed

      In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling GObject.Value.unset.

      Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

      Parameters

      • property_name: string

        The name of the property to get

      • value: any

        Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

      Returns any

    • This function gets back user data pointers stored via g_object_set_qdata().

      Parameters

      • quark: number

        A #GQuark, naming the user data pointer

      Returns any

      The user data pointer set, or %NULL

    • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

      Parameters

      • names: string[]

        the names of each property to get

      • values: any[]

        the values of each property to get

      Returns void

    • Initializes the object implementing the interface.

      This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

      The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [description][ifaceGio.Initable#description] for more details.

      Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

      If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

      One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

      Parameters

      • Optionalcancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      Returns boolean

      %TRUE if successful. If an error has occurred, this function will return %FALSE and set

      appropriately if present.

    • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

      This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

      When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

      Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

      For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

      Parameters

      • io_priority: number

        the I/O priority of the operation

      • Optionalcancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      Returns Promise<boolean>

    • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

      This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

      When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

      Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

      For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

      Parameters

      • io_priority: number

        the I/O priority of the operation

      • cancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      • callback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        a #GAsyncReadyCallback to call when the request is satisfied

      Returns void

    • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

      This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

      When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

      Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

      For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

      Parameters

      • io_priority: number

        the I/O priority of the operation

      • Optionalcancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      • Optionalcallback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        a #GAsyncReadyCallback to call when the request is satisfied

      Returns void | Promise<boolean>

    • Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

      Parameters

      • res: AsyncResult

        a #GAsyncResult.

      Returns boolean

      %TRUE if successful. If an error has occurred, this function will return %FALSE and set

      appropriately if present.

    • Checks whether object has a [floating][floating-ref] reference.

      Returns boolean

      %TRUE if

      has a floating reference

    • Finishes the async construction for the various g_async_initable_new calls, returning the created object or %NULL on error.

      Parameters

      • res: AsyncResult

        the #GAsyncResult from the callback

      Returns DBusProxy

      a newly created #GObject, or %NULL on error. Free with g_object_unref().

    • Emits a "notify" signal for the property property_name on object.

      When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

      Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

      Parameters

      • property_name: string

        the name of a property installed on the class of @object.

      Returns void

    • Emits a "notify" signal for the property specified by pspec on object.

      This function omits the property name lookup, hence it is faster than g_object_notify().

      One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

        typedef enum
      {
      PROP_FOO = 1,
      PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
      properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
      0, 100,
      50,
      G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
      g_object_class_install_property (gobject_class,
      PROP_FOO,
      properties[PROP_FOO]);
      }

      and then notify a change on the "foo" property with:

        g_object_notify_by_pspec (self, properties[PROP_FOO]);
      

      Parameters

      • pspec: ParamSpec

        the #GParamSpec of a property installed on the class of @object.

      Returns void

    • Increases the reference count of object.

      Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

      Returns Object

      the same

    • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

      In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

      Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

      Returns Object

    • Releases all references to other objects. This can be used to break reference cycles.

      This function should only be called from object system implementations.

      Returns void

    • Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

      Parameters

      • properties: { [key: string]: any }

        Object containing the properties to set

      Returns void

    • If value is not %NULL, sets the cached value for the property with name property_name to the value in value.

      If value is %NULL, then the cached value is removed from the property cache.

      If proxy has an expected interface (see #GDBusProxy:g-interface-info) and property_name is referenced by it, then value is checked against the type of the property.

      If the value #GVariant is floating, it is consumed. This allows convenient 'inline' use of g_variant_new(), e.g.

       g_dbus_proxy_set_cached_property (proxy,
      "SomeProperty",
      g_variant_new ("(si)",
      "A String",
      42));

      Normally you will not need to use this method since proxy is tracking changes using the org.freedesktop.DBus.Properties.PropertiesChanged D-Bus signal. However, for performance reasons an object may decide to not use this signal for some properties and instead use a proprietary out-of-band mechanism to transmit changes.

      As a concrete example, consider an object with a property ChatroomParticipants which is an array of strings. Instead of transmitting the same (long) array every time the property changes, it is more efficient to only transmit the delta using e.g. signals ChatroomParticipantJoined(String name) and ChatroomParticipantParted(String name).

      Parameters

      • property_name: string

        Property name.

      • Optionalvalue: Variant<any> | null

        Value for the property or %NULL to remove it from the cache.

      Returns void

    • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

      If the object already had an association with that name, the old association will be destroyed.

      Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

      Parameters

      • key: string

        name of the key

      • Optionaldata: any

        data to associate with that key

      Returns void

    • Sets the timeout to use if -1 (specifying default timeout) is passed as timeout_msec in the g_dbus_proxy_call() and g_dbus_proxy_call_sync() functions.

      See the #GDBusProxy:g-default-timeout property for more details.

      Parameters

      • timeout_msec: number

        Timeout in milliseconds.

      Returns void

    • Ensure that interactions with proxy conform to the given interface. See the #GDBusProxy:g-interface-info property for more details.

      Parameters

      • Optionalinfo: DBusInterfaceInfo | null

        Minimum interface this proxy conforms to or %NULL to unset.

      Returns void

    • Sets the #GDBusObject for interface_ to object.

      Note that interface_ will hold a weak reference to object.

      Parameters

      • Optionalobject: DBusObject | null

        A #GDBusObject or %NULL.

      Returns void

    • Sets a property on an object.

      Parameters

      • property_name: string

        The name of the property to set

      • value: any

        The value to set the property to

      Returns void

    • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

      Parameters

      • key: string

        name of the key

      Returns any

      the data if found, or %NULL if no such data exists.

    • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

      void
      object_add_to_user_list (GObject *object,
      const gchar *new_string)
      {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
      }
      static void
      free_string_list (gpointer data)
      {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
      g_free (node->data);
      g_list_free (list);
      }

      Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

      Parameters

      • quark: number

        A #GQuark, naming the user data pointer

      Returns any

      The user data pointer set, or %NULL

    • Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

      Parameters

      • detailedName: string

        Name of the signal to stop emission of

      Returns void

    • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

      Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

      It is an error to call this function when the freeze count is zero.

      Returns void

    • Unblocks a handler so it will be called again during any signal emissions

      Parameters

      • id: number

        Handler ID of the handler to be unblocked

      Returns void

    • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

      If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

      Returns void

    • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

      Returns void

    • emits property change notification for a bunch of properties. Overriding dispatch_properties_changed should be rarely needed.

      Parameters

      • n_pspecs: number
      • pspecs: ParamSpec

      Returns void

    • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

      Returns void

    • Gets the #GDBusObject that interface_ belongs to, if any.

      Returns DBusObject | null

    • instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

      Returns void

    • Signal class handler for the #GDBusProxy::g-properties-changed signal.

      Parameters

      • changed_properties: Variant
      • invalidated_properties: string

      Returns void

    • Signal class handler for the #GDBusProxy::g-signal signal.

      Parameters

      • sender_name: string
      • signal_name: string
      • parameters: Variant

      Returns void

    • Gets D-Bus introspection information for the D-Bus interface implemented by interface_.

      Returns DBusInterfaceInfo

    • the generic getter for all properties of this type. Should be overridden for every type with properties.

      Parameters

      • property_id: number
      • value: any
      • pspec: ParamSpec

      Returns void

    • Initializes the object implementing the interface.

      This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

      The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [description][ifaceGio.Initable#description] for more details.

      Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

      If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

      One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

      Parameters

      • Optionalcancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      Returns boolean

    • Starts asynchronous initialization of the object implementing the interface. This must be done before any real use of the object after initial construction. If the object also implements #GInitable you can optionally call g_initable_init() instead.

      This method is intended for language bindings. If writing in C, g_async_initable_new_async() should typically be used instead.

      When the initialization is finished, callback will be called. You can then call g_async_initable_init_finish() to get the result of the initialization.

      Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL, and the object doesn't support cancellable initialization, the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

      As with #GInitable, if the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. They will often fail with g_critical() or g_warning(), but this must not be relied on.

      Callers should not assume that a class which implements #GAsyncInitable can be initialized multiple times; for more information, see g_initable_init(). If a class explicitly supports being initialized multiple times, implementation requires yielding all subsequent calls to init_async() on the results of the first call.

      For classes that also support the #GInitable interface, the default implementation of this method will run the g_initable_init() function in a thread, so if you want to support asynchronous initialization via threads, just implement the #GAsyncInitable interface without overriding any interface methods.

      Parameters

      • io_priority: number

        the I/O priority of the operation

      • Optionalcancellable: Cancellable | null

        optional #GCancellable object, %NULL to ignore.

      • Optionalcallback: AsyncReadyCallback<StatusNotifierItemProxy> | null

        a #GAsyncReadyCallback to call when the request is satisfied

      Returns void

    • Finishes asynchronous initialization and returns the result. See g_async_initable_init_async().

      Parameters

      • res: AsyncResult

        a #GAsyncResult.

      Returns boolean

    • Emits a "notify" signal for the property property_name on object.

      When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

      Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

      Parameters

      • pspec: ParamSpec

      Returns void

    • Sets the #GDBusObject for interface_ to object.

      Note that interface_ will hold a weak reference to object.

      Parameters

      • Optionalobject: DBusObject | null

        A #GDBusObject or %NULL.

      Returns void

    • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

      Parameters

      • property_id: number
      • value: any
      • pspec: ParamSpec

      Returns void

    • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

      Parameters

      • closure: Closure

        #GClosure to watch

      Returns void

    Properties

    ActivateAsync: (x: number, y: number) => Promise<void>
    AttentionIconName: string
    AttentionIconPixmap: [number, number, Uint8Array<ArrayBufferLike>][]
    Category: string
    ContextMenuAsync: (x: number, y: number) => Promise<void>
    IconName: string
    IconPixmap: [number, number, Uint8Array<ArrayBufferLike>][]
    IconThemePath: string
    Id: string
    ItemIsMenu: boolean
    Menu: string
    ScrollAsync: (delta: number, orientation: string) => Promise<void>
    SecondaryActivateAsync: (x: number, y: number) => Promise<void>
    Status: string
    Title: string
    ToolTip: [string, [number, number, Uint8Array<ArrayBufferLike>], string, string]
    WindowId: number