Gjsify LogoGjsify Logo

Contains only private data that should be read and manipulated using the functions below.

Hierarchy

Index

Constructors

Properties

capabilities: object

The capabilities of this client

gTypeInstance: TypeInstance
mainContext: MainContext

The main loop context in which notifications for this client will be delivered.

online: boolean

Whether this client's backing data is online.

opened: boolean

Whether this client is open and ready to use.

readonly: boolean

Whether this client's backing data is readonly.

The #ESource for which this client was created.

name: string

Methods

  • 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • 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

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • cancelAll(): void
  • checkCapability(capability: string): boolean
  • Check if backend supports particular capability. To get all capabilities use e_client_get_capabilities().

    Parameters

    • capability: string

      a capability

    Returns boolean

  • checkRefreshSupported(): boolean
  • Checks whether a client supports explicit refreshing (see e_client_refresh()).

    Returns boolean

  • connect(sigName: "backend-died", callback: Client_BackendDiedSignalCallback): number
  • connect(sigName: "backend-error", callback: Client_BackendErrorSignalCallback): number
  • connect(sigName: "backend-property-changed", callback: Client_BackendPropertyChangedSignalCallback): number
  • connect(sigName: "opened", callback: Client_OpenedSignalCallback): number
  • connect(sigName: "notify::capabilities", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::main-context", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::online", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::opened", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::readonly", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::source", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • dupBusName(): string
  • Returns a D-Bus bus name that will be used to connect the client to the backend subprocess.

    Returns string

  • emit(sigName: "backend-died", ...args: any[]): void
  • emit(sigName: "backend-error", ...args: any[]): void
  • emit(sigName: "backend-property-changed", p0: string, ...args: any[]): void
  • emit(sigName: "opened", ...args: any[]): void
  • emit(sigName: "notify::capabilities", ...args: any[]): void
  • emit(sigName: "notify::main-context", ...args: any[]): void
  • emit(sigName: "notify::online", ...args: any[]): void
  • emit(sigName: "notify::opened", ...args: any[]): void
  • emit(sigName: "notify::readonly", ...args: any[]): void
  • emit(sigName: "notify::source", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): 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

  • freezeNotify(): 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

  • Queries client's backend for a property of name prop_name. The call is finished by e_client_get_backend_property_finish() from the callback.

    Parameters

    • propName: string

      property name, whose value to retrieve; cannot be %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    • callback: AsyncReadyCallback

      callback to call when a result is ready

    Returns void

  • getBackendPropertyFinish(result: AsyncResult): [boolean, string]
  • getBackendPropertySync(propName: string, cancellable: Gio.Cancellable): [boolean, string]
  • Queries client's backend for a property of name prop_name.

    Parameters

    • propName: string

      property name, whose value to retrieve; cannot be %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    Returns [boolean, string]

  • getCapabilities(): string[]
  • Get list of strings with capabilities advertised by a backend. This list, together with inner strings, is owned by the client. To check for individual capabilities use e_client_check_capability().

    Returns string[]

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue 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 g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getv(names: string[], values: any[]): void
  • 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

  • isFloating(): boolean
  • isOnline(): boolean
  • isOpened(): boolean
  • Check if this client is fully opened. This includes everything from e_client_open() call up to the authentication, if required by a backend. Client cannot do any other operation during the opening phase except of authenticate or cancel it. Every other operation results in an %E_CLIENT_ERROR_BUSY error.

    Returns boolean

  • isReadonly(): boolean
  • notify(propertyName: string): void
  • 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

    • propertyName: 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.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    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

  • off(sigName: "backend-died", callback: Client_BackendDiedSignalCallback): EventEmitter
  • off(sigName: "backend-error", callback: Client_BackendErrorSignalCallback): EventEmitter
  • off(sigName: "backend-property-changed", callback: Client_BackendPropertyChangedSignalCallback): EventEmitter
  • off(sigName: "opened", callback: Client_OpenedSignalCallback): EventEmitter
  • off(sigName: "notify::capabilities", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::main-context", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::online", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::opened", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::readonly", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::source", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • on(sigName: "backend-died", callback: Client_BackendDiedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "backend-error", callback: Client_BackendErrorSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "backend-property-changed", callback: Client_BackendPropertyChangedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "opened", callback: Client_OpenedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::capabilities", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::opened", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::readonly", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::capabilities"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::main-context"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::online"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::opened"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::readonly"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "backend-died", callback: Client_BackendDiedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "backend-error", callback: Client_BackendErrorSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "backend-property-changed", callback: Client_BackendPropertyChangedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "opened", callback: Client_OpenedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::capabilities", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::opened", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::readonly", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::capabilities"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::main-context"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::online"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::opened"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::readonly"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::source"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Opens the client, making it ready for queries and other operations. The call is finished by e_client_open_finish() from the callback.

    Parameters

    • onlyIfExists: boolean

      this parameter is not used anymore

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    • callback: AsyncReadyCallback

      callback to call when a result is ready

    Returns void

  • openSync(onlyIfExists: boolean, cancellable: Gio.Cancellable): boolean
  • Opens the client, making it ready for queries and other operations.

    Parameters

    • onlyIfExists: boolean

      this parameter is not used anymore

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    Returns boolean

  • 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 GObject.Object

  • Returns the #GMainContext on which event sources for client are to be attached.

    The returned #GMainContext is referenced for thread-safety and must be unreferenced with g_main_context_unref() when finished with it.

    Returns MainContext

  • 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 GObject.Object

  • Initiates refresh on the client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method. The call is finished by e_client_refresh_finish() from the callback.

    Parameters

    Returns void

  • Initiates refresh on the client. Finishing the method doesn't mean that the refresh is done, backend only notifies whether it started refreshing or not. Use e_client_check_refresh_supported() to check whether the backend supports this method.

    Parameters

    Returns boolean

  • Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back! The call is finished by e_client_remove_finish() from the callback.

    Parameters

    Returns void

  • Removes the backing data for this #EClient. For example, with the file backend this deletes the database file. You cannot get it back!

    Parameters

    Returns boolean

  • Initiates retrieval of capabilities on the client. This is usually required only once, after the client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. The call is finished by e_client_retrieve_capabilities_finish() from the callback.

    Parameters

    Returns void

  • retrieveCapabilitiesFinish(result: AsyncResult): [boolean, string]
  • Finishes previous call of e_client_retrieve_capabilities(). Returned value of capabilities should be freed with g_free(), when no longer needed.

    Parameters

    Returns [boolean, string]

  • retrieveCapabilitiesSync(cancellable: Gio.Cancellable): [boolean, string]
  • Initiates retrieval of capabilities on the client. This is usually required only once, after the client is opened. The returned value is cached and any subsequent call of e_client_get_capabilities() and e_client_check_capability() is using the cached value. Returned value of capabilities should be freed with g_free(), when no longer needed.

    Parameters

    Returns [boolean, string]

  • Asynchronously retrieves client properties to match server-side values, without waiting for the D-Bus property change notifications delivery.

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

    Parameters

    Returns void

  • Finishes the operation started with e_client_retrieve_properties().

    If an error occurs, the function sets error and returns %FALSE.

    Parameters

    Returns boolean

  • Retrieves client properties to match server-side values, without waiting for the D-Bus property change notifications delivery.

    If an error occurs, the function sets error and returns %FALSE.

    Parameters

    Returns boolean

  • runDispose(): void
  • 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 client's backend property of name prop_name to value prop_value. The call is finished by e_client_set_backend_property_finish() from the callback.

    Parameters

    • propName: string

      property name, whose value to change; cannot be %NULL

    • propValue: string

      property value, to set; cannot be %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    • callback: AsyncReadyCallback

      callback to call when a result is ready

    Returns void

  • setBackendPropertySync(propName: string, propValue: string, cancellable: Gio.Cancellable): boolean
  • Sets client's backend property of name prop_name to value prop_value.

    Parameters

    • propName: string

      property name, whose value to change; cannot be %NULL

    • propValue: string

      property value, to set; cannot be %NULL

    • cancellable: Gio.Cancellable

      a #GCancellable; can be %NULL

    Returns boolean

  • setBusName(busName: string): void
  • Sets a D-Bus bus name that will be used to connect the client to the backend subprocess.

    Parameters

    • busName: string

      a string representing a D-Bus bus name

    Returns void

  • setData(key: string, data?: object): 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

    • Optional data: object

      data to associate with that key

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • 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 object

  • thawNotify(): 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

  • unref(): 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

  • Unwraps D-Bus error to local error. dbus_error is automatically freed. dbus_erorr and out_error can point to the same variable.

    Parameters

    • dbusError: GLib.Error

      a #GError returned bu D-Bus

    Returns void

  • Asynchronously waits until the client is connected (according to ESource::connection-status property), but not longer than timeout_seconds.

    The call is finished by e_client_wait_for_connected_finish() from the callback.

    Parameters

    • timeoutSeconds: number

      a timeout for the wait, in seconds

    • cancellable: Gio.Cancellable

      a #GCancellable; or %NULL

    • callback: AsyncReadyCallback

      callback to call when a result is ready

    Returns void

  • waitForConnectedSync(timeoutSeconds: number, cancellable: Gio.Cancellable): boolean
  • Synchronously waits until the client is connected (according to ESource::connection-status property), but not longer than timeout_seconds.

    Note: This also calls e_client_retrieve_properties_sync() on success, to have up-to-date property values on the client side, without a delay due to property change notifcations delivery through D-Bus.

    Parameters

    • timeoutSeconds: number

      a timeout for the wait, in seconds

    • cancellable: Gio.Cancellable

      a #GCancellable; or %NULL

    Returns boolean

  • watchClosure(closure: TClosure<any, any>): 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: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • errorQuark(): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • utilCopyStringSlist(copyTo: string[], strings: string[]): string[]
  • Copies the #GSList of strings to the end of copy_to.

    Parameters

    • copyTo: string[]

      Where to copy; may be %NULL

    • strings: string[]

      #GSList of strings to be copied

    Returns string[]

  • utilFreeStringSlist(strings: string[]): void
  • Frees memory previously allocated by e_client_util_strv_to_slist().

    Parameters

    • strings: string[]

      a #GSList of strings (gchar *)

    Returns void

  • utilParseCommaStrings(strings: string): string[]
  • Parses comma-separated list of values into #GSList.

    Parameters

    • strings: string

      string of comma-separated values

    Returns string[]

  • utilSlistToStrv(strings: string[]): string[]
  • Convert a list of strings into a %NULL-terminated array of strings.

    Parameters

    • strings: string[]

      a #GSList of strings (const gchar *)

    Returns string[]

  • utilStrvToSlist(strv: string): string[]
  • Convert a %NULL-terminated array of strings to a list of strings.

    Parameters

    • strv: string

      a %NULL-terminated array of strings (const gchar *)

    Returns string[]

  • utilUnwrapDbusError(dbusError: GLib.Error, knownErrors: ClientErrorsList, knownErrorsCount: number, knownErrorsDomain: number, failWhenNoneMatched: boolean): [boolean, GLib.Error]
  • The function takes a dbus_error and tries to find a match in known_errors for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else then the dbus_error is moved to client_error.

    The fail_when_none_matched influences behaviour. If it's %TRUE, and none of known_errors matches, or this is not a G_IO_ERROR_DBUS_ERROR, then %FALSE is returned and the client_error is left without change. Otherwise, the fail_when_none_matched is %FALSE, the error is always processed and will result in E_CLIENT_ERROR, E_CLIENT_ERROR_OTHER_ERROR if none of known_error matches.

    Parameters

    • dbusError: GLib.Error

      DBus #GError to unwrap

    • knownErrors: ClientErrorsList

      List of known errors against which try to match

    • knownErrorsCount: number

      How many items are stored in known_errors

    • knownErrorsDomain: number

      Error domain for known_errors

    • failWhenNoneMatched: boolean

      Whether to fail when none of known_errors matches

    Returns [boolean, GLib.Error]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method