Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

  • Parameters

    Returns BookSqlite

  • Creates a new #EBookSqlite with the default summary configuration.

    Aside from the manditory fields %E_CONTACT_UID, %E_CONTACT_REV, the default configuration stores the following fields for quick performance of searches: %E_CONTACT_FILE_AS, %E_CONTACT_NICKNAME, %E_CONTACT_FULL_NAME, %E_CONTACT_GIVEN_NAME, %E_CONTACT_FAMILY_NAME, %E_CONTACT_EMAIL, %E_CONTACT_TEL, %E_CONTACT_IS_LIST, %E_CONTACT_LIST_SHOW_ADDRESSES, and %E_CONTACT_WANTS_HTML.

    The fields %E_CONTACT_FULL_NAME and %E_CONTACT_EMAIL are configured to respond extra quickly with the %E_BOOK_INDEX_PREFIX index flag.

    The fields %E_CONTACT_FILE_AS, %E_CONTACT_FAMILY_NAME and %E_CONTACT_GIVEN_NAME are configured to perform well with the #EbSqlCursor interface, using the %E_BOOK_INDEX_SORT_KEY index flag.

    Parameters

    • path: string

      location to load or create the new database

    • source: EDataServer.Source

      an optional #ESource, associated with the #EBookSqlite, or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns BookSqlite

Properties

gTypeInstance: TypeInstance
$gtype: GType<BookSqlite>
name: string

Methods

  • Adds or replaces contacts in ebsql. If replace_existing is specified then existing contacts with the same UID will be replaced, otherwise adding an existing contact will return an error.

    If extra is specified, it must have an equal length as the contacts list. Each element from the extra list will be stored in association with it's corresponding contact in the contacts list.

    Parameters

    • contacts: EBookContacts.Contact[]

      A list of contacts to add to ebsql

    • extra: string[]

      A list of extra data to store in association with this contact

    • replace: boolean

      Whether this contact should replace another contact with the same UID.

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns boolean

  • 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

  • emit(sigName: "before-insert-contact", p0: EBookContacts.Contact, p1: string, p2: boolean, p3: GObject.Object, p4: object, ...args: any[]): void
  • emit(sigName: "before-remove-contact", p0: string, p1: Gio.Cancellable, p2: object, ...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

  • Fetch the #EContact specified by uid in ebsql.

    If meta_contact is specified, then a shallow #EContact will be created holding only the %E_CONTACT_UID and %E_CONTACT_REV fields.

    Parameters

    • uid: string

      The uid of the contact to fetch

    • metaContact: boolean

      Whether an entire contact is desired, or only the metadata

    Returns [boolean, EBookContacts.Contact]

  • getContactExtra(uid: string): [boolean, string]
  • Fetches the extra data previously set for uid, either with e_book_sqlite_set_contact_extra() or when adding contacts.

    Parameters

    • uid: string

      The uid of the contact to fetch the extra data for

    Returns [boolean, 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

  • getKeyValue(key: string): [boolean, string]
  • Fetches the value for key and stores it in value

    Parameters

    • key: string

      The key to fetch a value for

    Returns [boolean, string]

  • getKeyValueInt(key: string): [boolean, number]
  • A convenience function to fetch the value of key as an integer.

    Parameters

    • key: string

      The key to fetch a value for

    Returns [boolean, number]

  • getLocale(): [boolean, string]
  • Fetches the current locale setting for the address-book.

    Upon success, lc_collate_out will hold the returned locale setting, otherwise %FALSE will be returned and error will be updated accordingly.

    Returns [boolean, string]

  • 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

  • getVcard(uid: string, metaContact: boolean): [boolean, string]
  • Fetch a vcard string for uid in ebsql.

    If meta_contact is specified, then a shallow vcard representation will be created holding only the %E_CONTACT_UID and %E_CONTACT_REV fields.

    Parameters

    • uid: string

      The uid of the contact to fetch

    • metaContact: boolean

      Whether an entire contact is desired, or only the metadata

    Returns [boolean, string]

  • 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

  • hasContact(uid: string): [boolean, boolean]
  • Checks if a contact bearing the UID indicated by uid is stored in ebsql.

    Parameters

    • uid: string

      The uid of the contact to check for

    Returns [boolean, boolean]

  • isFloating(): boolean
  • Returns a list of #EExtension objects bound to extensible whose types are ancestors of extension_type. For a complete list of extension objects bound to extensible, pass %E_TYPE_EXTENSION.

    The list itself should be freed with g_list_free(). The extension objects are owned by extensible and should not be unreferenced.

    Parameters

    • extensionType: GType<unknown>

      the type of extensions to list

    Returns EDataServer.Extension[]

  • loadExtensions(): void
  • Creates an instance of all instantiable subtypes of #EExtension which target the class of extensible. The lifetimes of these newly created #EExtension objects are bound to extensible such that they are finalized when extensible is finalized.

    Returns void

  • Obtains an exclusive lock on ebsql and starts a transaction.

    This should be called if you need to access ebsql multiple times while ensuring an atomic transaction. End this transaction with e_book_sqlite_unlock().

    If cancellable is specified, then ebsql will retain a reference to it until e_book_sqlite_unlock() is called. Any accesses to ebsql with the lock held are expected to have the same cancellable specified, or %NULL.

    Aside from ensuring atomicity of transactions, this function will hold a mutex which will cause further calls to e_book_sqlite_lock() to block. If you are accessing ebsql from multiple threads, then any interactions with ebsql should be nested in calls to e_book_sqlite_lock() and e_book_sqlite_unlock().

    Parameters

    Returns 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

  • 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

  • References the currently active #ECollator for ebsql, use e_collator_unref() when finished using the returned collator.

    Note that the active collator will change with the active locale setting.

    Returns Collator

  • 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

  • References the #ESource to which ebsql is paired, use g_object_unref() when finished using the source. It can be %NULL in some cases, like when running tests.

    Returns EDataServer.Source

  • Removes the contact indicated by uid from ebsql.

    Parameters

    • uid: string

      the uid of the contact to remove

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns boolean

  • Removes the contacts indicated by uids from ebsql.

    Parameters

    • uids: string[]

      a #GSList of uids indicating which contacts to remove

    • cancellable: Gio.Cancellable

      A #GCancellable

    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

  • Searches ebsql for contacts matching the search expression indicated by sexp.

    When sexp refers only to #EContactFields configured in the summary of ebsql, the search should always be quick, when searching for other #EContactFields a fallback will be used, possibly invoking any #EbSqlVCardCallback which may have been passed to e_book_sqlite_new_full().

    The returned ret_list list should be freed with g_slist_free() and all elements freed with e_book_sqlite_search_data_free().

    If meta_contact is specified, then shallow vcard representations will be created holding only the %E_CONTACT_UID and %E_CONTACT_REV fields.

    Parameters

    • sexp: string

      search expression; use %NULL or an empty string to list all stored contacts.

    • metaContacts: boolean

      Whether entire contacts are desired, or only the metadata

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns [boolean, bSqlSearchData[]]

  • searchUids(sexp: string, cancellable: Gio.Cancellable): [boolean, string[]]
  • Similar to e_book_sqlitedb_search(), but fetches only a list of contact UIDs.

    The returned ret_list list should be freed with g_slist_free() and all elements freed with g_free().

    Parameters

    • sexp: string

      search expression; use %NULL or an empty string to get all stored contacts.

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns [boolean, string[]]

  • setContactExtra(uid: string, extra: string): boolean
  • Sets or replaces the extra data associated with uid.

    Parameters

    • uid: string

      The uid of the contact to set the extra data for

    • extra: string

      The extra data to set

    Returns boolean

  • 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

  • setKeyValue(key: string, value: string): boolean
  • Sets the value for key to be value

    Parameters

    • key: string

      The key to fetch a value for

    • value: string

      The new value for key

    Returns boolean

  • setKeyValueInt(key: string, value: number): boolean
  • A convenience function to set the value of key as an integer.

    Parameters

    • key: string

      The key to fetch a value for

    • value: number

      The new value for key

    Returns boolean

  • Relocalizes any locale specific data in the specified new lc_collate locale.

    The lc_collate locale setting is stored and remembered on subsequent accesses of the addressbook, changing the locale will store the new locale and will modify sort keys and any locale specific data in the addressbook.

    As a side effect, it's possible that changing the locale will cause stored vcards to change. Notifications for these changes can be caught with the #EbSqlVCardCallback provided to e_book_sqlite_new_full().

    Parameters

    • lcCollate: string

      The new locale for the addressbook

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns boolean

  • 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

  • Releases an exclusive on ebsql and finishes a transaction previously started with e_book_sqlite_lock_updates().

    If this fails, the lock on ebsql is still released and error will be set to indicate why the transaction or rollback failed.

    Parameters

    Returns boolean

  • 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

  • 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 #EBookSqlite with the default summary configuration.

    Aside from the manditory fields %E_CONTACT_UID, %E_CONTACT_REV, the default configuration stores the following fields for quick performance of searches: %E_CONTACT_FILE_AS, %E_CONTACT_NICKNAME, %E_CONTACT_FULL_NAME, %E_CONTACT_GIVEN_NAME, %E_CONTACT_FAMILY_NAME, %E_CONTACT_EMAIL, %E_CONTACT_TEL, %E_CONTACT_IS_LIST, %E_CONTACT_LIST_SHOW_ADDRESSES, and %E_CONTACT_WANTS_HTML.

    The fields %E_CONTACT_FULL_NAME and %E_CONTACT_EMAIL are configured to respond extra quickly with the %E_BOOK_INDEX_PREFIX index flag.

    The fields %E_CONTACT_FILE_AS, %E_CONTACT_FAMILY_NAME and %E_CONTACT_GIVEN_NAME are configured to perform well with the #EbSqlCursor interface, using the %E_BOOK_INDEX_SORT_KEY index flag.

    Parameters

    • path: string

      location to load or create the new database

    • source: EDataServer.Source

      an optional #ESource, associated with the #EBookSqlite, or %NULL

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns BookSqlite

  • Opens or creates a new addressbook at path.

    Like e_book_sqlite_new(), but allows configuration of which contact fields will be stored for quick reference in the summary. The configuration indicated by setup will only be taken into account when initially creating the underlying table, further configurations will be ignored.

    The fields %E_CONTACT_UID and %E_CONTACT_REV are not optional, they will be stored in the summary regardless of this function's parameters. Only #EContactFields with the type #G_TYPE_STRING, #G_TYPE_BOOLEAN or #E_TYPE_CONTACT_ATTR_LIST are currently supported.

    If vcard_callback is specified, then vcards will not be stored by functions such as e_book_sqlitedb_add_contact(). Instead vcard_callback will be invoked at any time the created #EBookSqlite requires a vcard, either as a fallback for querying search expressions which cannot be satisfied with the summary fields, or when reporting results from searches.

    If any error occurs and %NULL is returned, then the passed user_data will be automatically freed using the user_data_destroy function, if specified.

    It is recommended to store all contact vcards in the #EBookSqlite addressbook if at all possible, however in some cases the vcards must be stored in some other storage.

    Parameters

    • path: string

      location to load or create the new database

    • source: EDataServer.Source

      an optional #ESource, associated with the #EBookSqlite, or %NULL

    • setup: SourceBackendSummarySetup

      an #ESourceBackendSummarySetup describing how the summary should be setup, or %NULL to use the default

    • vcardCallback: bSqlVCardCallback

      A function to resolve vcards

    • changeCallback: bSqlChangeCallback

      A function to catch notifications of vcard changes

    • cancellable: Gio.Cancellable

      A #GCancellable

    Returns BookSqlite

  • 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

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