Gjsify LogoGjsify Logo

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

cacheDir: string
connectable: SocketConnectable
gTypeInstance: TypeInstance
kind: number
mainContext: MainContext
online: boolean
proxyResolver: Gio.ProxyResolver
registry: SourceRegistry
userPrompter: UserPrompter
writable: boolean
name: string

Methods

  • Calls the add_timezone_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional tzobject: string

      VTIMEZONE object to be added.

    Returns void

  • 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

  • Asynchronously adds the timezone described by tzobject to backend.

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

    Parameters

    • tzobject: string

      an iCalendar VTIMEZONE string

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • addTimezoneSync(tzobject: string, cancellable: Gio.Cancellable): boolean
  • Adds the timezone described by tzobject to backend.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • tzobject: string

      an iCalendar VTIMEZONE string

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Adds a view to the list of live views being run by the given backend. Doing so means that any listener on the view will get notified of any change that affect the live view.

    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

  • connect(sigName: "notify::cache-dir", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::kind", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::registry", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::writable", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::connectable", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::main-context", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::online", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::source", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::user-prompter", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • createCacheFilename(uid: string, filename: string, fileindex: number): string
  • Finishes the operation started with e_cal_backend_create_objects().

    A unique ID string for each newly-created object is deposited in out_uids. Free the returned ID strings with g_free() when finished with them.

    If an error occurred, the function will set error and return %FALSE.

    Parameters

    Returns boolean

  • Creates one or more new iCalendar objects from calobjs, and deposits the unique ID string for each newly-created object in out_uids.

    Free the returned ID strings with g_free() when finished with them.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • calobjs: string

      a %NULL-terminated array of iCalendar strings

    • opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • outUids: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Asynchronously calls the e_backend_credentials_required_sync() on the backend, to inform clients that credentials are required.

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

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • credentialsRequiredFinish(result: AsyncResult): boolean
  • Synchronously lets the clients know that the backned requires credentials to be properly opened. It's a proxy function for e_source_invoke_credentials_required_sync(), where can be found more information about actual parameters meaning.

    The provided credentials are received through #EBackendClass.authenticate_sync() method asynchronously.

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

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Calls the discard_alarm_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional uid: string

      Unique id of the calendar object.

    • Optional rid: string

      Recurrence id of the calendar object.

    • Optional auid: string

      Alarm ID to remove.

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    Returns void

  • Asynchronously discards the VALARM object with a unique ID of alarm_uid from the iCalendar object identified by uid and, optionally, rid.

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

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • Optional rid: string

      a recurrence ID, or %NULL

    • Optional alarmUid: string

      a unique ID for an iCalendar VALARM object

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Discards the VALARM object with a unique ID of alarm_uid from the iCalendar object identified by uid and, optionally, rid.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • rid: string

      a recurrence ID, or %NULL

    • alarmUid: string

      a unique ID for an iCalendar VALARM object

    • opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • dupCacheDir(): string
  • Thread-safe variation of e_cal_backend_get_cache_dir(). Use this function when accessing backend from multiple threads.

    The returned string should be freed with g_free() when no longer needed.

    Returns string

  • emit(sigName: "notify::cache-dir", ...args: any[]): void
  • emit(sigName: "notify::kind", ...args: any[]): void
  • emit(sigName: "notify::proxy-resolver", ...args: any[]): void
  • emit(sigName: "notify::registry", ...args: any[]): void
  • emit(sigName: "notify::writable", ...args: any[]): void
  • emit(sigName: "notify::connectable", ...args: any[]): void
  • emit(sigName: "notify::main-context", ...args: any[]): void
  • emit(sigName: "notify::online", ...args: any[]): void
  • emit(sigName: "notify::source", ...args: any[]): void
  • emit(sigName: "notify::user-prompter", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Makes sure that the "online" property is updated, that is, if there is any destination reachability test pending, it'll be done immediately and the only state will be updated as well.

    Parameters

    Returns void

  • ensureSourceStatusConnected(): void
  • Makes sure that the associated ESource::connection-status is connected. This is useful in cases when the backend can connect to the destination without invoking #EBackendClass.authenticate_sync(), possibly through e_backend_schedule_authenticate().

    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

  • foreachView(): boolean
  • foreachViewNotifyProgress(onlyCompletedViews: boolean, percent: number, message: string): void
  • Notifies each view of the backend about progress. When only_completed_views is %TRUE, notifies only completed views.

    Parameters

    • onlyCompletedViews: boolean

      whether notify in completed views only

    • percent: number

      percent complete

    • message: string

      message describing the operation in progress, or %NULL

    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

  • Calls the get_attachment_uris_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional uid: string

      Unique id of the calendar object.

    • Optional rid: string

      Recurrence id of the calendar object.

    • Optional attachments: string[]

      Placeholder for list of returned attachment uris.

    Returns void

  • Asynchronously inspects the iCalendar object specified by uid and, optionally, rid for attachments.

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

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • Optional rid: string

      a recurrence ID, or %NULL

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the operation started with e_cal_backend_get_attachment_uris().

    The requested attachment URI strings are deposited in out_attachment_uris. Free the returned strings with g_free() when finished with them.

    If an error occurred, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • result: AsyncResult

      a #GAsyncResult

    • outAttachmentUris: GLib.Queue

      a #GQueue in which to deposit results

    Returns boolean

  • getAttachmentUrisSync(uid: string, rid: string, outAttachmentUris: GLib.Queue, cancellable: Gio.Cancellable): boolean
  • Inspects the iCalendar object specified by uid and, optionally, rid for attachments and deposits a URI string for each attachment in out_attachment_uris. Free the returned strings with g_free() when finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • rid: string

      a recurrence ID, or %NULL

    • outAttachmentUris: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • getBackendProperty(propName: string): string
  • Obtains the value of the backend property named prop_name. Freed the returned string with g_free() when finished with it.

    Parameters

    • propName: string

      a backend property name

    Returns string

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

  • getDestinationAddress(): [boolean, string, number]
  • Provides destination server host name and port to which the backend connects. This is used to determine required connection point for e_backend_is_destination_reachable(). The host is a newly allocated string, which will be freed with g_free(). When backend sets both host and port, then it should return %TRUE, indicating it's a remote backend. Default implementation returns %FALSE, which is treated like the backend is local, no checking for server reachability is possible.

    Returns [boolean, string, number]

  • Calls the get_free_busy_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional users: string[]

      List of users to get F/B info from.

    • Optional start: number

      Time range start.

    • Optional end: number

      Time range end.

    Returns string[]

  • Asynchronously obtains a free/busy object for the list of users in the time interval between start and end.

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

    Parameters

    • start: number

      start time

    • Optional end: number

      end time

    • Optional users: string[]

      a %NULL-terminated array of user strings

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • getFreeBusyFinish(result: AsyncResult, outFreebusy: string[]): boolean
  • Finishes the operation started with e_cal_backend_get_free_busy().

    The free/busy results can be returned through the e_data_cal_report_free_busy_data() function asynchronously. The out_freebusy will contain all the returned data, possibly again, thus the client is responsible for the data merge, if needed.

    If an error occurred, the function will set error and return %FALSE.

    Parameters

    • result: AsyncResult

      a #GAsyncResult

    • outFreebusy: string[]

      iCalendar strings with overall returned Free/Busy data

    Returns boolean

  • getFreeBusySync(start: number, end: number, users: string[], outFreebusy: string[], cancellable: Gio.Cancellable): boolean
  • Obtains a free/busy object for the list of users in the time interval between start and end.

    The free/busy results can be returned through the e_data_cal_report_free_busy_data() function asynchronously. The out_freebusy will contain all the returned data, possibly again, thus the client is responsible for the data merge, if needed.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • start: number

      start time

    • end: number

      end time

    • users: string[]

      a %NULL-terminated array of user strings

    • outFreebusy: string[]

      iCalendar strings with overall returned Free/Busy data

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • Calls the get_object_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional uid: string

      UID of the object to get.

    • Optional rid: string

      Recurrence ID of the specific instance to get, or %NULL if getting the master object.

    Returns string

  • Asynchronously obtains an #ECalComponent by its uid and, optionally, rid.

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

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • Optional rid: string

      a recurrence ID, or %NULL

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the operation started with e_cal_backend_get_object().

    The returned string is an iCalendar object describing either single component or a vCalendar object, which includes also detached instances. It should be freed when no longer needed.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    Returns string

  • Calls the get_object_list_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional sexp: string

      Search query.

    Returns string[]

  • Asynchronously obtains a set of iCalendar instances which satisfy the criteria specified in query.

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

    Parameters

    • query: string

      a search query in S-expression format

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the operation started with e_cal_backend_get_object_list().

    The matching iCalendar instances are deposited in out_objects. The returned instances should be freed with g_free() when finished with them.

    If an error occurred, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    Returns boolean

  • Obtains a set of iCalendar string instances which satisfy the criteria specified in query, and deposits them in out_objects.

    The returned instances should be freed with g_free() when finished with them.

    If an error occurs, the function will set error and return %FALSE. Note that an empty result set does not necessarily imply an error.

    Parameters

    • query: string

      a search query in S-expression format

    • outObjects: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns boolean

  • getObjectSync(uid: string, rid: string, cancellable: Gio.Cancellable): string
  • Obtains an iCalendar string for an object identified by its uid and, optionally, rid.

    The returned string should be freed with g_free() when finished with it.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    • uid: string

      a unique ID for an iCalendar object

    • rid: string

      a recurrence ID, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns string

  • getOnline(): boolean
  • Returns the online state of backend: %TRUE if backend is online, %FALSE if offline.

    If the #EBackend:connectable property is non-%NULL, the backend will automatically determine whether the network service should be reachable, and hence whether the backend is #EBackend:online. But subclasses may override the online state if, for example, a connection attempt fails.

    Returns boolean

  • 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

  • Calls the get_timezone_sync method on the given backend. This method is not mandatory on the backend, because here is used internal_get_timezone call to fetch timezone from it and that is transformed to a string. In other words, any object deriving from ECalBackendSync can implement only internal_get_timezone and can skip implementation of get_timezone_sync completely.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional tzid: string

      ID of the timezone to retrieve.

    • Optional tzobject: string

      Placeholder for the returned timezone.

    Returns void

  • 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

  • Asynchronously obtains the VTIMEZONE object identified by tzid.

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

    Parameters

    • tzid: string

      a unique ID for an iCalendar VTIMEZONE object

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the operation started with e_cal_backend_get_timezone().

    Free the returned string with g_free() when finished with it.

    If an error occurred, the function will set error and return %NULL.

    Parameters

    Returns string

  • Obtains the VTIMEZONE object identified by tzid. Free the returned string with g_free() when finished with it.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    • tzid: string

      a unique ID for an iCalendar VTIMEZONE object

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns string

  • getUserPrompter(): object
  • getWritable(): boolean
  • 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

  • Checks whether the backend<!-- -->'s destination server, as returned by e_backend_get_destination_address(), is reachable. If the e_backend_get_destination_address() returns %FALSE, this function returns %TRUE, meaning the destination is always reachable. This uses #GNetworkMonitor's g_network_monitor_can_reach() for reachability tests.

    Parameters

    Returns boolean

  • isFloating(): boolean
  • isOpened(): boolean
  • Checks if backend's storage has been opened (and authenticated, if necessary) and the backend itself is ready for accessing. This property is changed automatically after the backend is successfully opened.

    Returns boolean

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

  • Returns a list of #EDataCalView instances added with e_cal_backend_add_view().

    The views returned in the list are referenced for thread-safety. They must each be unreferenced with g_object_unref() when finished with them. Free the returned list itself with g_list_free().

    An easy way to free the list properly in one step is as follows:

    |[ g_list_free_full (list, g_object_unref);

    
    

    Returns DataCalView[]

  • Modifies one or more iCalendar objects according to calobjs and mod.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • calobjs: string

      a %NULL-terminated array of iCalendar strings

    • mod: ObjModType

      modification type for recurrences

    • opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    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

  • Notifies each of the backend's listeners about a new object.

    Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus.

    Parameters

    Returns void

  • Notifies each of the backend's listeners about a modified object.

    Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus.

    Parameters

    • oldComponent: ECal.Component

      the #ECalComponent before the modification

    • newComponent: ECal.Component

      the #ECalComponent after the modification

    Returns void

  • Notifies each of the backend's listeners about a removed object.

    Uses the #EDataCalView's fields-of-interest to filter out unwanted information from ical strings sent over the bus.

    Parameters

    • id: ComponentId

      the Id of the removed object

    • oldComponent: ECal.Component

      the removed component

    • newComponent: ECal.Component

      the component after the removal. This only applies to recurrent appointments that had an instance removed. In that case, this function notifies a modification instead of a removal.

    Returns void

  • notifyError(message: string): void
  • notifyPropertyChanged(propName: string, propValue: string): void
  • off(sigName: "notify::cache-dir", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::kind", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::registry", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::writable", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::connectable", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::main-context", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::online", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::source", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::user-prompter", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "notify::cache-dir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::kind", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::registry", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::writable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::connectable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::user-prompter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "notify::cache-dir", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::kind", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::proxy-resolver", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::registry", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::writable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::connectable", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::main-context", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::online", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::source", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::user-prompter", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Calls the open_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation or just create it when it does not exist.

    Returns void

  • Asynchronously "opens" the backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable.

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

    Parameters

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • "Opens" the backend. Opening a backend is something of an outdated concept, but the operation is hanging around for a little while longer. This usually involves some custom initialization logic, and testing of remote authentication if applicable.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    Returns boolean

  • Obtains the #GSimpleAsyncResult for opid and sets result_queue as a place to deposit results prior to completing the #GSimpleAsyncResult.

    This is a temporary function to serve #EDataCal's "respond" functions until they can be removed. Nothing else should be calling this function.

    Parameters

    • opid: number

      an operation ID given to #EDataCal

    • resultQueue: GLib.Queue

      return location for a #GQueue, or %NULL

    Returns SimpleAsyncResult

  • prepareShutdown(): void
  • Let's the backend know that it'll be shut down shortly, no client connects to it anymore. The backend can free any resources which reference it, for example the opened views.

    Returns void

  • Calls the receive_objects_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional calobj: string

      iCalendar object to receive.

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    Returns void

  • Asynchronously receives the set of iCalendar objects specified by calobj. This is used for iTIP confirmation and cancellation messages for scheduled meetings.

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

    Parameters

    • calobj: string

      an iCalendar string

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Receives the set of iCalendar objects specified by calobj. This is used for iTIP confirmation and cancellation messages for scheduled meetings.

    If an error occurs, the function will set error and return %FALSE.

    Parameters

    • calobj: string

      an iCalendar string

    • opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • 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

  • Returns the socket endpoint for the network service to which backend is a client, or %NULL if backend does not use network sockets.

    The initial value of the #EBackend:connectable property is derived from the #ESourceAuthentication extension of the backend's #EBackend:source property, if the extension is present.

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

    Returns SocketConnectable

  • Returns the #EDataCal for backend. The #EDataCal is essentially the glue between incoming D-Bus requests and backend's native API.

    An #EDataCal should be set only once after backend is first created. If an #EDataCal has not yet been set, the function returns %NULL.

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

    Returns DataCal

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

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

    Returns MainContext

  • Returns the #GProxyResolver for backend (if applicable), as indicated by the #ESourceAuthentication:proxy-uid of backend's #EBackend:source or one of its ancestors.

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

    Returns Gio.ProxyResolver

  • 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

  • Calls the refresh_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    Returns void

  • Asynchronously initiates a refresh for backend, if the backend supports refreshing. The actual refresh operation completes on its own time. This function, along with e_cal_backend_refresh_finish(), merely initiates the operation.

    Once the refresh is initiated, callback will be called. You can then call e_cal_backend_refresh_finish() to get the result of the initiation.

    Parameters

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the refresh initiation started with e_cal_backend_refresh().

    If an error occurred while initiating the refresh, the function will set error and return %FALSE. If the backend does not support refreshing, the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %FALSE.

    Parameters

    Returns boolean

  • Initiates a refresh for backend, if the backend supports refreshing. The actual refresh operation completes on its own time. This function merely initiates the operation.

    If an error occrs while initiating the refresh, the function will set error and return %FALSE. If the backend does not support refreshing, the function will set an %E_CLIENT_ERROR_NOT_SUPPORTED error and return %FALSE.

    Parameters

    Returns boolean

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • Schedules a new authenticate session, cancelling any previously run. This is usually done automatically, when an 'authenticate' signal is received for the associated #ESource. With %NULL credentials an attempt without it is run.

    Parameters

    • credentials: NamedParameters

      a credentials to use to authenticate, or %NULL

    Returns void

  • Asynchronously invokes e_backend_credentials_required(), but installs its own callback which only prints a runtime warning on the console when the call fails. The who_calls is a prefix of the console message. This is useful when the caller just wants to start the operation without having actual place where to show the operation result.

    Parameters

    • reason: SourceCredentialsReason

      an #ESourceCredentialsReason, why the credentials are required

    • certificatePem: string

      PEM-encoded secure connection certificate, or an empty string

    • certificateErrors: TlsCertificateFlags

      a bit-or of #GTlsCertificateFlags for secure connection certificate

    • opError: GLib.Error

      a #GError with a description of the previous credentials error, or %NULL

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • whoCalls: string

      an identification who calls this

    Returns void

  • Schedules user function func to be run in a dedicated thread as a blocking operation.

    The function adds its own reference to use_cancellable, if not %NULL.

    The error returned from func is propagated to client using e_cal_backend_notify_error() function. If it's not desired, then left the error unchanged and notify about errors manually.

    Parameters

    Returns void

  • Calls the send_objects_sync method on the given backend.

    Parameters

    • cal: DataCal

      An EDataCal object.

    • Optional cancellable: Gio.Cancellable

      a #GCancellable for the operation

    • Optional calobj: string

      The iCalendar object to send.

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • Optional users: string[]

      List of users to send notifications to.

    Returns string

  • Asynchronously sends meeting information in calobj. The backend may modify calobj and send meeting information only to particular users.

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

    Parameters

    • calobj: string

      an iCalendar string

    • Optional opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • Optional callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    Returns void

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    Returns any

  • Finishes the operation started with e_cal_backend_send_objects().

    The function returns a string representation of a sent, or to be send, vCalendar and deposits the list of users the meeting information was sent to, or to be send to, in out_users.

    Free the returned pointer with g_free(), when no longer needed.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    Returns string

  • Sends meeting information in calobj. The backend may modify calobj and send meeting information only to particular users. The function returns the (maybe) modified calobj and deposits the list of users the meeting information was sent (to be send) to in out_users.

    The returned pointer should be freed with g_free(), when no londer needed.

    If an error occurs, the function will set error and return %NULL.

    Parameters

    • calobj: string

      an iCalendar string

    • opflags: ECal.OperationFlags

      bit-or of #ECalOperationFlags

    • outUsers: GLib.Queue

      a #GQueue in which to deposit results

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    Returns string

  • setCacheDir(cacheDir: string): void
  • Sets the cache directory path for use by backend.

    Note that #ECalBackend is initialized with a default cache directory path which should suffice for most cases. Backends should not override the default path without good reason.

    Parameters

    • cacheDir: string

      a local cache directory path

    Returns void

  • Sets the socket endpoint for the network service to which backend is a client. This can be %NULL if backend does not use network sockets.

    The initial value of the #EBackend:connectable property is derived from the #ESourceAuthentication extension of the backend's #EBackend:source property, if the extension is present.

    Parameters

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

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

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

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • Sets the #EDataCal for backend. The #EDataCal is essentially the glue between incoming D-Bus requests and backend's native API.

    An #EDataCal should be set only once after backend is first created.

    The backend adds its own reference on the data_cal.

    Parameters

    Returns void

  • setOnline(online: boolean): void
  • Sets the online state of backend: %TRUE if backend is online, FALSE if offline.

    If the #EBackend:connectable property is non-%NULL, the backend will automatically determine whether the network service should be reachable, and hence whether the backend is #EBackend:online. But subclasses may override the online state if, for example, a connection attempt fails.

    Parameters

    • online: boolean

      the online state

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • setWritable(writable: boolean): 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

  • Initiates a user trust prompt with given parameters.

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

    Parameters

    • parameters: NamedParameters

      an #ENamedParameters with values for the trust prompt

    • cancellable: Gio.Cancellable

      optional #GCancellable object, or %NULL

    • callback: AsyncReadyCallback

      a #GAsyncReadyCallback to call when the request is satisfied

    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
  • 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[]

  • mailAccountGetDefault(registry: SourceRegistry, address: string, name: string): boolean
  • mailAccountIsValid(registry: SourceRegistry, user: string, name: string): boolean
  • 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