Client

---

Object Hierarchy:

Description:

Content:

Properties:

• public Timezone default_timezone { get; set; }
• public ClientSourceType source_type { get; construct; }

Static methods:

• public static bool check_timezones_sync (Component vcalendar, SList<Component>? icalcomps, RecurResolveTimezoneCb? tzlookup, Cancellable? cancellable = null) throws Error
  This function cleans up VEVENT, VJOURNAL, VTODO and VTIMEZONE items which are to be imported into Evolution.
• public static async Client? connect (Source source, ClientSourceType source_type, uint32 wait_for_connected_seconds, Cancellable? cancellable) throws Error
  Asynchronously creates a new Client for source and source_type.
• public static Client? connect_sync (Source source, ClientSourceType source_type, uint32 wait_for_connected_seconds, Cancellable? cancellable = null) throws Error
  Creates a new Client for source and source_type.
• public static Error error_create (ClientError code, string? custom_msg)
• public static Quark error_quark ()
• public static unowned string error_to_string (ClientError code)
  Get localized human readable description of the given error code.
• public static unowned Timezone? tzlookup_cb (string tzid, Client ecalclient, Cancellable? cancellable = null) throws Error
  An implementation of the RecurResolveTimezoneCb callback which clients can use.
• public static unowned Timezone? tzlookup_icalcomp_cb (string tzid, ClientTzlookupICalCompData lookup_data, Cancellable? cancellable = null) throws Error
  An implementation of the RecurResolveTimezoneCb callback which backends can use.

Creation methods:

• protected Client ()

Methods:

• public async bool add_timezone (Timezone zone, Cancellable? cancellable) throws Error
  Add a VTIMEZONE object to the given calendar client.
• public bool add_timezone_sync (Timezone zone, Cancellable? cancellable = null) throws Error
  Add a VTIMEZONE object to the given calendar client.
• public bool check_one_alarm_only ()
  Checks if a calendar supports only one alarm per component.
• public bool check_organizer_must_accept ()
  Checks whether a calendar requires organizer to accept their attendance to meetings.
• public bool check_organizer_must_attend ()
  Checks if a calendar forces organizers of meetings to be also attendees.
• public bool check_recurrences_no_master ()
  Checks if the calendar has a master object for recurrences.
• public bool check_save_schedules ()
  Checks whether the calendar saves schedules.
• public async bool create_object (Component icalcomp, OperationFlags opflags, Cancellable? cancellable, out string? out_uid) throws Error
  Requests the calendar backend to create the object specified by the icalcomp argument.
• public bool create_object_sync (Component icalcomp, OperationFlags opflags, out string? out_uid, Cancellable? cancellable = null) throws Error
  Requests the calendar backend to create the object specified by the icalcomp argument.
• public async bool create_objects (SList<Component> icalcomps, OperationFlags opflags, Cancellable? cancellable, out SList<string> out_uids) throws Error
  Requests the calendar backend to create the objects specified by the icalcomps argument.
• public bool create_objects_sync (SList<Component> icalcomps, OperationFlags opflags, out SList<string> out_uids, Cancellable? cancellable = null) throws Error
  Requests the calendar backend to create the objects specified by the icalcomps argument.
• public async bool discard_alarm (string uid, string? rid, string auid, OperationFlags opflags, Cancellable? cancellable) throws Error
  Discards alarm auid from a given component identified by uid and rid.
• public bool discard_alarm_sync (string uid, string? rid, string auid, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Discards alarm auid from a given component identified by uid and rid.
• public void generate_instances (long start, long end, Cancellable? cancellable, owned RecurInstanceCb cb)
  Does a combination of get_object_list and recur_generate_instances_sync.
• public void generate_instances_for_object (Component icalcomp, long start, long end, Cancellable? cancellable, owned RecurInstanceCb cb)
  Does a combination of get_object_list and recur_generate_instances_sync, like generate_instances, but for a single object.
• public void generate_instances_for_object_sync (Component icalcomp, long start, long end, Cancellable? cancellable, RecurInstanceCb cb)
  Does a combination of get_object_list and recur_generate_instances_sync, like generate_instances_sync, but for a single object.
• public void generate_instances_for_uid_sync (string uid, long start, long end, Cancellable? cancellable, RecurInstanceCb cb)
  Does a combination of get_object_list and recur_generate_instances_sync, like generate_instances_sync, but for a single object.
• public void generate_instances_sync (long start, long end, Cancellable? cancellable, RecurInstanceCb cb)
  Does a combination of get_object_list and recur_generate_instances_sync.
• public async bool get_attachment_uris (string uid, string? rid, Cancellable? cancellable, out SList<string> out_attachment_uris) throws Error
  Queries a calendar for a specified component's object attachment uris.
• public bool get_attachment_uris_sync (string uid, string? rid, out SList<string> out_attachment_uris, Cancellable? cancellable = null) throws Error
  Queries a calendar for a specified component's object attachment URIs.
• public string? get_component_as_string (Component icalcomp)
  Gets a calendar component as an iCalendar string, with a toplevel VCALENDAR component and all VTIMEZONEs needed for the component.
• public async bool get_default_object (Cancellable? cancellable, out Component out_icalcomp) throws Error
  Retrives an Component from the backend that contains the default values for properties needed.
• public bool get_default_object_sync (out Component out_icalcomp, Cancellable? cancellable = null) throws Error
  Retrives an Component from the backend that contains the default values for properties needed.
• public unowned Timezone get_default_timezone ()
  Returns the default timezone previously set with set_default_timezone.
• public async bool get_free_busy (long start, long end, SList<string> users, Cancellable? cancellable, out SList<Component> out_freebusy) throws Error
  Begins retrieval of free/busy information from the calendar server as a list of Component-s.
• public bool get_free_busy_sync (long start, long end, SList<string> users, out SList<Component> out_freebusy, Cancellable? cancellable = null) throws Error
  Gets free/busy information from the calendar server.
• public unowned string get_local_attachment_store ()
  Queries the URL where the calendar attachments are serialized in the local filesystem.
• public async bool get_object (string uid, string? rid, Cancellable? cancellable, out Component out_icalcomp) throws Error
  Queries a calendar for a calendar component object based on its unique identifier.
• public async bool get_object_list (string sexp, Cancellable? cancellable, out SList<Component> out_icalcomps) throws Error
  Gets a list of objects from the calendar that match the query specified by the sexp argument, returning matching objects as a list of Component -s.
• public async bool get_object_list_as_comps (string sexp, Cancellable? cancellable, out SList<Component> out_ecalcomps) throws Error
  Gets a list of objects from the calendar that match the query specified by the sexp argument, returning matching objects as a list of Component -s.
• public bool get_object_list_as_comps_sync (string sexp, out SList<Component> out_ecalcomps, Cancellable? cancellable = null) throws Error
  Gets a list of objects from the calendar that match the query specified by the sexp argument.
• public bool get_object_list_sync (string sexp, out SList<Component> out_icalcomps, Cancellable? cancellable = null) throws Error
  Gets a list of objects from the calendar that match the query specified by the sexp argument.
• public bool get_object_sync (string uid, string? rid, out Component out_icalcomp, Cancellable? cancellable = null) throws Error
  Queries a calendar for a calendar component object based on its unique identifier.
• public async bool get_objects_for_uid (string uid, Cancellable? cancellable, out SList<Component> out_ecalcomps) throws Error
  Queries a calendar for all calendar components with the given unique ID.
• public bool get_objects_for_uid_sync (string uid, out SList<Component> out_ecalcomps, Cancellable? cancellable = null) throws Error
  Queries a calendar for all calendar components with the given unique ID.
• public ClientSourceType get_source_type ()
  Gets the source type of the calendar client.
• public async bool get_timezone (string tzid, Cancellable? cancellable, out unowned Timezone out_zone) throws Error
  Retrieves a timezone object from the calendar backend.
• public bool get_timezone_sync (string tzid, out unowned Timezone out_zone, Cancellable? cancellable = null) throws Error
  Retrieves a timezone object from the calendar backend.
• public async bool get_view (string sexp, Cancellable? cancellable, out ClientView out_view) throws Error
  Query this with sexp, creating an ClientView.
• public bool get_view_sync (string sexp, out ClientView out_view, Cancellable? cancellable = null) throws Error
  Query this with sexp, creating an ClientView.
• public async bool modify_object (Component icalcomp, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  Requests the calendar backend to modify an existing object.
• public bool modify_object_sync (Component icalcomp, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Requests the calendar backend to modify an existing object.
• public async bool modify_objects (SList<Component> icalcomps, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  Requests the calendar backend to modify existing objects.
• public bool modify_objects_sync (SList<Component> icalcomps, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Requests the calendar backend to modify existing objects.
• public async bool receive_objects (Component icalcomp, OperationFlags opflags, Cancellable? cancellable) throws Error
  Makes the backend receive the set of iCalendar objects specified in the icalcomp argument.
• public bool receive_objects_sync (Component icalcomp, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  Makes the backend receive the set of iCalendar objects specified in the icalcomp argument.
• public async bool remove_object (string uid, string? rid, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  This function allows the removal of instances of a recurrent appointment.
• public bool remove_object_sync (string uid, string? rid, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  This function allows the removal of instances of a recurrent appointment.
• public async bool remove_objects (SList<ComponentId> ids, ObjModType mod, OperationFlags opflags, Cancellable? cancellable) throws Error
  This function allows the removal of instances of recurrent appointments.
• public bool remove_objects_sync (SList<ComponentId> ids, ObjModType mod, OperationFlags opflags, Cancellable? cancellable = null) throws Error
  This function allows the removal of instances of recurrent appointments.
• public async bool send_objects (Component icalcomp, OperationFlags opflags, Cancellable? cancellable, out SList<string> out_users, out Component out_modified_icalcomp) throws Error
  Requests a calendar backend to send meeting information stored in icalcomp.
• public bool send_objects_sync (Component icalcomp, OperationFlags opflags, out SList<string> out_users, out Component out_modified_icalcomp, Cancellable? cancellable = null) throws Error
  Requests a calendar backend to send meeting information stored in icalcomp.
• public void set_default_timezone (Timezone zone)
  Sets the default timezone to use to resolve DATE and floating DATE-TIME values.

Signals:

• public signal void free_busy_data (SList<Component> free_busy_ecalcomps)

Inherited Members: