Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

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

Methods

  • Adds a copy of zone to cache and emits an #ETimezoneCache::timezone-added signal. The cache will use the TZID string returned by i_cal_timezone_get_tzid() as the lookup key, which can be passed to e_timezone_cache_get_timezone() to obtain zone again.

    If the cache already has an #ICalTimezone with the same TZID string as zone, the cache will remain unchanged to avoid invalidating any #ICalTimezone pointers which may have already been returned through e_timezone_cache_get_timezone().

    Parameters

    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

    • 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

  • changeRevision(): void
  • Instructs the cache to change its revision. In case the revision change is frozen with e_cache_freeze_revision_change() it notes to change the revision once the revision change is fully thaw.

    Returns void

  • contains(uid: string, rid?: string, deletedFlag?: CacheDeletedFlag): boolean
  • contains(uid: string, deletedFlag?: CacheDeletedFlag): boolean
  • contains(...args: any[]): any
  • contains(args_or_uid: string | any[], deletedFlag?: CacheDeletedFlag): any
  • Checkes whether the cal_cache contains an object with the given uid and rid. The rid can be an empty string or %NULL to search for the master object, otherwise the check is done for a detached instance, not for a recurrence instance.

    Parameters

    • uid: string

      component UID

    • Optional rid: string

      optional component Recurrence-ID or %NULL

    • Optional deletedFlag: CacheDeletedFlag

      one of #ECacheDeletedFlag enum

    Returns boolean

  • Checkes whether the cache contains an object with the given uid.

    Parameters

    • uid: string

      a unique identifier of an object

    • Optional deletedFlag: CacheDeletedFlag

      one of #ECacheDeletedFlag enum

    Returns boolean

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Adds every column value which is not part of the other_columns to it, except of E_CACHE_COLUMN_UID, E_CACHE_COLUMN_REVISION, E_CACHE_COLUMN_OBJECT and E_CACHE_COLUMN_STATE columns.

    This can be used within the callback of e_cache_foreach_update().

    Parameters

    • columnNames: string[]

      column names

    • columnValues: string[]

      column values

    • otherColumns: CacheColumnValues

      an #ECacheColumnValues to fill

    Returns CacheColumnValues

  • Deletes all locally stored attachments beside the cache file from the disk. This doesn't modify the component. It's usually called before the component is being removed from the cal_cache.

    Parameters

    Returns boolean

  • Returns the icomp revision, used to detect changes. The returned string should be freed with g_free(), when no longer needed.

    Parameters

    Returns string

  • dupKey(key: string): string
  • dupRevision(): string
  • dupTimezoneAsString(tzid: string, cancellable: Gio.Cancellable): [boolean, string]
  • Gets a timezone with given tzid, which had been previously put into the cal_cache with e_cal_cache_put_timezone(). The returned string is an iCal string for that ICalTimezone and should be freed with g_free() when no longer needed.

    Parameters

    • tzid: string

      a timezone ID to get

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string]

  • emit(sigName: "dup-component-revision", ...args: any[]): void
  • emit(sigName: "get-timezone", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • erase(): void
  • Erases the cache and all of its content from the disk. The only valid operation after this is to free the cache.

    Returns 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

  • Calls func for each found object, which satisfies the criteria for both deleted_flag and where_clause.

    Note the func should not call any SQLite commands, because it's invoked within a SELECT statement execution.

    Parameters

    • deletedFlag: CacheDeletedFlag

      one of #ECacheDeletedFlag enum

    • whereClause: string

      an optional SQLite WHERE clause part, or %NULL

    • func: CacheForeachFunc

      an #ECacheForeachFunc function to call for each object

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Calls func for each found object, which satisfies the criteria for both deleted_flag and where_clause, letting the caller update values where necessary. The return value of func is used to determine whether the call was successful, not whether there are any changes to be saved. If anything fails during the call then the all changes are reverted.

    When there are requested any changes by the func, this function also calls e_cache_copy_missing_to_column_values() to ensure no descendant column data is lost.

    Parameters

    • deletedFlag: CacheDeletedFlag

      one of #ECacheDeletedFlag enum

    • whereClause: string

      an optional SQLite WHERE clause part, or %NULL

    • func: CacheUpdateFunc

      an #ECacheUpdateFunc function to call for each object

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • 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

  • freezeRevisionChange(): void
  • Freezes automatic revision change for the cache. The function can be called multiple times, but each such call requires its pair function e_cache_thaw_revision_change() call. See also e_cache_change_revision().

    Returns void

  • Returns an object with the given uid. This function does not consider locally deleted objects. The out_revision is set to the object revision, if not %NULL. Free it with g_free() when no longer needed. Similarly the out_other_columns contains a column name to column value strings for additional columns which had been requested when calling e_cache_initialize_sync(), if not %NULL. Free the returned #ECacheColumnValues with e_cache_column_values_free(), when no longer needed.

    Parameters

    • uid: string

      a unique identifier of an object

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [string, string, CacheColumnValues]

  • Gets a component identified by uid, and optionally by the rid, from the cal_cache. The returned out_component should be freed with g_object_unref(), when no longer needed.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ECal.Component]

  • getComponentAsString(uid: string, rid: string, cancellable: Gio.Cancellable): [boolean, string]
  • Gets a component identified by uid, and optionally by the rid, from the cal_cache. The returned out_icalstring should be freed with g_free(), when no longer needed.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string]

  • getComponentCustomFlags(uid: string, rid: string, cancellable: Gio.Cancellable): [boolean, number]
  • Gets the custom flags previously set for uid and rid, either with e_cal_cache_set_component_custom_flags(), when adding components or when removing components in offline.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, number]

  • getComponentExtra(uid: string, rid: string, cancellable: Gio.Cancellable): [boolean, string]
  • Gets the extra data previously set for uid and rid, either with e_cal_cache_set_component_extra() or when adding components.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string]

  • Gets the master object and all detached instances for a component identified by the uid. Free the returned #GSList with g_slist_free_full (components, g_object_unref); when no longer needed.

    Parameters

    • uid: string

      a UID of the component

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ECal.Component[]]

  • getComponentsByUidAsString(uid: string, cancellable: Gio.Cancellable): [boolean, string[]]
  • Gets the master object and all detached instances as string for a component identified by the uid. Free the returned #GSList with g_slist_free_full (icalstrings, g_free); when no longer needed.

    Parameters

    • uid: string

      a UID of the component

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, string[]]

  • Gets a list of components which occur in the given time range. It's not an error if none is found.

    Parameters

    • rangeStart: number

      start of the range, as time_t, inclusive

    • rangeEnd: number

      end of the range, as time_t, exclusive

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ECal.Component[]]

  • getComponentsInRangeAsStrings(rangeStart: number, rangeEnd: number, cancellable: Gio.Cancellable): [boolean, string[]]
  • Gets a list of components, as iCal strings, which occur in the given time range.

    Parameters

    • rangeStart: number

      start of the range, as time_t, inclusive

    • rangeEnd: number

      end of the range, as time_t, exclusive

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    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

  • getFilename(): string
  • Gets all the ID-s the extra data is set for.

    The out_ids should be freed with g_slist_free_full (ids, (GDestroyNotify) e_cal_component_id_free); when no longer needed.

    Parameters

    • extra: string

      an extra column value to search for

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ComponentId[]]

  • getKeyInt(key: string): number
  • Gets a list of objects stored in the cache, optionally together with their revisions. The uids are not returned in any particular order, but the position between out_objects and out_revisions matches the same object.

    Both out_objects and out_revisions contain newly allocated #GSList, which should be freed with g_slist_free_full (slist, g_free); when no longer needed.

    Parameters

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

  • getSqlitedb(): object
  • Gets a timezone with given tzid, which had been previously put into the cal_cache with e_cal_cache_put_timezone(). The returned ICalTimezone is owned by the cal_cache and should not be freed.

    Parameters

    • tzid: string

      a timezone ID to get

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ICalGLib.Timezone]

  • Obtains an #ICalTimezone by its TZID string. If no match is found, the function returns %NULL. The returned #ICalTimezone is owned by the cache and should not be modified or freed.

    Parameters

    • tzid: string

      the TZID of a timezone

    Returns ICalGLib.Timezone

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    • args_or_tzid: string | any[]

    Returns any

  • Gets a list of unique object identifiers stored in the cache, optionally together with their revisions. The uids are not returned in any particular order, but the position between out_uids and out_revisions matches the same object.

    Both out_uids and out_revisions contain newly allocated #GSList, which should be freed with g_slist_free_full (slist, g_free); when no longer needed.

    Parameters

    Returns [boolean, string[], string[]]

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

  • Initializes the cache and opens the filename database. This should be called by the descendant.

    The other_columns are added to the objects table (E_CACHE_TABLE_OBJECTS). Values for these columns are returned by e_cache_get() and can be stored with e_cache_put().

    Parameters

    • filename: string

      a filename of an SQLite database to use

    • otherColumns: CacheColumnInfo[]

      an optional #GSList with additional columns to add to the objects table

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • isFloating(): boolean
  • isRevisionChangeFrozen(): 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[]

  • Gets a list of all stored timezones by the cal_cache. Only the returned list should be freed with g_list_free() when no longer needed; the #ICalTimezone-s are owned by the cal_cache.

    Note: The list can contain timezones previously stored in the cache, but removed from it since they were loaded, because these are freed only when also the cal_cache is freed.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ICalGLib.Timezone[]]

  • Returns a list of #ICalTimezone instances that were explicitly added to the cache through e_timezone_cache_add_timezone(). In particular, any built-in time zone data that e_timezone_cache_get_timezone() may use to match a TZID string is excluded from the returned list.

    Free the returned list with g_list_free(). The list elements are owned by the cache and should not be modified or freed.

    Returns ICalGLib.Timezone[]

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    • Rest ...args: any[]

    Returns any

  • 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

  • Locks the cache thus other threads cannot use it. This can be called recursively within one thread. Each call should have its pair e_cache_unlock().

    Parameters

    Returns void

  • 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

  • Stores an object into the cache. Depending on offline_flag, this update the object's offline state accordingly. When the offline_flag is set to %E_CACHE_IS_ONLINE, then it's set to #E_OFFLINE_STATE_SYNCED, like to be fully synchronized with the server, regardless of its previous offline state. Overwriting locally deleted object behaves like an addition of a completely new object.

    Parameters

    • uid: string

      a unique identifier of an object

    • revision: string

      a revision of the object

    • object: string

      the object itself

    • otherColumns: CacheColumnValues

      an #ECacheColumnValues with other columns to set; can be %NULL

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether putting this object in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Adds a component into the cal_cache. Any existing with the same UID and RID is replaced.

    Parameters

    • component: ECal.Component

      an #ECalComponent to put into the cal_cache

    • extra: string

      an extra data to store in association with the component

    • customFlags: number

      custom flags for the component, not interpreted by the cal_cache

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether putting this component in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Adds a list of components into the cal_cache. Any existing with the same UID and RID are replaced.

    If extras is not %NULL, its length should be the same as the length of the components. Similarly the non-NULL custom_flags length should be the same as the length of the components.

    Parameters

    • components: ECal.Component[]

      a #GSList of #ECalComponent to put into the cal_cache

    • extras: string[]

      optional extra data to store in association with the components

    • customFlags: number[]

      optional custom flags to use for the components

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether putting these components in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Puts the zone into the cal_cache using its timezone ID as an identificator. The function adds a new or replaces existing, if any such already exists in the cal_cache. The function does nothing and returns %TRUE, when the passed-in zone is libical builtin timezone.

    Parameters

    • zone: ICalGLib.Timezone

      an #ICalTimezone to put

    • incRefCounts: number

      how many refs to add, or 0 to have it stored forever

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %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

  • 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

  • Removes the object with the given uid from the cache. Based on the offline_flag, it can remove also any information about locally made offline changes. Removing the object with %E_CACHE_IS_OFFLINE will still remember it for later use with e_cache_get_offline_changes().

    Parameters

    • uid: string

      a unique identifier of an object

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether removing the object in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Removes a component identified by uid and rid from the cal_cache. When the rid is %NULL, or an empty string, then removes the master object only, without any detached instance.

    Parameters

    • uid: string

      a UID of the component to remove

    • rid: string

      an optional Recurrence-ID to remove

    • customFlags: number

      custom flags for the component, not interpreted by the cal_cache

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether removing this component in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Removes components identified by uid and rid from the cal_cache in the ids list. When the rid is %NULL, or an empty string, then removes the master object only, without any detached instance. The custom_flags is used, if not %NULL, only if the offline_flag is %E_CACHE_IS_OFFLINE. Otherwise it's ignored. The length of the custom_flags should match the length of ids, when not %NULL.

    Parameters

    • ids: ComponentId[]

      a #GSList of components to remove

    • customFlags: number[]

      an optional #GSList of custom flags for the ids

    • offlineFlag: CacheOfflineFlag

      one of #ECacheOfflineFlag, whether removing these comonents in offline

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • removeTimezone(tzid: string, decRefCounts: number, cancellable: Gio.Cancellable): boolean
  • Dereferences use count of the time zone with ID tzid by dec_ref_counts and removes the timezone from the cache when the reference count reaches zero. Special case is with dec_ref_counts being zero, in which case the corresponding timezone is removed regardless of the current reference count.

    It's not an error when the timezone doesn't exist in the cache.

    Parameters

    • tzid: string

      timezone ID to remove/dereference

    • decRefCounts: number

      reference counts to drop, 0 to remove it regardless of the current reference count

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    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 the cal_cache with the given sexp and returns those components which satisfy the search expression as a #GSList of #ECalCacheSearchData. The out_data should be freed with g_slist_free_full (data, e_cal_cache_search_data_free); when no longer needed.

    Parameters

    • sexp: string

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, CalCacheSearchData[]]

  • Searches the cal_cache with the given sexp and returns those components which satisfy the search expression. The out_components should be freed with g_slist_free_full (components, g_object_unref); when no longer needed.

    Parameters

    • sexp: string

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ECal.Component[]]

  • Searches the cal_cache with the given sexp and returns ECalComponentId for those components which satisfy the search expression. The out_ids should be freed with g_slist_free_full (ids, (GDestroyNotify) e_cal_component_id_free); when no longer needed.

    Parameters

    • sexp: string

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns [boolean, ComponentId[]]

  • searchWithCallback(sexp: string, cancellable: Gio.Cancellable): boolean
  • Searches the cal_cache with the given sexp and calls func for each row which satisfy the search expression.

    Parameters

    • sexp: string

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

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • setComponentCustomFlags(uid: string, rid: string, customFlags: number, cancellable: Gio.Cancellable): boolean
  • Sets or replaces the custom flags associated with a component identified by uid and optionally rid.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • customFlags: number

      the custom flags to set for the component

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • setComponentExtra(uid: string, rid: string, extra: string, cancellable: Gio.Cancellable): boolean
  • Sets or replaces the extra data associated with a component identified by uid and optionally rid.

    Parameters

    • uid: string

      a UID of the component

    • rid: string

      an optional Recurrence-ID

    • extra: string

      extra data to set for the component

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    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

  • setKey(key: string, value: string): boolean
  • Sets a value of the user key, or deletes it, if the value is %NULL.

    Parameters

    • key: string

      a key name

    • value: string

      a value to set, or %NULL to delete the key

    Returns boolean

  • setKeyInt(key: string, value: number): boolean
  • Sets an integer value for the user key.

    Parameters

    • key: string

      a key name

    • value: number

      an integer value to set

    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

  • setRevision(revision: string): void
  • Sets the revision of the whole cache. This is not meant to be used by the descendants, because the revision is updated automatically when needed. The descendants can listen to "revision-changed" signal.

    Parameters

    • revision: string

      a revision to set; use %NULL to unset it

    Returns void

  • setVersion(version: number): void
  • Sets a cache data version. This is meant to be used by the descendants. The version should be greater than zero.

    Parameters

    • version: number

      a cache data version to set

    Returns void

  • Executes an SQLite statement. Use e_cache_sqlite_select() for SELECT statements.

    Parameters

    • sqlStmt: string

      an SQLite statement to execute

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Executes a SELECT statement sql_stmt and calls func for each row of the result. Use e_cache_sqlite_exec() for statements which do not return row sets.

    Parameters

    • sqlStmt: string

      an SQLite SELECT statement to execute

    • func: CacheSelectFunc

      an #ECacheSelectFunc function to call for each row

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • 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

  • thawRevisionChange(): void
  • Unlocks the cache which was previouly locked with e_cache_lock(). The cache locked with #E_CACHE_LOCK_WRITE should use either action #E_CACHE_UNLOCK_COMMIT or #E_CACHE_UNLOCK_ROLLBACK, while the #E_CACHE_LOCK_READ should use #E_CACHE_UNLOCK_NONE action.

    Parameters

    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

  • 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

  • An #ECalRecurResolveTimezoneCb callback, which can be used with e_cal_recur_generate_instances_sync(). The cal_cache is supposed to be an #ECalCache instance.

    Parameters

    • tzid: string

      a timezone ID

    • calCache: object

      an #ECalCache

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns ICalGLib.Timezone

  • sqliteStmtFree(stmt: string): void

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