CalBackend

---

Object Hierarchy:

Description:

Content:

Properties:

• public string cache_dir { get; set; }
  The backend's cache directory
• public ulong kind { get; construct; }
  The kind of iCalendar components this backend manages
• public ProxyResolver proxy_resolver { owned get; }
  The proxy resolver for this backend
• public SourceRegistry registry { get; construct; }
  Data source registry
• public bool writable { get; set; }
  Whether the backend will accept changes

Static methods:

• public static bool mail_account_get_default (SourceRegistry registry, string address, string name)
  Retrieve the default mail account as stored in Evolution configuration.
• public static bool mail_account_is_valid (SourceRegistry registry, string user, string name)
  Checks that a mail account is valid, and returns its name.
• public static bool user_declined (SourceRegistry registry, Component icalcomp)

Creation methods:

• protected CalBackend ()

Methods:

• public async bool add_timezone (string tzobject, Cancellable? cancellable) throws Error
  Asynchronously adds the timezone described by tzobject to this.
• public bool add_timezone_sync (string tzobject, Cancellable? cancellable = null) throws Error
  Adds the timezone described by tzobject to this.
• public void add_view (DataCalView view)
  Adds a view to the list of live views being run by the given backend.
• public string create_cache_filename (string uid, string? filename, int fileindex)
• public async bool create_objects (string calobjs, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously creates one or more new iCalendar objects from calobjs.
• public bool create_objects_sync (string calobjs, OperationFlags opflags, Queue out_uids, Cancellable? cancellable = null) throws Error
  Creates one or more new iCalendar objects from calobjs, and deposits the unique ID string for each newly-created object in out_uids.
• public async bool discard_alarm (string uid, string? rid, string alarm_uid, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously discards the VALARM object with a unique ID of alarm_uid from the iCalendar object identified by uid and, optionally, rid.
• public bool discard_alarm_sync (string uid, string? rid, string alarm_uid, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Discards the VALARM object with a unique ID of alarm_uid from the iCalendar object identified by uid and, optionally, rid.
• public string dup_cache_dir ()
  Thread-safe variation of get_cache_dir.
• public bool foreach_view (CalBackendForeachViewFunc func)
  Calls func for each existing view (as returned by list_views).
• public void foreach_view_notify_progress (bool only_completed_views, int percent, string? message)
  Notifies each view of the this about progress.
• public async bool get_attachment_uris (string uid, string? rid, Cancellable? cancellable) throws Error
  Asynchronously inspects the iCalendar object specified by uid and, optionally, rid for attachments.
• public bool get_attachment_uris_sync (string uid, string? rid, Queue out_attachment_uris, Cancellable? cancellable = null) throws Error
  Inspects the iCalendar object specified by uid and, optionally, rid for attachments and deposits a URI string for each attachment in out_attachment_uris.
• public string get_backend_property (string prop_name)
  Obtains the value of the backend property named prop_name .
• public unowned string get_cache_dir ()
  Returns the cache directory path used by this.
• public async bool get_free_busy (time_t start, time_t end, string[] users, Cancellable? cancellable) throws Error
  Asynchronously obtains a free/busy object for the list of users in the time interval between start and end.
• public bool get_free_busy_sync (time_t start, time_t end, string[] users, SList<string> out_freebusy, Cancellable? cancellable = null) throws Error
  Obtains a free/busy object for the list of users in the time interval between start and end.
• public ComponentKind get_kind ()
  Gets the kind of components the given backend stores.
• public async string get_object (string uid, string? rid, Cancellable? cancellable) throws Error
  Asynchronously obtains an Component by its uid and, optionally, rid.
• public async bool get_object_list (string query, Cancellable? cancellable) throws Error
  Asynchronously obtains a set of iCalendar instances which satisfy the criteria specified in query.
• public bool get_object_list_sync (string query, Queue out_objects, Cancellable? cancellable = null) throws Error
  Obtains a set of iCalendar string instances which satisfy the criteria specified in query, and deposits them in out_objects.
• public string get_object_sync (string uid, string? rid, Cancellable? cancellable = null) throws Error
  Obtains an iCalendar string for an object identified by its uid and, optionally, rid.
• public unowned SourceRegistry get_registry ()
  Returns the data source registry to which source belongs.
• public async string get_timezone (string tzid, Cancellable? cancellable) throws Error
  Asynchronously obtains the VTIMEZONE object identified by tzid .
• public string get_timezone_sync (string tzid, Cancellable? cancellable = null) throws Error
  Obtains the VTIMEZONE object identified by tzid.
• public bool get_writable ()
  Returns whether this will accept changes to its data content.
• public virtual void impl_add_timezone (DataCal cal, uint32 opid, Cancellable? cancellable, string tzobject)
  FIXME: Document me
• public virtual void impl_discard_alarm (DataCal cal, uint32 opid, Cancellable? cancellable, string uid, string rid, string auid, OperationFlags opflags)
  FIXME: Document me
• public virtual void impl_get_attachment_uris (DataCal cal, uint32 opid, Cancellable? cancellable, string uid, string rid)
  FIXME: Document me
• public virtual string impl_get_backend_property (string prop_name)
  Fetch a property value by name from the backend
• public virtual void impl_get_object (DataCal cal, uint32 opid, Cancellable? cancellable, string uid, string rid)
  Fetch a calendar object
• public virtual void impl_get_object_list (DataCal cal, uint32 opid, Cancellable? cancellable, string sexp)
  FIXME: Document me
• public virtual void impl_get_timezone (DataCal cal, uint32 opid, Cancellable? cancellable, string tzid)
  FIXME: Document me
• public virtual void impl_open (DataCal cal, uint32 opid, Cancellable? cancellable = null)
  Open the backend
• public virtual void impl_receive_objects (DataCal cal, uint32 opid, Cancellable? cancellable, string calobj, OperationFlags opflags)
  FIXME: Document me
• public virtual void impl_refresh (DataCal cal, uint32 opid, Cancellable? cancellable = null)
  Refresh the backend
• public virtual void impl_send_objects (DataCal cal, uint32 opid, Cancellable? cancellable, string calobj, OperationFlags opflags)
  FIXME: Document me
• public virtual void impl_start_view (DataCalView view)
  Start up the specified view
• public virtual void impl_stop_view (DataCalView view)
  Stop the specified view
• public bool is_opened ()
  Checks if this's storage has been opened (and authenticated, if necessary) and the backend itself is ready for accessing.
• public bool is_readonly ()
• public List<DataCalView> list_views ()
  Returns a list of DataCalView instances added with add_view.
• public async bool modify_objects (string calobjs, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously modifies one or more iCalendar objects according to calobjs and mod.
• public bool modify_objects_sync (string calobjs, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Modifies one or more iCalendar objects according to calobjs and mod.
• public void notify_component_created (Component component)
  Notifies each of the backend's listeners about a new object.
• public void notify_component_modified (Component old_component, Component new_component)
  Notifies each of the backend's listeners about a modified object.
• public void notify_component_removed (ComponentId id, Component old_component, Component new_component)
  Notifies each of the backend's listeners about a removed object.
• public void notify_error (string message)
  Notifies each of the backend's listeners about an error
• public void notify_property_changed (string prop_name, string? prop_value)
  Notifies client about property value change.
• public async bool open (Cancellable? cancellable) throws Error
  Asynchronously "opens" the this.
• public bool open_sync (Cancellable? cancellable = null) throws Error
  "Opens" the this.
• public Task prepare_for_completion (uint opid)
  Obtains the Task for opid.
• public async bool receive_objects (string calobj, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously receives the set of iCalendar objects specified by calobj.
• public bool receive_objects_sync (string calobj, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Receives the set of iCalendar objects specified by calobj .
• public DataCal? ref_data_cal ()
  Returns the DataCal for this.
• public ProxyResolver? ref_proxy_resolver ()
  Returns the ProxyResolver for this (if applicable), as indicated by the proxy_uid of this's source or one of its ancestors.
• public async bool refresh (Cancellable? cancellable) throws Error
  Asynchronously initiates a refresh for this , if the this supports refreshing.
• public bool refresh_sync (Cancellable? cancellable = null) throws Error
  Initiates a refresh for this, if the this supports refreshing.
• public async bool remove_objects (List<ComponentId> component_ids, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously removes one or more iCalendar objects according to component_ids and mod.
• public bool remove_objects_sync (List<ComponentId> component_ids, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Removes one or more iCalendar objects according to component_ids and mod.
• public void remove_view (DataCalView view)
  Removes view from the list of live views for the backend.
• public void schedule_custom_operation (Cancellable? use_cancellable, owned CalBackendCustomOpFunc func)
  Schedules user function func to be run in a dedicated thread as a blocking operation.
• public async string send_objects (string calobj, OperationFlags opflags, Cancellable? cancellable) throws Error
  Asynchronously sends meeting information in calobj.
• public string send_objects_sync (string calobj, OperationFlags opflags, Queue out_users, Cancellable? cancellable = null) throws Error
  Sends meeting information in calobj.
• public void set_cache_dir (string cache_dir)
  Sets the cache directory path for use by this.
• public void set_data_cal (DataCal data_cal)
  Sets the DataCal for this.
• public void set_writable (bool writable)
  Sets whether this will accept changes to its data content.
• public void start_view (DataCalView view)
  Starts a new live view on the given backend.
• public void stop_view (DataCalView view)
  Stops a previously started live view on the given backend.

Signals:

• public virtual signal void closed (string sender)
  Emitted when a client destroys its Client for backend
• public virtual signal void shutdown ()
  Emitted when the last client destroys its Client for backend.

Inherited Members: