<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<refentry id="ECalBackend">
<refmeta>
<refentrytitle role="top_of_page" id="ECalBackend.top_of_page">ECalBackend</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBEDATA-CAL Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>ECalBackend</refname>
<refpurpose>Base class for calendar/tasks backend implementations.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="ECalBackend.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
<link linkend="ESource">ESource</link>*            <link linkend="e-cal-backend-get-source">e_cal_backend_get_source</link>            (<link linkend="ECalBackend">ECalBackend</link> *backend);
const <link linkend="char">char</link>*         <link linkend="e-cal-backend-get-uri">e_cal_backend_get_uri</link>               (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="icalcomponent-kind">icalcomponent_kind</link>  <link linkend="e-cal-backend-get-kind">e_cal_backend_get_kind</link>              (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-add-client">e_cal_backend_add_client</link>            (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-remove-client">e_cal_backend_remove_client</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-add-query">e_cal_backend_add_query</link>             (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);
<link linkend="EList">EList</link>*              <link linkend="e-cal-backend-get-queries">e_cal_backend_get_queries</link>           (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-remove-query">e_cal_backend_remove_query</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);
<link linkend="void">void</link>                <link linkend="e-cal-backend-is-read-only">e_cal_backend_is_read_only</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-cal-address">e_cal_backend_get_cal_address</link>       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-alarm-email-address">e_cal_backend_get_alarm_email_address</link>
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-ldap-attribute">e_cal_backend_get_ldap_attribute</link>    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-static-capabilities">e_cal_backend_get_static_capabilities</link>
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-open">e_cal_backend_open</link>                  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         <link linkend="gboolean">gboolean</link> only_if_exists,
                                                         const <link linkend="char">char</link> *username,
                                                         const <link linkend="char">char</link> *password);
<link linkend="void">void</link>                <link linkend="e-cal-backend-remove">e_cal_backend_remove</link>                (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-create-object">e_cal_backend_create_object</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);
<link linkend="void">void</link>                <link linkend="e-cal-backend-modify-object">e_cal_backend_modify_object</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj,
                                                         <link linkend="CalObjModType">CalObjModType</link> mod);
<link linkend="void">void</link>                <link linkend="e-cal-backend-remove-object">e_cal_backend_remove_object</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid,
                                                         <link linkend="CalObjModType">CalObjModType</link> mod);
<link linkend="void">void</link>                <link linkend="e-cal-backend-discard-alarm">e_cal_backend_discard_alarm</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *auid);
<link linkend="void">void</link>                <link linkend="e-cal-backend-receive-objects">e_cal_backend_receive_objects</link>       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);
<link linkend="void">void</link>                <link linkend="e-cal-backend-send-objects">e_cal_backend_send_objects</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-default-object">e_cal_backend_get_default_object</link>    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-object">e_cal_backend_get_object</link>            (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-object-list">e_cal_backend_get_object_list</link>       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *sexp);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-attachment-list">e_cal_backend_get_attachment_list</link>   (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid);
<link linkend="gboolean">gboolean</link>            <link linkend="e-cal-backend-is-loaded">e_cal_backend_is_loaded</link>             (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-start-query">e_cal_backend_start_query</link>           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);
<link linkend="CalMode">CalMode</link>             <link linkend="e-cal-backend-get-mode">e_cal_backend_get_mode</link>              (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-set-mode">e_cal_backend_set_mode</link>              (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="CalMode">CalMode</link> mode);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-timezone">e_cal_backend_get_timezone</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzid);
<link linkend="void">void</link>                <link linkend="e-cal-backend-add-timezone">e_cal_backend_add_timezone</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *object);
<link linkend="void">void</link>                <link linkend="e-cal-backend-set-default-timezone">e_cal_backend_set_default_timezone</link>  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzid);
<link linkend="void">void</link>                <link linkend="e-cal-backend-set-default-zone">e_cal_backend_set_default_zone</link>      (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzobj);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-changes">e_cal_backend_get_changes</link>           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *change_id);
<link linkend="void">void</link>                <link linkend="e-cal-backend-get-free-busy">e_cal_backend_get_free_busy</link>         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         <link linkend="GList">GList</link> *users,
                                                         <link linkend="time-t">time_t</link> start,
                                                         <link linkend="time-t">time_t</link> end);
<link linkend="icaltimezone">icaltimezone</link>*       <link linkend="e-cal-backend-internal-get-default-timezone">e_cal_backend_internal_get_default_timezone</link>
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="icaltimezone">icaltimezone</link>*       <link linkend="e-cal-backend-internal-get-timezone">e_cal_backend_internal_get_timezone</link> (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *tzid);
<link linkend="void">void</link>                <link linkend="e-cal-backend-last-client-gone">e_cal_backend_last_client_gone</link>      (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-set-notification-proxy">e_cal_backend_set_notification_proxy</link>
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="ECalBackend">ECalBackend</link> *proxy);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-object-created">e_cal_backend_notify_object_created</link> (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *calobj);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-object-modified">e_cal_backend_notify_object_modified</link>
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *old_object,
                                                         const <link linkend="char">char</link> *object);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-object-removed">e_cal_backend_notify_object_removed</link> (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="ECalComponentId">ECalComponentId</link> *id,
                                                         const <link linkend="char">char</link> *old_object,
                                                         const <link linkend="char">char</link> *object);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-mode">e_cal_backend_notify_mode</link>           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="GNOME-Evolution-Calendar-CalListener-SetModeStatus">GNOME_Evolution_Calendar_CalListener_SetModeStatus</link> status,
                                                         <link linkend="GNOME-Evolution-Calendar-CalMode">GNOME_Evolution_Calendar_CalMode</link> mode);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-auth-required">e_cal_backend_notify_auth_required</link>  (<link linkend="ECalBackend">ECalBackend</link> *backend);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-error">e_cal_backend_notify_error</link>          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *message);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-view-done">e_cal_backend_notify_view_done</link>      (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="GNOME-Evolution-Calendar-CallStatus">GNOME_Evolution_Calendar_CallStatus</link> status);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-view-progress">e_cal_backend_notify_view_progress</link>  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *message,
                                                         <link linkend="int">int</link> percent);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-readonly">e_cal_backend_notify_readonly</link>       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="gboolean">gboolean</link> read_only);
<link linkend="void">void</link>                <link linkend="e-cal-backend-notify-cal-address">e_cal_backend_notify_cal_address</link>    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="char">char</link> *address);
</synopsis>
</refsynopsisdiv>









<refsect1 id="ECalBackend.description" role="desc">
<title role="desc.title">Description</title>
<para>

</para>
</refsect1>

<refsect1 id="ECalBackend.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="e-cal-backend-get-source" role="function">
<title>e_cal_backend_get_source ()</title>
<indexterm zone="e-cal-backend-get-source"><primary>e_cal_backend_get_source</primary></indexterm><programlisting><link linkend="ESource">ESource</link>*            e_cal_backend_get_source            (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Gets the <link linkend="ESource"><type>ESource</type></link> associated with the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The <link linkend="ESource"><type>ESource</type></link> for the backend.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-uri" role="function">
<title>e_cal_backend_get_uri ()</title>
<indexterm zone="e-cal-backend-get-uri"><primary>e_cal_backend_get_uri</primary></indexterm><programlisting>const <link linkend="char">char</link>*         e_cal_backend_get_uri               (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Queries the URI of a calendar backend, which must already have an open
calendar.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The URI where the calendar is stored.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-kind" role="function">
<title>e_cal_backend_get_kind ()</title>
<indexterm zone="e-cal-backend-get-kind"><primary>e_cal_backend_get_kind</primary></indexterm><programlisting><link linkend="icalcomponent-kind">icalcomponent_kind</link>  e_cal_backend_get_kind              (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Gets the kind of components the given backend stores.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The kind of components for this backend.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-add-client" role="function">
<title>e_cal_backend_add_client ()</title>
<indexterm zone="e-cal-backend-add-client"><primary>e_cal_backend_add_client</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_add_client            (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Adds a new client to the given backend. For any event, the backend will
notify all clients added via this function.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An ECalBackend object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An EDataCal object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-remove-client" role="function">
<title>e_cal_backend_remove_client ()</title>
<indexterm zone="e-cal-backend-remove-client"><primary>e_cal_backend_remove_client</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_remove_client         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Removes a client from the list of connected clients to the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-add-query" role="function">
<title>e_cal_backend_add_query ()</title>
<indexterm zone="e-cal-backend-add-query"><primary>e_cal_backend_add_query</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_add_query             (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);</programlisting>
<para>
Adds a query to the list of live queries being run by the given backend.
Doing so means that any listener on the query will get notified of any
change that affect the live query.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCalView"><type>EDataCalView</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-queries" role="function">
<title>e_cal_backend_get_queries ()</title>
<indexterm zone="e-cal-backend-get-queries"><primary>e_cal_backend_get_queries</primary></indexterm><programlisting><link linkend="EList">EList</link>*              e_cal_backend_get_queries           (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Gets the list of live queries being run on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The list of live queries.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-remove-query" role="function">
<title>e_cal_backend_remove_query ()</title>
<indexterm zone="e-cal-backend-remove-query"><primary>e_cal_backend_remove_query</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_remove_query          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);</programlisting>
<para>
Removes query from the list of live queries for the backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCalView"><type>EDataCalView</type></link> object, previously added with <parameter>ref</parameter> e_cal_backend_add_query.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-is-read-only" role="function">
<title>e_cal_backend_is_read_only ()</title>
<indexterm zone="e-cal-backend-is-read-only"><primary>e_cal_backend_is_read_only</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_is_read_only          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Queries whether a calendar backend is read only or not.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-cal-address" role="function">
<title>e_cal_backend_get_cal_address ()</title>
<indexterm zone="e-cal-backend-get-cal-address"><primary>e_cal_backend_get_cal_address</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_cal_address       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Queries the cal address associated with a calendar backend, which
must already have an open calendar.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-alarm-email-address" role="function">
<title>e_cal_backend_get_alarm_email_address ()</title>
<indexterm zone="e-cal-backend-get-alarm-email-address"><primary>e_cal_backend_get_alarm_email_address</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_alarm_email_address
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Calls the get_static_capabilities method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="ECalBackend"><type>ECalBackend</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-ldap-attribute" role="function">
<title>e_cal_backend_get_ldap_attribute ()</title>
<indexterm zone="e-cal-backend-get-ldap-attribute"><primary>e_cal_backend_get_ldap_attribute</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_ldap_attribute    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-static-capabilities" role="function">
<title>e_cal_backend_get_static_capabilities ()</title>
<indexterm zone="e-cal-backend-get-static-capabilities"><primary>e_cal_backend_get_static_capabilities</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_static_capabilities
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-open" role="function">
<title>e_cal_backend_open ()</title>
<indexterm zone="e-cal-backend-open"><primary>e_cal_backend_open</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_open                  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         <link linkend="gboolean">gboolean</link> only_if_exists,
                                                         const <link linkend="char">char</link> *username,
                                                         const <link linkend="char">char</link> *password);</programlisting>
<para>
Opens a calendar backend with data from a calendar stored at the specified
URI.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>only_if_exists</parameter>&nbsp;:</term>
<listitem><simpara> Whether the calendar should be opened only if it already
exists.  If FALSE, a new calendar will be created when the specified <parameter>uri</parameter>
does not exist.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>username</parameter>&nbsp;:</term>
<listitem><simpara> User name to use for authentication (if needed).
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter>&nbsp;:</term>
<listitem><simpara> Password for <parameter>username</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-remove" role="function">
<title>e_cal_backend_remove ()</title>
<indexterm zone="e-cal-backend-remove"><primary>e_cal_backend_remove</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_remove                (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Removes the calendar being accessed by the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-create-object" role="function">
<title>e_cal_backend_create_object ()</title>
<indexterm zone="e-cal-backend-create-object"><primary>e_cal_backend_create_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_create_object         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);</programlisting>
<para>
Calls the create_object method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>calobj</parameter>&nbsp;:</term>
<listitem><simpara> The object to create.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-modify-object" role="function">
<title>e_cal_backend_modify_object ()</title>
<indexterm zone="e-cal-backend-modify-object"><primary>e_cal_backend_modify_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_modify_object         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj,
                                                         <link linkend="CalObjModType">CalObjModType</link> mod);</programlisting>
<para>
Calls the modify_object method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>calobj</parameter>&nbsp;:</term>
<listitem><simpara> Object to be modified.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mod</parameter>&nbsp;:</term>
<listitem><simpara> Type of modification.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-remove-object" role="function">
<title>e_cal_backend_remove_object ()</title>
<indexterm zone="e-cal-backend-remove-object"><primary>e_cal_backend_remove_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_remove_object         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid,
                                                         <link linkend="CalObjModType">CalObjModType</link> mod);</programlisting>
<para>
Removes an object in a calendar backend.  The backend will notify all of its
clients about the change.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> Unique identifier of the object to remove.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rid</parameter>&nbsp;:</term>
<listitem><simpara> A recurrence ID.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mod</parameter>&nbsp;:</term>
<listitem><simpara> Type of removal.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-discard-alarm" role="function">
<title>e_cal_backend_discard_alarm ()</title>
<indexterm zone="e-cal-backend-discard-alarm"><primary>e_cal_backend_discard_alarm</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_discard_alarm         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *auid);</programlisting>
<para>
Discards an alarm from the given component. This allows the specific backend
to do whatever is needed to really discard the alarm.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> UID of the component to discard the alarm from.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>auid</parameter>&nbsp;:</term>
<listitem><simpara> Alarm ID.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-receive-objects" role="function">
<title>e_cal_backend_receive_objects ()</title>
<indexterm zone="e-cal-backend-receive-objects"><primary>e_cal_backend_receive_objects</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_receive_objects       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);</programlisting>
<para>
Calls the receive_objects method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>calobj</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-send-objects" role="function">
<title>e_cal_backend_send_objects ()</title>
<indexterm zone="e-cal-backend-send-objects"><primary>e_cal_backend_send_objects</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_send_objects          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *calobj);</programlisting>
<para>
Calls the send_objects method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>calobj</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar object to be sent.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-default-object" role="function">
<title>e_cal_backend_get_default_object ()</title>
<indexterm zone="e-cal-backend-get-default-object"><primary>e_cal_backend_get_default_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_default_object    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal);</programlisting>
<para>
Calls the get_default_object method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-object" role="function">
<title>e_cal_backend_get_object ()</title>
<indexterm zone="e-cal-backend-get-object"><primary>e_cal_backend_get_object</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_object            (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid);</programlisting>
<para>
Queries a calendar backend for a calendar object based on its unique
identifier and its recurrence ID (if a recurrent appointment).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> Unique identifier for a calendar object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rid</parameter>&nbsp;:</term>
<listitem><simpara> ID for the object's recurrence to get.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-object-list" role="function">
<title>e_cal_backend_get_object_list ()</title>
<indexterm zone="e-cal-backend-get-object-list"><primary>e_cal_backend_get_object_list</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_object_list       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *sexp);</programlisting>
<para>
Calls the get_object_list method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>sexp</parameter>&nbsp;:</term>
<listitem><simpara> Expression to search for.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-attachment-list" role="function">
<title>e_cal_backend_get_attachment_list ()</title>
<indexterm zone="e-cal-backend-get-attachment-list"><primary>e_cal_backend_get_attachment_list</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_attachment_list   (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *uid,
                                                         const <link linkend="char">char</link> *rid);</programlisting>
<para>
Queries a calendar backend for attachments present in a calendar object based
on its unique identifier and its recurrence ID (if a recurrent appointment).</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>uid</parameter>&nbsp;:</term>
<listitem><simpara> Unique identifier for a calendar object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>rid</parameter>&nbsp;:</term>
<listitem><simpara> ID for the object's recurrence to get.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-is-loaded" role="function">
<title>e_cal_backend_is_loaded ()</title>
<indexterm zone="e-cal-backend-is-loaded"><primary>e_cal_backend_is_loaded</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            e_cal_backend_is_loaded             (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Queries whether a calendar backend has been loaded yet.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> TRUE if the backend has been loaded with data, FALSE
otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-start-query" role="function">
<title>e_cal_backend_start_query ()</title>
<indexterm zone="e-cal-backend-start-query"><primary>e_cal_backend_start_query</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_start_query           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCalView">EDataCalView</link> *query);</programlisting>
<para>
Starts a new live query on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
<listitem><simpara> The query to be started.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-mode" role="function">
<title>e_cal_backend_get_mode ()</title>
<indexterm zone="e-cal-backend-get-mode"><primary>e_cal_backend_get_mode</primary></indexterm><programlisting><link linkend="CalMode">CalMode</link>             e_cal_backend_get_mode              (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Queries whether a calendar backend is connected remotely.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> The current mode the calendar is in
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-set-mode" role="function">
<title>e_cal_backend_set_mode ()</title>
<indexterm zone="e-cal-backend-set-mode"><primary>e_cal_backend_set_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_set_mode              (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="CalMode">CalMode</link> mode);</programlisting>
<para>
Sets the mode of the calendar</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter>&nbsp;:</term>
<listitem><simpara> Mode to change to
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-timezone" role="function">
<title>e_cal_backend_get_timezone ()</title>
<indexterm zone="e-cal-backend-get-timezone"><primary>e_cal_backend_get_timezone</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_timezone          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzid);</programlisting>
<para>
</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tzid</parameter>&nbsp;:</term>
<listitem><simpara> Unique identifier of a VTIMEZONE object. Note that this must not be
NULL.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-add-timezone" role="function">
<title>e_cal_backend_add_timezone ()</title>
<indexterm zone="e-cal-backend-add-timezone"><primary>e_cal_backend_add_timezone</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_add_timezone          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *object);</programlisting>
<para>
Add a timezone object to the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-set-default-timezone" role="function">
<title>e_cal_backend_set_default_timezone ()</title>
<indexterm zone="e-cal-backend-set-default-timezone"><primary>e_cal_backend_set_default_timezone</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_set_default_timezone  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzid);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tzid</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-set-default-zone" role="function">
<title>e_cal_backend_set_default_zone ()</title>
<indexterm zone="e-cal-backend-set-default-zone"><primary>e_cal_backend_set_default_zone</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_set_default_zone      (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *tzobj);</programlisting>
<para>
Sets the default timezone for the calendar, which is used to resolve
DATE and floating DATE-TIME values.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tzobj</parameter>&nbsp;:</term>
<listitem><simpara> The timezone object, in a string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-changes" role="function">
<title>e_cal_backend_get_changes ()</title>
<indexterm zone="e-cal-backend-get-changes"><primary>e_cal_backend_get_changes</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_changes           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         const <link linkend="char">char</link> *change_id);</programlisting>
<para>
Builds a sequence of objects and the type of change that occurred on them since
the last time the give change_id was seen</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>change_id</parameter>&nbsp;:</term>
<listitem><simpara> A unique uid for the callers change list
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-get-free-busy" role="function">
<title>e_cal_backend_get_free_busy ()</title>
<indexterm zone="e-cal-backend-get-free-busy"><primary>e_cal_backend_get_free_busy</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_get_free_busy         (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="EDataCal">EDataCal</link> *cal,
                                                         <link linkend="GList">GList</link> *users,
                                                         <link linkend="time-t">time_t</link> start,
                                                         <link linkend="time-t">time_t</link> end);</programlisting>
<para>
Gets a free/busy object for the given time interval</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>cal</parameter>&nbsp;:</term>
<listitem><simpara> An <link linkend="EDataCal"><type>EDataCal</type></link> object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>users</parameter>&nbsp;:</term>
<listitem><simpara> List of users to get free/busy information for.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>start</parameter>&nbsp;:</term>
<listitem><simpara> Start time for query.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>end</parameter>&nbsp;:</term>
<listitem><simpara> End time for query.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-internal-get-default-timezone" role="function">
<title>e_cal_backend_internal_get_default_timezone ()</title>
<indexterm zone="e-cal-backend-internal-get-default-timezone"><primary>e_cal_backend_internal_get_default_timezone</primary></indexterm><programlisting><link linkend="icaltimezone">icaltimezone</link>*       e_cal_backend_internal_get_default_timezone
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Calls the internal_get_default_timezone method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-internal-get-timezone" role="function">
<title>e_cal_backend_internal_get_timezone ()</title>
<indexterm zone="e-cal-backend-internal-get-timezone"><primary>e_cal_backend_internal_get_timezone</primary></indexterm><programlisting><link linkend="icaltimezone">icaltimezone</link>*       e_cal_backend_internal_get_timezone (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *tzid);</programlisting>
<para>
Calls the internal_get_timezone method on the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>tzid</parameter>&nbsp;:</term>
<listitem><simpara> ID of the timezone to get.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-last-client-gone" role="function">
<title>e_cal_backend_last_client_gone ()</title>
<indexterm zone="e-cal-backend-last-client-gone"><primary>e_cal_backend_last_client_gone</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_last_client_gone      (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-set-notification-proxy" role="function">
<title>e_cal_backend_set_notification_proxy ()</title>
<indexterm zone="e-cal-backend-set-notification-proxy"><primary>e_cal_backend_set_notification_proxy</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_set_notification_proxy
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="ECalBackend">ECalBackend</link> *proxy);</programlisting>
<para>
Sets the backend that will act as notification proxy for the given backend.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>proxy</parameter>&nbsp;:</term>
<listitem><simpara> The calendar backend to act as notification proxy.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-object-created" role="function">
<title>e_cal_backend_notify_object_created ()</title>
<indexterm zone="e-cal-backend-notify-object-created"><primary>e_cal_backend_notify_object_created</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_object_created (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *calobj);</programlisting>
<para>
Notifies each of the backend's listeners about a new object.
</para>
<para>
#<link linkend="e-data-cal-notify-object-created"><function>e_data_cal_notify_object_created()</function></link> calls this for you. You only need to
call <link linkend="e-cal-backend-notify-object-created"><function>e_cal_backend_notify_object_created()</function></link> yourself to report objects
created by non-EDS clients.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>calobj</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar representation of new object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-object-modified" role="function">
<title>e_cal_backend_notify_object_modified ()</title>
<indexterm zone="e-cal-backend-notify-object-modified"><primary>e_cal_backend_notify_object_modified</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_object_modified
                                                        (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *old_object,
                                                         const <link linkend="char">char</link> *object);</programlisting>
<para>
Notifies each of the backend's listeners about a modified object.
</para>
<para>
#<link linkend="e-data-cal-notify-object-modified"><function>e_data_cal_notify_object_modified()</function></link> calls this for you. You only need to
call <link linkend="e-cal-backend-notify-object-modified"><function>e_cal_backend_notify_object_modified()</function></link> yourself to report objects
modified by non-EDS clients.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>old_object</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar representation of the original form of the object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar representation of the new form of the object
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-object-removed" role="function">
<title>e_cal_backend_notify_object_removed ()</title>
<indexterm zone="e-cal-backend-notify-object-removed"><primary>e_cal_backend_notify_object_removed</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_object_removed (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="ECalComponentId">ECalComponentId</link> *id,
                                                         const <link linkend="char">char</link> *old_object,
                                                         const <link linkend="char">char</link> *object);</programlisting>
<para>
Notifies each of the backend's listeners about a removed object.
</para>
<para>
<link linkend="e-data-cal-notify-object-removed"><function>e_data_cal_notify_object_removed()</function></link> calls this for you. You only need to
call <link linkend="e-cal-backend-notify-object-removed"><function>e_cal_backend_notify_object_removed()</function></link> yourself to report objects
removed by non-EDS clients.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>id</parameter>&nbsp;:</term>
<listitem><simpara> the Id of the removed object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>old_object</parameter>&nbsp;:</term>
<listitem><simpara> iCalendar representation of the removed object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>object</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-mode" role="function">
<title>e_cal_backend_notify_mode ()</title>
<indexterm zone="e-cal-backend-notify-mode"><primary>e_cal_backend_notify_mode</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_mode           (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="GNOME-Evolution-Calendar-CalListener-SetModeStatus">GNOME_Evolution_Calendar_CalListener_SetModeStatus</link> status,
                                                         <link linkend="GNOME-Evolution-Calendar-CalMode">GNOME_Evolution_Calendar_CalMode</link> mode);</programlisting>
<para>
Notifies each of the backend's listeners about the results of a
setMode call.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
<listitem><simpara> Status of the mode set
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>mode</parameter>&nbsp;:</term>
<listitem><simpara> the current mode
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-auth-required" role="function">
<title>e_cal_backend_notify_auth_required ()</title>
<indexterm zone="e-cal-backend-notify-auth-required"><primary>e_cal_backend_notify_auth_required</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_auth_required  (<link linkend="ECalBackend">ECalBackend</link> *backend);</programlisting>
<para>
Notifies each of the backend's listeners that authentication is required to
open the calendar.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-error" role="function">
<title>e_cal_backend_notify_error ()</title>
<indexterm zone="e-cal-backend-notify-error"><primary>e_cal_backend_notify_error</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_error          (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *message);</programlisting>
<para>
Notifies each of the backend's listeners about an error</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
<listitem><simpara> Error message
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-view-done" role="function">
<title>e_cal_backend_notify_view_done ()</title>
<indexterm zone="e-cal-backend-notify-view-done"><primary>e_cal_backend_notify_view_done</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_view_done      (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="GNOME-Evolution-Calendar-CallStatus">GNOME_Evolution_Calendar_CallStatus</link> status);</programlisting>
<para>
Notifies each of the backend's listeners about the view_done in downloading the items.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>status</parameter>&nbsp;:</term>
<listitem><simpara> returns the status once the view is fully populated.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-view-progress" role="function">
<title>e_cal_backend_notify_view_progress ()</title>
<indexterm zone="e-cal-backend-notify-view-progress"><primary>e_cal_backend_notify_view_progress</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_view_progress  (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         const <link linkend="char">char</link> *message,
                                                         <link linkend="int">int</link> percent);</programlisting>
<para>
Notifies each of the backend's listeners about the view_progress in downloading the items.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara> A calendar backend.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>message</parameter>&nbsp;:</term>
<listitem><simpara> the UID of the removed object
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>percent</parameter>&nbsp;:</term>
<listitem><simpara> percentage of the objects loaded in the view
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-readonly" role="function">
<title>e_cal_backend_notify_readonly ()</title>
<indexterm zone="e-cal-backend-notify-readonly"><primary>e_cal_backend_notify_readonly</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_readonly       (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="gboolean">gboolean</link> read_only);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>read_only</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="e-cal-backend-notify-cal-address" role="function">
<title>e_cal_backend_notify_cal_address ()</title>
<indexterm zone="e-cal-backend-notify-cal-address"><primary>e_cal_backend_notify_cal_address</primary></indexterm><programlisting><link linkend="void">void</link>                e_cal_backend_notify_cal_address    (<link linkend="ECalBackend">ECalBackend</link> *backend,
                                                         <link linkend="char">char</link> *address);</programlisting>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>backend</parameter>&nbsp;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>address</parameter>&nbsp;:</term>
<listitem><simpara>


</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
