Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

g_type_instance: TypeInstance
$gtype: GType<DB>
name: string

Methods

  • abort_transaction(): number
  • add_to_transaction(query: string): number
  • Adds a statement to an ongoing transaction.

    Parameters

    • query: string

      an SQL (SQLite) statement

    Returns number

  • begin_transaction(): number
  • 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 source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: 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

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

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

    • transform_from: TClosure<any, any>

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

    Returns Binding

  • clear_folder_summary(folder_name: string): number
  • Deletes the given folder from the 'folders' table and empties its message info table.

    Parameters

    • folder_name: string

      full name of the folder

    Returns number

  • command(stmt: string): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • count_deleted_message_info(table_name: string): [number, number]
  • Counts how many deleted messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • count_junk_message_info(table_name: string): [number, number]
  • Counts how many junk messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • count_junk_not_deleted_message_info(table_name: string, count: number): number
  • count_message_info(query: string): [number, number]
  • Executes a COUNT() query (like "SELECT COUNT(*) FROM table") and provides the result of it as an unsigned 32-bit integer.

    Parameters

    • query: string

      a COUNT() query

    Returns [number, number]

  • count_total_message_info(table_name: string): [number, number]
  • Counts how many messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • count_unread_message_info(table_name: string): [number, number]
  • Counts how many unread messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • count_visible_message_info(table_name: string): [number, number]
  • Counts how many visible (not deleted and not junk) messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • count_visible_unread_message_info(table_name: string): [number, number]
  • Counts how many visible (not deleted and not junk) and unread messages is stored in the given table.

    Parameters

    • table_name: string

      name of the table

    Returns [number, number]

  • create_folders_table(): number
  • delete_folder(folder_name: string): number
  • Deletes the given folder from the 'folders' table and also drops its message info table.

    Parameters

    • folder_name: string

      full name of the folder

    Returns number

  • delete_uid(folder_name: string, uid: string): number
  • Deletes single mesage info in the given folder with the given UID.

    Parameters

    • folder_name: string

      full name of the folder

    • uid: string

      a message info UID to delete

    Returns number

  • delete_uids(folder_name: string, uids: string[]): number
  • Deletes a list of message UIDs as one transaction.

    Parameters

    • folder_name: string

      full name of the folder

    • uids: string[]

      A #GList of uids

    Returns number

  • disconnect(id: number): void
  • emit(sigName: string, ...args: any[]): void
  • end_transaction(): number
  • flush_in_memory_transactions(folder_name: string): number
  • A pair function for camel_db_start_in_memory_transactions(), to commit the changes to folder_name and free the in-memory table.

    Parameters

    • folder_name: string

      full name of the folder

    Returns number

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

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

  • get_data(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

  • get_filename(): string
  • get_folder_deleted_uids(folder_name: string): string[]
  • get_folder_junk_uids(folder_name: string): string[]
  • get_folder_uids(folder_name: string, sort_by: string, collate: string, hash: HashTable<string | number | symbol, string | number | boolean>): number
  • Fills hash with uid->GUINT_TO_POINTER (flag). Use camel_pstring_free() to free the keys of the hash.

    Parameters

    • folder_name: string

      full name of the folder

    • sort_by: string

      optional ORDER BY clause (without the "ORDER BY" prefix)

    • collate: string

      optional collate function name to use

    • hash: HashTable<string | number | symbol, string | number | boolean>

      a hash table to fill

    Returns number

  • get_property(property_name?: 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 property_name: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

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

  • is_floating(): boolean
  • maybe_run_maintenance(): boolean
  • notify(property_name: 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

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

      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

  • prepare_message_info_table(folder_name: string): number
  • Prepares message info table for the given folder.

    Parameters

    • folder_name: string

      full name of the folder

    Returns number

  • read_folder_info_record(folder_name: string): [number, FIRecord]
  • reads folder information for the given folder and stores it into the record.

    Parameters

    • folder_name: string

      full name of the folder

    Returns [number, FIRecord]

  • read_message_info_record_with_uid(folder_name: string, uid: string, callback: DBSelectCB): number
  • Selects single message info for the given uid in folder folder_name and calls the callback for it.

    Parameters

    • folder_name: string

      full name of the folder

    • uid: string

      a message info UID to read the record for

    • callback: DBSelectCB

      callback to call for the found row

    Returns number

  • read_message_info_records(folder_name: string, callback: DBSelectCB): number
  • Reads all mesasge info records for the given folder and calls callback for them.

    Parameters

    • folder_name: string

      full name of the folder

    • callback: DBSelectCB

      callback to call for each found row

    Returns number

  • 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

  • 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

  • rename_folder(old_folder_name: string, new_folder_name: string): number
  • Renames tables for the old_folder_name to be used with new_folder_name.

    Parameters

    • old_folder_name: string

      full name of the existing folder

    • new_folder_name: string

      full name of the folder to rename it to

    Returns number

  • reset_folder_version(folder_name: string, reset_version: number): number
  • Sets a version number for the given folder.

    Parameters

    • folder_name: string

      full name of the folder

    • reset_version: number

      version number to set

    Returns number

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

  • select(stmt: string, callback: DBSelectCB): number
  • Executes a SELECT staement and calls the callback for each selected row.

    Parameters

    • stmt: string

      a SELECT statment to execute

    • callback: DBSelectCB

      a callback to call for each row

    Returns number

  • set_collate(col: string, collate: string, func: DBCollate): number
  • Defines a collation collate, which can be used in SQL (SQLite) statement as a collation function. The func is called when colation is used.

    Parameters

    • col: string

      a column name; currently unused

    • collate: string

      collation name

    • func: DBCollate

      a #CamelDBCollate collation function

    Returns number

  • set_data(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

  • set_property(property_name: string, value?: any): void
  • start_in_memory_transactions(): number
  • Creates an in-memory table for a batch transactions. Use camel_db_flush_in_memory_transactions() to commit the changes and free the in-memory table.

    Returns number

  • steal_data(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

  • steal_qdata(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

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

  • transaction_command(qry_list: string[]): number
  • Runs the list of commands as a single transaction.

    Parameters

    • qry_list: string[]

      A #GList of querries

    Returns number

  • 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

  • vfunc_constructed(): void
  • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
  • vfunc_dispose(): void
  • vfunc_finalize(): void
  • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): 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.

    virtual

    Parameters

    Returns void

  • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
  • watch_closure(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

  • write_folder_info_record(record: FIRecord): number
  • write_message_info_record(folder_name: string, record: MIRecord): number
  • Write the record to the message info table of the given folder.

    Parameters

    • folder_name: string

      full name of the folder

    • record: MIRecord

      a #CamelMIRecord

    Returns number

  • compat_control(what: number, data: object): number
  • error_quark(): number
  • free_sqlized_string(string: string): void
  • Frees a string previosuly returned by camel_db_sqlize_string().

    Parameters

    • string: string

      a string to free

    Returns void

  • get_column_ident(hash: HashTable<string | number | symbol, string | number | boolean>, index: number, col_names: string[]): [DBKnownColumnNames, HashTable<string | number | symbol, string | number | boolean>]
  • Traverses column name from index index into an enum #CamelDBKnownColumnNames value. The col_names contains ncols columns. First time this is called is created the hash from col_names indexes into the enum, and this is reused for every other call. The function expects that column names are returned always in the same order. When all rows are read the hash table can be freed with g_hash_table_destroy().

    Parameters

    • hash: HashTable<string | number | symbol, string | number | boolean>

      a #GHashTable

    • index: number

      an index to start with, between 0 and ncols

    • col_names: string[]

      column names to traverse

    Returns [DBKnownColumnNames, HashTable<string | number | symbol, string | number | boolean>]

  • get_column_name(raw_name: string): string
  • 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

    • g_iface: TypeInterface

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

    • property_name: 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

    • g_iface: 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

    • g_iface: TypeInterface

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

    Returns ParamSpec[]

  • new(filename: string): DB
  • 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

    • object_type: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

  • release_cache_memory(): void
  • Instructs sqlite to release its memory, if possible. This can be avoided when CAMEL_SQLITE_FREE_CACHE environment variable is set.

    Returns void

  • sqlize_string(string: string): string
  • Converts the string to be usable in the SQLite statements.

    Parameters

    • string: string

      a string to "sqlize"

    Returns string

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