2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
4
<refentry id="EBookBackend">
6
<refentrytitle role="top_of_page" id="EBookBackend.top_of_page">EBookBackend</refentrytitle>
7
<manvolnum>3</manvolnum>
13
<refname>EBookBackend</refname>
14
<refpurpose></refpurpose>
17
<refsynopsisdiv id="EBookBackend.synopsis" role="synopsis">
18
<title role="synopsis.title">Synopsis</title>
20
<synopsis>struct <link linkend="EBookBackend-struct">EBookBackend</link>;
21
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-construct">e_book_backend_construct</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
22
<link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link> <link linkend="e-book-backend-load-source">e_book_backend_load_source</link>
23
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
24
<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
25
<parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);
26
<link linkend="ESource"><returnvalue>ESource</returnvalue></link> * <link linkend="e-book-backend-get-source">e_book_backend_get_source</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
27
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-add-client">e_book_backend_add_client</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
28
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
29
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-remove-client">e_book_backend_remove_client</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
30
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
31
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-has-out-of-proc-clients">e_book_backend_has_out_of_proc_clients</link>
32
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
33
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> * <link linkend="e-book-backend-get-static-capabilities">e_book_backend_get_static_capabilities</link>
34
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
35
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-is-loaded">e_book_backend_is_loaded</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
36
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-is-writable">e_book_backend_is_writable</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
37
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> <link linkend="e-book-backend-is-removed">e_book_backend_is_removed</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
38
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-open">e_book_backend_open</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
39
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
40
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
41
<parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);
42
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-remove">e_book_backend_remove</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
43
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
44
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
45
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-create-contact">e_book_backend_create_contact</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
46
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
47
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
48
<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
49
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-remove-contacts">e_book_backend_remove_contacts</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
50
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
51
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
52
<parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>);
53
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-modify-contact">e_book_backend_modify_contact</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
54
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
55
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
56
<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
57
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-contact">e_book_backend_get_contact</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
58
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
59
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
60
<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
61
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-contact-list">e_book_backend_get_contact_list</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
62
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
63
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
64
<parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);
65
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-changes">e_book_backend_get_changes</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
66
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
67
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
68
<parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>);
69
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-authenticate-user">e_book_backend_authenticate_user</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
70
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
71
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
72
<parameter>const <link linkend="gchar"><type>gchar</type></link> *user</parameter>,
73
<parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
74
<parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);
75
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-supported-fields">e_book_backend_get_supported_fields</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
76
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
77
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
78
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-required-fields">e_book_backend_get_required_fields</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
79
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
80
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
81
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-get-supported-auth-methods">e_book_backend_get_supported_auth_methods</link>
82
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
83
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
84
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
85
<link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link> <link linkend="e-book-backend-cancel-operation">e_book_backend_cancel_operation</link>
86
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
87
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);
88
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-set-mode">e_book_backend_set_mode</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
89
<parameter><link linkend="GNOME-Evolution-Addressbook-BookMode"><type>GNOME_Evolution_Addressbook_BookMode</type></link> mode</parameter>);
90
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-start-book-view">e_book_backend_start_book_view</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
91
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
92
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-stop-book-view">e_book_backend_stop_book_view</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
93
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
94
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-add-book-view">e_book_backend_add_book_view</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
95
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
96
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-remove-book-view">e_book_backend_remove_book_view</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
97
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);
98
<link linkend="EList"><returnvalue>EList</returnvalue></link> * <link linkend="e-book-backend-get-book-views">e_book_backend_get_book_views</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
99
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-update">e_book_backend_notify_update</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
100
<parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);
101
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-remove">e_book_backend_notify_remove</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
102
<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
103
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-complete">e_book_backend_notify_complete</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
104
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-writable">e_book_backend_notify_writable</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
105
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);
106
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-connection-status">e_book_backend_notify_connection_status</link>
107
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
108
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_online</parameter>);
109
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-notify-auth-required">e_book_backend_notify_auth_required</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
110
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-sync">e_book_backend_sync</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);
111
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-set-is-loaded">e_book_backend_set_is_loaded</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
112
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_loaded</parameter>);
113
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-set-is-writable">e_book_backend_set_is_writable</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
114
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);
115
<link linkend="void"><returnvalue>void</returnvalue></link> <link linkend="e-book-backend-set-is-removed">e_book_backend_set_is_removed</link> (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
116
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_removed</parameter>);
117
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-add-new">e_book_backend_change_add_new</link>
118
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
119
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-modify-new">e_book_backend_change_modify_new</link>
120
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);
121
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* <link linkend="e-book-backend-change-delete-new">e_book_backend_change_delete_new</link>
122
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);
123
struct <link linkend="EBookBackendClass">EBookBackendClass</link>;
126
<refsect1 id="EBookBackend.object-hierarchy" role="object_hierarchy">
127
<title role="object_hierarchy.title">Object Hierarchy</title>
129
<link linkend="GObject">GObject</link>
131
+----<link linkend="EBookBackendSync">EBookBackendSync</link>
134
<refsect1 id="EBookBackend.signals" role="signal_proto">
135
<title role="signal_proto.title">Signals</title>
137
"<link linkend="EBookBackend-last-client-gone">last-client-gone</link>" : Run First
141
<refsect1 id="EBookBackend.description" role="desc">
142
<title role="desc.title">Description</title>
146
<refsect1 id="EBookBackend.details" role="details">
147
<title role="details.title">Details</title>
148
<refsect2 id="EBookBackend-struct" role="struct">
149
<title>struct EBookBackend</title>
150
<indexterm zone="EBookBackend-struct"><primary>EBookBackend</primary></indexterm>
151
<programlisting>struct EBookBackend;</programlisting>
154
<refsect2 id="e-book-backend-construct" role="function">
155
<title>e_book_backend_construct ()</title>
156
<indexterm zone="e-book-backend-construct"><primary>e_book_backend_construct</primary></indexterm>
157
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_construct (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
160
<variablelist role="params">
161
<varlistentry><term><parameter>backend</parameter> :</term>
162
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
163
</simpara></listitem></varlistentry>
164
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
165
</simpara></listitem></varlistentry>
166
</variablelist></refsect2>
167
<refsect2 id="e-book-backend-load-source" role="function">
168
<title>e_book_backend_load_source ()</title>
169
<indexterm zone="e-book-backend-load-source"><primary>e_book_backend_load_source</primary></indexterm>
170
<programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link> e_book_backend_load_source
171
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
172
<parameter><link linkend="ESource"><type>ESource</type></link> *source</parameter>,
173
<parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);</programlisting>
175
Loads <parameter>source</parameter> into <parameter>backend</parameter>.</para>
176
<variablelist role="params">
177
<varlistentry><term><parameter>backend</parameter> :</term>
178
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
179
</simpara></listitem></varlistentry>
180
<varlistentry><term><parameter>source</parameter> :</term>
181
<listitem><simpara>an <link linkend="ESource"><type>ESource</type></link> to load
182
</simpara></listitem></varlistentry>
183
<varlistentry><term><parameter>only_if_exists</parameter> :</term>
184
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
185
</simpara></listitem></varlistentry>
186
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A <link linkend="GNOME-Evolution-Addressbook-CallStatus"><type>GNOME_Evolution_Addressbook_CallStatus</type></link> indicating the outcome.
187
</simpara></listitem></varlistentry>
188
</variablelist></refsect2>
189
<refsect2 id="e-book-backend-get-source" role="function">
190
<title>e_book_backend_get_source ()</title>
191
<indexterm zone="e-book-backend-get-source"><primary>e_book_backend_get_source</primary></indexterm>
192
<programlisting><link linkend="ESource"><returnvalue>ESource</returnvalue></link> * e_book_backend_get_source (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
194
Queries the source that an addressbook backend is serving.</para>
195
<variablelist role="params">
196
<varlistentry><term><parameter>backend</parameter> :</term>
197
<listitem><simpara>An addressbook backend.
198
</simpara></listitem></varlistentry>
199
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> ESource for the backend.
200
</simpara></listitem></varlistentry>
201
</variablelist></refsect2>
202
<refsect2 id="e-book-backend-add-client" role="function">
203
<title>e_book_backend_add_client ()</title>
204
<indexterm zone="e-book-backend-add-client"><primary>e_book_backend_add_client</primary></indexterm>
205
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_add_client (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
206
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
208
Adds a client to an addressbook backend.</para>
209
<variablelist role="params">
210
<varlistentry><term><parameter>backend</parameter> :</term>
211
<listitem><simpara>An addressbook backend.
212
</simpara></listitem></varlistentry>
213
<varlistentry><term><parameter>book</parameter> :</term>
214
<listitem><simpara>the corba object representing the client connection.
215
</simpara></listitem></varlistentry>
216
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE on success, FALSE on failure to add the client.
217
</simpara></listitem></varlistentry>
218
</variablelist></refsect2>
219
<refsect2 id="e-book-backend-remove-client" role="function">
220
<title>e_book_backend_remove_client ()</title>
221
<indexterm zone="e-book-backend-remove-client"><primary>e_book_backend_remove_client</primary></indexterm>
222
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_remove_client (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
223
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
225
Removes <parameter>book</parameter> from the list of <parameter>backend</parameter>'s clients.</para>
226
<variablelist role="params">
227
<varlistentry><term><parameter>backend</parameter> :</term>
228
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
229
</simpara></listitem></varlistentry>
230
<varlistentry><term><parameter>book</parameter> :</term>
231
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link> to remove
232
</simpara></listitem></varlistentry>
233
</variablelist></refsect2>
234
<refsect2 id="e-book-backend-has-out-of-proc-clients" role="function">
235
<title>e_book_backend_has_out_of_proc_clients ()</title>
236
<indexterm zone="e-book-backend-has-out-of-proc-clients"><primary>e_book_backend_has_out_of_proc_clients</primary></indexterm>
237
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_has_out_of_proc_clients
238
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
240
Checks if <parameter>backend</parameter> has clients running in other system processes.</para>
241
<variablelist role="params">
242
<varlistentry><term><parameter>backend</parameter> :</term>
243
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
244
</simpara></listitem></varlistentry>
245
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if there are clients in other processes, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
246
</simpara></listitem></varlistentry>
247
</variablelist></refsect2>
248
<refsect2 id="e-book-backend-get-static-capabilities" role="function">
249
<title>e_book_backend_get_static_capabilities ()</title>
250
<indexterm zone="e-book-backend-get-static-capabilities"><primary>e_book_backend_get_static_capabilities</primary></indexterm>
251
<programlisting><link linkend="gchar"><returnvalue>gchar</returnvalue></link> * e_book_backend_get_static_capabilities
252
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
254
Gets the capabilities offered by this <parameter>backend</parameter>.</para>
255
<variablelist role="params">
256
<varlistentry><term><parameter>backend</parameter> :</term>
257
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
258
</simpara></listitem></varlistentry>
259
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A string listing the capabilities.
260
</simpara></listitem></varlistentry>
261
</variablelist></refsect2>
262
<refsect2 id="e-book-backend-is-loaded" role="function">
263
<title>e_book_backend_is_loaded ()</title>
264
<indexterm zone="e-book-backend-is-loaded"><primary>e_book_backend_is_loaded</primary></indexterm>
265
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_is_loaded (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
267
Checks if <parameter>backend</parameter>'s storage has been opened and the backend
268
itself is ready for accessing.</para>
269
<variablelist role="params">
270
<varlistentry><term><parameter>backend</parameter> :</term>
271
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
272
</simpara></listitem></varlistentry>
273
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if loaded, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
274
</simpara></listitem></varlistentry>
275
</variablelist></refsect2>
276
<refsect2 id="e-book-backend-is-writable" role="function">
277
<title>e_book_backend_is_writable ()</title>
278
<indexterm zone="e-book-backend-is-writable"><primary>e_book_backend_is_writable</primary></indexterm>
279
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_is_writable (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
281
Checks if we can write to <parameter>backend</parameter>.</para>
282
<variablelist role="params">
283
<varlistentry><term><parameter>backend</parameter> :</term>
284
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
285
</simpara></listitem></varlistentry>
286
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if writeable, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
287
</simpara></listitem></varlistentry>
288
</variablelist></refsect2>
289
<refsect2 id="e-book-backend-is-removed" role="function">
290
<title>e_book_backend_is_removed ()</title>
291
<indexterm zone="e-book-backend-is-removed"><primary>e_book_backend_is_removed</primary></indexterm>
292
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link> e_book_backend_is_removed (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
294
Checks if <parameter>backend</parameter> has been removed from its physical storage.</para>
295
<variablelist role="params">
296
<varlistentry><term><parameter>backend</parameter> :</term>
297
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
298
</simpara></listitem></varlistentry>
299
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>backend</parameter> has been removed, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> otherwise.
300
</simpara></listitem></varlistentry>
301
</variablelist></refsect2>
302
<refsect2 id="e-book-backend-open" role="function">
303
<title>e_book_backend_open ()</title>
304
<indexterm zone="e-book-backend-open"><primary>e_book_backend_open</primary></indexterm>
305
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_open (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
306
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
307
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
308
<parameter><link linkend="gboolean"><type>gboolean</type></link> only_if_exists</parameter>);</programlisting>
310
Executes an 'open' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
311
using <parameter>backend</parameter>.</para>
312
<variablelist role="params">
313
<varlistentry><term><parameter>backend</parameter> :</term>
314
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
315
</simpara></listitem></varlistentry>
316
<varlistentry><term><parameter>book</parameter> :</term>
317
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
318
</simpara></listitem></varlistentry>
319
<varlistentry><term><parameter>opid</parameter> :</term>
320
<listitem><simpara>the ID to use for this operation
321
</simpara></listitem></varlistentry>
322
<varlistentry><term><parameter>only_if_exists</parameter> :</term>
323
<listitem><simpara><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to prevent the creation of a new book
324
</simpara></listitem></varlistentry>
325
</variablelist></refsect2>
326
<refsect2 id="e-book-backend-remove" role="function">
327
<title>e_book_backend_remove ()</title>
328
<indexterm zone="e-book-backend-remove"><primary>e_book_backend_remove</primary></indexterm>
329
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_remove (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
330
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
331
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
333
Executes a 'remove' request to remove all of <parameter>backend</parameter>'s data,
334
specified by <parameter>opid</parameter> on <parameter>book</parameter>.</para>
335
<variablelist role="params">
336
<varlistentry><term><parameter>backend</parameter> :</term>
337
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
338
</simpara></listitem></varlistentry>
339
<varlistentry><term><parameter>book</parameter> :</term>
340
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
341
</simpara></listitem></varlistentry>
342
<varlistentry><term><parameter>opid</parameter> :</term>
343
<listitem><simpara>the ID to use for this operation
344
</simpara></listitem></varlistentry>
345
</variablelist></refsect2>
346
<refsect2 id="e-book-backend-create-contact" role="function">
347
<title>e_book_backend_create_contact ()</title>
348
<indexterm zone="e-book-backend-create-contact"><primary>e_book_backend_create_contact</primary></indexterm>
349
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_create_contact (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
350
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
351
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
352
<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
354
Executes a 'create contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
355
using <parameter>backend</parameter>.</para>
356
<variablelist role="params">
357
<varlistentry><term><parameter>backend</parameter> :</term>
358
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
359
</simpara></listitem></varlistentry>
360
<varlistentry><term><parameter>book</parameter> :</term>
361
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
362
</simpara></listitem></varlistentry>
363
<varlistentry><term><parameter>opid</parameter> :</term>
364
<listitem><simpara>the ID to use for this operation
365
</simpara></listitem></varlistentry>
366
<varlistentry><term><parameter>vcard</parameter> :</term>
367
<listitem><simpara>the VCard to add
368
</simpara></listitem></varlistentry>
369
</variablelist></refsect2>
370
<refsect2 id="e-book-backend-remove-contacts" role="function">
371
<title>e_book_backend_remove_contacts ()</title>
372
<indexterm zone="e-book-backend-remove-contacts"><primary>e_book_backend_remove_contacts</primary></indexterm>
373
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_remove_contacts (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
374
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
375
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
376
<parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>);</programlisting>
378
Executes a 'remove contacts' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
379
using <parameter>backend</parameter>.</para>
380
<variablelist role="params">
381
<varlistentry><term><parameter>backend</parameter> :</term>
382
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
383
</simpara></listitem></varlistentry>
384
<varlistentry><term><parameter>book</parameter> :</term>
385
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
386
</simpara></listitem></varlistentry>
387
<varlistentry><term><parameter>opid</parameter> :</term>
388
<listitem><simpara>the ID to use for this operation
389
</simpara></listitem></varlistentry>
390
<varlistentry><term><parameter>id_list</parameter> :</term>
391
<listitem><simpara>list of string IDs to remove
392
</simpara></listitem></varlistentry>
393
</variablelist></refsect2>
394
<refsect2 id="e-book-backend-modify-contact" role="function">
395
<title>e_book_backend_modify_contact ()</title>
396
<indexterm zone="e-book-backend-modify-contact"><primary>e_book_backend_modify_contact</primary></indexterm>
397
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_modify_contact (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
398
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
399
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
400
<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
402
Executes a 'modify contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
403
using <parameter>backend</parameter>.</para>
404
<variablelist role="params">
405
<varlistentry><term><parameter>backend</parameter> :</term>
406
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
407
</simpara></listitem></varlistentry>
408
<varlistentry><term><parameter>book</parameter> :</term>
409
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
410
</simpara></listitem></varlistentry>
411
<varlistentry><term><parameter>opid</parameter> :</term>
412
<listitem><simpara>the ID to use for this operation
413
</simpara></listitem></varlistentry>
414
<varlistentry><term><parameter>vcard</parameter> :</term>
415
<listitem><simpara>the VCard to update
416
</simpara></listitem></varlistentry>
417
</variablelist></refsect2>
418
<refsect2 id="e-book-backend-get-contact" role="function">
419
<title>e_book_backend_get_contact ()</title>
420
<indexterm zone="e-book-backend-get-contact"><primary>e_book_backend_get_contact</primary></indexterm>
421
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_contact (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
422
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
423
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
424
<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
426
Executes a 'get contact' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
427
using <parameter>backend</parameter>.</para>
428
<variablelist role="params">
429
<varlistentry><term><parameter>backend</parameter> :</term>
430
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
431
</simpara></listitem></varlistentry>
432
<varlistentry><term><parameter>book</parameter> :</term>
433
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
434
</simpara></listitem></varlistentry>
435
<varlistentry><term><parameter>opid</parameter> :</term>
436
<listitem><simpara>the ID to use for this operation
437
</simpara></listitem></varlistentry>
438
<varlistentry><term><parameter>id</parameter> :</term>
439
<listitem><simpara>the ID of the contact to get
440
</simpara></listitem></varlistentry>
441
</variablelist></refsect2>
442
<refsect2 id="e-book-backend-get-contact-list" role="function">
443
<title>e_book_backend_get_contact_list ()</title>
444
<indexterm zone="e-book-backend-get-contact-list"><primary>e_book_backend_get_contact_list</primary></indexterm>
445
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_contact_list (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
446
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
447
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
448
<parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>);</programlisting>
450
Executes a 'get contact list' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
451
using <parameter>backend</parameter>.</para>
452
<variablelist role="params">
453
<varlistentry><term><parameter>backend</parameter> :</term>
454
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
455
</simpara></listitem></varlistentry>
456
<varlistentry><term><parameter>book</parameter> :</term>
457
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
458
</simpara></listitem></varlistentry>
459
<varlistentry><term><parameter>opid</parameter> :</term>
460
<listitem><simpara>the ID to use for this operation
461
</simpara></listitem></varlistentry>
462
<varlistentry><term><parameter>query</parameter> :</term>
463
<listitem><simpara>the s-expression to match
464
</simpara></listitem></varlistentry>
465
</variablelist></refsect2>
466
<refsect2 id="e-book-backend-get-changes" role="function">
467
<title>e_book_backend_get_changes ()</title>
468
<indexterm zone="e-book-backend-get-changes"><primary>e_book_backend_get_changes</primary></indexterm>
469
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_changes (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
470
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
471
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
472
<parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>);</programlisting>
474
Executes a 'get changes' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
475
using <parameter>backend</parameter>.</para>
476
<variablelist role="params">
477
<varlistentry><term><parameter>backend</parameter> :</term>
478
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
479
</simpara></listitem></varlistentry>
480
<varlistentry><term><parameter>book</parameter> :</term>
481
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
482
</simpara></listitem></varlistentry>
483
<varlistentry><term><parameter>opid</parameter> :</term>
484
<listitem><simpara>the ID to use for this operation
485
</simpara></listitem></varlistentry>
486
<varlistentry><term><parameter>change_id</parameter> :</term>
487
<listitem><simpara>the ID of the changeset
488
</simpara></listitem></varlistentry>
489
</variablelist></refsect2>
490
<refsect2 id="e-book-backend-authenticate-user" role="function">
491
<title>e_book_backend_authenticate_user ()</title>
492
<indexterm zone="e-book-backend-authenticate-user"><primary>e_book_backend_authenticate_user</primary></indexterm>
493
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_authenticate_user (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
494
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
495
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
496
<parameter>const <link linkend="gchar"><type>gchar</type></link> *user</parameter>,
497
<parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
498
<parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);</programlisting>
500
Executes an 'authenticate' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
501
using <parameter>backend</parameter>.</para>
502
<variablelist role="params">
503
<varlistentry><term><parameter>backend</parameter> :</term>
504
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
505
</simpara></listitem></varlistentry>
506
<varlistentry><term><parameter>book</parameter> :</term>
507
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
508
</simpara></listitem></varlistentry>
509
<varlistentry><term><parameter>opid</parameter> :</term>
510
<listitem><simpara>the ID to use for this operation
511
</simpara></listitem></varlistentry>
512
<varlistentry><term><parameter>user</parameter> :</term>
513
<listitem><simpara>the name of the user account
514
</simpara></listitem></varlistentry>
515
<varlistentry><term><parameter>passwd</parameter> :</term>
516
<listitem><simpara>the user's password
517
</simpara></listitem></varlistentry>
518
<varlistentry><term><parameter>auth_method</parameter> :</term>
519
<listitem><simpara>the authentication method to use
520
</simpara></listitem></varlistentry>
521
</variablelist></refsect2>
522
<refsect2 id="e-book-backend-get-supported-fields" role="function">
523
<title>e_book_backend_get_supported_fields ()</title>
524
<indexterm zone="e-book-backend-get-supported-fields"><primary>e_book_backend_get_supported_fields</primary></indexterm>
525
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_supported_fields (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
526
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
527
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
529
Executes a 'get supported fields' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
530
using <parameter>backend</parameter>.</para>
531
<variablelist role="params">
532
<varlistentry><term><parameter>backend</parameter> :</term>
533
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
534
</simpara></listitem></varlistentry>
535
<varlistentry><term><parameter>book</parameter> :</term>
536
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
537
</simpara></listitem></varlistentry>
538
<varlistentry><term><parameter>opid</parameter> :</term>
539
<listitem><simpara>the ID to use for this operation
540
</simpara></listitem></varlistentry>
541
</variablelist></refsect2>
542
<refsect2 id="e-book-backend-get-required-fields" role="function">
543
<title>e_book_backend_get_required_fields ()</title>
544
<indexterm zone="e-book-backend-get-required-fields"><primary>e_book_backend_get_required_fields</primary></indexterm>
545
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_required_fields (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
546
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
547
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
549
Executes a 'get required fields' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
550
using <parameter>backend</parameter>.</para>
551
<variablelist role="params">
552
<varlistentry><term><parameter>backend</parameter> :</term>
553
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
554
</simpara></listitem></varlistentry>
555
<varlistentry><term><parameter>book</parameter> :</term>
556
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
557
</simpara></listitem></varlistentry>
558
<varlistentry><term><parameter>opid</parameter> :</term>
559
<listitem><simpara>the ID to use for this operation
560
</simpara></listitem></varlistentry>
561
</variablelist></refsect2>
562
<refsect2 id="e-book-backend-get-supported-auth-methods" role="function">
563
<title>e_book_backend_get_supported_auth_methods ()</title>
564
<indexterm zone="e-book-backend-get-supported-auth-methods"><primary>e_book_backend_get_supported_auth_methods</primary></indexterm>
565
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_get_supported_auth_methods
566
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
567
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
568
<parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
570
Executes a 'get supported auth methods' request specified by <parameter>opid</parameter> on <parameter>book</parameter>
571
using <parameter>backend</parameter>.</para>
572
<variablelist role="params">
573
<varlistentry><term><parameter>backend</parameter> :</term>
574
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
575
</simpara></listitem></varlistentry>
576
<varlistentry><term><parameter>book</parameter> :</term>
577
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
578
</simpara></listitem></varlistentry>
579
<varlistentry><term><parameter>opid</parameter> :</term>
580
<listitem><simpara>the ID to use for this operation
581
</simpara></listitem></varlistentry>
582
</variablelist></refsect2>
583
<refsect2 id="e-book-backend-cancel-operation" role="function">
584
<title>e_book_backend_cancel_operation ()</title>
585
<indexterm zone="e-book-backend-cancel-operation"><primary>e_book_backend_cancel_operation</primary></indexterm>
586
<programlisting><link linkend="GNOME-Evolution-Addressbook-CallStatus"><returnvalue>GNOME_Evolution_Addressbook_CallStatus</returnvalue></link> e_book_backend_cancel_operation
587
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
588
<parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>);</programlisting>
590
Cancel <parameter>book</parameter>'s running operation on <parameter>backend</parameter>.</para>
591
<variablelist role="params">
592
<varlistentry><term><parameter>backend</parameter> :</term>
593
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
594
</simpara></listitem></varlistentry>
595
<varlistentry><term><parameter>book</parameter> :</term>
596
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link> whose operation should be cancelled
597
</simpara></listitem></varlistentry>
598
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A GNOME_Evolution_Addressbook_CallStatus indicating the outcome.
599
</simpara></listitem></varlistentry>
600
</variablelist></refsect2>
601
<refsect2 id="e-book-backend-set-mode" role="function">
602
<title>e_book_backend_set_mode ()</title>
603
<indexterm zone="e-book-backend-set-mode"><primary>e_book_backend_set_mode</primary></indexterm>
604
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_set_mode (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
605
<parameter><link linkend="GNOME-Evolution-Addressbook-BookMode"><type>GNOME_Evolution_Addressbook_BookMode</type></link> mode</parameter>);</programlisting>
607
Sets <parameter>backend</parameter>'s online/offline mode to <parameter>mode</parameter>. Mode can be 1 for offline
608
or 2 indicating that it is connected and online.</para>
609
<variablelist role="params">
610
<varlistentry><term><parameter>backend</parameter> :</term>
611
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
612
</simpara></listitem></varlistentry>
613
<varlistentry><term><parameter>mode</parameter> :</term>
614
<listitem><simpara>a mode indicating the online/offline status of the backend
615
</simpara></listitem></varlistentry>
616
</variablelist></refsect2>
617
<refsect2 id="e-book-backend-start-book-view" role="function">
618
<title>e_book_backend_start_book_view ()</title>
619
<indexterm zone="e-book-backend-start-book-view"><primary>e_book_backend_start_book_view</primary></indexterm>
620
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_start_book_view (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
621
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
623
Starts running the query specified by <parameter>book_view</parameter>, emitting
624
signals for matching contacts.</para>
625
<variablelist role="params">
626
<varlistentry><term><parameter>backend</parameter> :</term>
627
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
628
</simpara></listitem></varlistentry>
629
<varlistentry><term><parameter>view</parameter> :</term>
631
</simpara></listitem></varlistentry>
632
</variablelist></refsect2>
633
<refsect2 id="e-book-backend-stop-book-view" role="function">
634
<title>e_book_backend_stop_book_view ()</title>
635
<indexterm zone="e-book-backend-stop-book-view"><primary>e_book_backend_stop_book_view</primary></indexterm>
636
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_stop_book_view (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
637
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
639
Stops running the query specified by <parameter>book_view</parameter>, emitting
640
no more signals.</para>
641
<variablelist role="params">
642
<varlistentry><term><parameter>backend</parameter> :</term>
643
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
644
</simpara></listitem></varlistentry>
645
<varlistentry><term><parameter>view</parameter> :</term>
647
</simpara></listitem></varlistentry>
648
</variablelist></refsect2>
649
<refsect2 id="e-book-backend-add-book-view" role="function">
650
<title>e_book_backend_add_book_view ()</title>
651
<indexterm zone="e-book-backend-add-book-view"><primary>e_book_backend_add_book_view</primary></indexterm>
652
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_add_book_view (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
653
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
655
Adds <parameter>view</parameter> to <parameter>backend</parameter> for querying.</para>
656
<variablelist role="params">
657
<varlistentry><term><parameter>backend</parameter> :</term>
658
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
659
</simpara></listitem></varlistentry>
660
<varlistentry><term><parameter>view</parameter> :</term>
661
<listitem><simpara>an <link linkend="EDataBookView"><type>EDataBookView</type></link>
662
</simpara></listitem></varlistentry>
663
</variablelist></refsect2>
664
<refsect2 id="e-book-backend-remove-book-view" role="function">
665
<title>e_book_backend_remove_book_view ()</title>
666
<indexterm zone="e-book-backend-remove-book-view"><primary>e_book_backend_remove_book_view</primary></indexterm>
667
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_remove_book_view (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
668
<parameter><link linkend="EDataBookView"><type>EDataBookView</type></link> *view</parameter>);</programlisting>
670
Removes <parameter>view</parameter> from <parameter>backend</parameter>.</para>
671
<variablelist role="params">
672
<varlistentry><term><parameter>backend</parameter> :</term>
673
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
674
</simpara></listitem></varlistentry>
675
<varlistentry><term><parameter>view</parameter> :</term>
676
<listitem><simpara>an <link linkend="EDataBookView"><type>EDataBookView</type></link>
677
</simpara></listitem></varlistentry>
678
</variablelist></refsect2>
679
<refsect2 id="e-book-backend-get-book-views" role="function">
680
<title>e_book_backend_get_book_views ()</title>
681
<indexterm zone="e-book-backend-get-book-views"><primary>e_book_backend_get_book_views</primary></indexterm>
682
<programlisting><link linkend="EList"><returnvalue>EList</returnvalue></link> * e_book_backend_get_book_views (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
684
Gets the list of <link linkend="EDataBookView"><type>EDataBookView</type></link> views running on this backend.</para>
685
<variablelist role="params">
686
<varlistentry><term><parameter>backend</parameter> :</term>
687
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
688
</simpara></listitem></varlistentry>
689
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An <link linkend="EList"><type>EList</type></link> of <link linkend="EDataBookView"><type>EDataBookView</type></link> objects.
690
</simpara></listitem></varlistentry>
691
</variablelist></refsect2>
692
<refsect2 id="e-book-backend-notify-update" role="function">
693
<title>e_book_backend_notify_update ()</title>
694
<indexterm zone="e-book-backend-notify-update"><primary>e_book_backend_notify_update</primary></indexterm>
695
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_update (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
696
<parameter><link linkend="EContact"><type>EContact</type></link> *contact</parameter>);</programlisting>
698
Notifies all of <parameter>backend</parameter>'s book views about the new or modified
699
contacts <parameter>contact</parameter>.
702
<link linkend="e-data-book-respond-create"><function>e_data_book_respond_create()</function></link> and <link linkend="e-data-book-respond-modify"><function>e_data_book_respond_modify()</function></link> call this
703
function for you. You only need to call this from your backend if
704
contacts are created or modified by another (non-PAS-using) client.</para>
705
<variablelist role="params">
706
<varlistentry><term><parameter>backend</parameter> :</term>
707
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
708
</simpara></listitem></varlistentry>
709
<varlistentry><term><parameter>contact</parameter> :</term>
710
<listitem><simpara>a new or modified contact
711
</simpara></listitem></varlistentry>
712
</variablelist></refsect2>
713
<refsect2 id="e-book-backend-notify-remove" role="function">
714
<title>e_book_backend_notify_remove ()</title>
715
<indexterm zone="e-book-backend-notify-remove"><primary>e_book_backend_notify_remove</primary></indexterm>
716
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_remove (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
717
<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
719
Notifies all of <parameter>backend</parameter>'s book views that the contact with UID
720
<parameter>id</parameter> has been removed.
723
<link linkend="e-data-book-respond-remove-contacts"><function>e_data_book_respond_remove_contacts()</function></link> calls this function for you. You
724
only need to call this from your backend if contacts are removed by
725
another (non-PAS-using) client.</para>
726
<variablelist role="params">
727
<varlistentry><term><parameter>backend</parameter> :</term>
728
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
729
</simpara></listitem></varlistentry>
730
<varlistentry><term><parameter>id</parameter> :</term>
731
<listitem><simpara>a contact id
732
</simpara></listitem></varlistentry>
733
</variablelist></refsect2>
734
<refsect2 id="e-book-backend-notify-complete" role="function">
735
<title>e_book_backend_notify_complete ()</title>
736
<indexterm zone="e-book-backend-notify-complete"><primary>e_book_backend_notify_complete</primary></indexterm>
737
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_complete (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
739
Notifies all of <parameter>backend</parameter>'s book views that the current set of
740
notifications is complete; use this after a series of
741
<link linkend="e-book-backend-notify-update"><function>e_book_backend_notify_update()</function></link> and <link linkend="e-book-backend-notify-remove"><function>e_book_backend_notify_remove()</function></link> calls.</para>
742
<variablelist role="params">
743
<varlistentry><term><parameter>backend</parameter> :</term>
744
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
745
</simpara></listitem></varlistentry>
746
</variablelist></refsect2>
747
<refsect2 id="e-book-backend-notify-writable" role="function">
748
<title>e_book_backend_notify_writable ()</title>
749
<indexterm zone="e-book-backend-notify-writable"><primary>e_book_backend_notify_writable</primary></indexterm>
750
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_writable (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
751
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);</programlisting>
753
Notifies all backends clients about the current writable state.</para>
754
<variablelist role="params">
755
<varlistentry><term><parameter>backend</parameter> :</term>
756
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
757
</simpara></listitem></varlistentry>
758
<varlistentry><term><parameter>is_writable</parameter> :</term>
759
<listitem><simpara>flag indicating writable status
760
</simpara></listitem></varlistentry>
761
</variablelist></refsect2>
762
<refsect2 id="e-book-backend-notify-connection-status" role="function">
763
<title>e_book_backend_notify_connection_status ()</title>
764
<indexterm zone="e-book-backend-notify-connection-status"><primary>e_book_backend_notify_connection_status</primary></indexterm>
765
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_connection_status
766
(<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
767
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_online</parameter>);</programlisting>
769
Notifies clients of <parameter>backend</parameter>'s connection status indicated by <parameter>is_online</parameter>.
770
Meant to be used by backend implementations.</para>
771
<variablelist role="params">
772
<varlistentry><term><parameter>backend</parameter> :</term>
773
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
774
</simpara></listitem></varlistentry>
775
<varlistentry><term><parameter>is_online</parameter> :</term>
776
<listitem><simpara>flag indicating whether <parameter>backend</parameter> is connected and online
777
</simpara></listitem></varlistentry>
778
</variablelist></refsect2>
779
<refsect2 id="e-book-backend-notify-auth-required" role="function">
780
<title>e_book_backend_notify_auth_required ()</title>
781
<indexterm zone="e-book-backend-notify-auth-required"><primary>e_book_backend_notify_auth_required</primary></indexterm>
782
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_notify_auth_required (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
784
Notifies clients that <parameter>backend</parameter> requires authentication in order to
785
connect. Means to be used by backend implementations.</para>
786
<variablelist role="params">
787
<varlistentry><term><parameter>backend</parameter> :</term>
788
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
789
</simpara></listitem></varlistentry>
790
</variablelist></refsect2>
791
<refsect2 id="e-book-backend-sync" role="function">
792
<title>e_book_backend_sync ()</title>
793
<indexterm zone="e-book-backend-sync"><primary>e_book_backend_sync</primary></indexterm>
794
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_sync (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>);</programlisting>
796
Write all pending data to disk. This is only required under special
797
circumstances (for example before a live backup) and should not be used in
799
<variablelist role="params">
800
<varlistentry><term><parameter>backend</parameter> :</term>
801
<listitem><simpara>an <link linkend="EBookbackend"><type>EBookbackend</type></link>
802
</simpara></listitem></varlistentry>
803
</variablelist></refsect2>
804
<refsect2 id="e-book-backend-set-is-loaded" role="function">
805
<title>e_book_backend_set_is_loaded ()</title>
806
<indexterm zone="e-book-backend-set-is-loaded"><primary>e_book_backend_set_is_loaded</primary></indexterm>
807
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_set_is_loaded (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
808
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_loaded</parameter>);</programlisting>
810
Sets the flag indicating whether <parameter>backend</parameter> is loaded to <parameter>is_loaded</parameter>.
811
Meant to be used by backend implementations.</para>
812
<variablelist role="params">
813
<varlistentry><term><parameter>backend</parameter> :</term>
814
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
815
</simpara></listitem></varlistentry>
816
<varlistentry><term><parameter>is_loaded</parameter> :</term>
817
<listitem><simpara>A flag indicating whether the backend is loaded
818
</simpara></listitem></varlistentry>
819
</variablelist></refsect2>
820
<refsect2 id="e-book-backend-set-is-writable" role="function">
821
<title>e_book_backend_set_is_writable ()</title>
822
<indexterm zone="e-book-backend-set-is-writable"><primary>e_book_backend_set_is_writable</primary></indexterm>
823
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_set_is_writable (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
824
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_writable</parameter>);</programlisting>
826
Sets the flag indicating whether <parameter>backend</parameter> is writeable to <parameter>is_writeable</parameter>.
827
Meant to be used by backend implementations.</para>
828
<variablelist role="params">
829
<varlistentry><term><parameter>backend</parameter> :</term>
830
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
831
</simpara></listitem></varlistentry>
832
<varlistentry><term><parameter>is_writable</parameter> :</term>
833
<listitem><simpara>A flag indicating whether the backend is writeable
834
</simpara></listitem></varlistentry>
835
</variablelist></refsect2>
836
<refsect2 id="e-book-backend-set-is-removed" role="function">
837
<title>e_book_backend_set_is_removed ()</title>
838
<indexterm zone="e-book-backend-set-is-removed"><primary>e_book_backend_set_is_removed</primary></indexterm>
839
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> e_book_backend_set_is_removed (<parameter><link linkend="EBookBackend"><type>EBookBackend</type></link> *backend</parameter>,
840
<parameter><link linkend="gboolean"><type>gboolean</type></link> is_removed</parameter>);</programlisting>
842
Sets the flag indicating whether <parameter>backend</parameter> was removed to <parameter>is_removed</parameter>.
843
Meant to be used by backend implementations.</para>
844
<variablelist role="params">
845
<varlistentry><term><parameter>backend</parameter> :</term>
846
<listitem><simpara>an <link linkend="EBookBackend"><type>EBookBackend</type></link>
847
</simpara></listitem></varlistentry>
848
<varlistentry><term><parameter>is_removed</parameter> :</term>
849
<listitem><simpara>A flag indicating whether the backend's storage was removed
850
</simpara></listitem></varlistentry>
851
</variablelist></refsect2>
852
<refsect2 id="e-book-backend-change-add-new" role="function">
853
<title>e_book_backend_change_add_new ()</title>
854
<indexterm zone="e-book-backend-change-add-new"><primary>e_book_backend_change_add_new</primary></indexterm>
855
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_add_new
856
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
858
Creates a new change item indicating <parameter>vcard</parameter> was added.
859
Meant to be used by backend implementations.</para>
860
<variablelist role="params">
861
<varlistentry><term><parameter>vcard</parameter> :</term>
862
<listitem><simpara>a VCard string
863
</simpara></listitem></varlistentry>
864
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.
865
</simpara></listitem></varlistentry>
866
</variablelist></refsect2>
867
<refsect2 id="e-book-backend-change-modify-new" role="function">
868
<title>e_book_backend_change_modify_new ()</title>
869
<indexterm zone="e-book-backend-change-modify-new"><primary>e_book_backend_change_modify_new</primary></indexterm>
870
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_modify_new
871
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>);</programlisting>
873
Creates a new change item indicating <parameter>vcard</parameter> was modified.
874
Meant to be used by backend implementations.</para>
875
<variablelist role="params">
876
<varlistentry><term><parameter>vcard</parameter> :</term>
877
<listitem><simpara>a VCard string
878
</simpara></listitem></varlistentry>
879
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.
880
</simpara></listitem></varlistentry>
881
</variablelist></refsect2>
882
<refsect2 id="e-book-backend-change-delete-new" role="function">
883
<title>e_book_backend_change_delete_new ()</title>
884
<indexterm zone="e-book-backend-change-delete-new"><primary>e_book_backend_change_delete_new</primary></indexterm>
885
<programlisting><link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><returnvalue>GNOME_Evolution_Addressbook_BookChangeItem</returnvalue></link>* e_book_backend_change_delete_new
886
(<parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>);</programlisting>
888
Creates a new change item indicating <parameter>vcard</parameter> was deleted.
889
Meant to be used by backend implementations.</para>
890
<variablelist role="params">
891
<varlistentry><term><parameter>id</parameter> :</term>
893
</simpara></listitem></varlistentry>
894
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A new <link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.
895
</simpara></listitem></varlistentry>
896
</variablelist></refsect2>
897
<refsect2 id="EBookBackendClass" role="struct">
898
<title>struct EBookBackendClass</title>
899
<indexterm zone="EBookBackendClass"><primary>EBookBackendClass</primary></indexterm>
900
<programlisting>struct EBookBackendClass {
901
GObjectClass parent_class;
903
/* Virtual methods */
904
GNOME_Evolution_Addressbook_CallStatus (*load_source) (EBookBackend *backend, ESource *source, gboolean only_if_exists);
905
void (*remove) (EBookBackend *backend, EDataBook *book, guint32 opid);
906
gchar *(*get_static_capabilities) (EBookBackend *backend);
908
void (*create_contact) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *vcard);
909
void (*remove_contacts) (EBookBackend *backend, EDataBook *book, guint32 opid, GList *id_list);
910
void (*modify_contact) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *vcard);
911
void (*get_contact) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *id);
912
void (*get_contact_list) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *query);
913
void (*start_book_view) (EBookBackend *backend, EDataBookView *book_view);
914
void (*stop_book_view) (EBookBackend *backend, EDataBookView *book_view);
915
void (*get_changes) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *change_id);
916
void (*authenticate_user) (EBookBackend *backend, EDataBook *book, guint32 opid, const gchar *user, const gchar *passwd, const gchar *auth_method);
917
void (*get_required_fields) (EBookBackend *backend, EDataBook *bokk, guint32 opid);
918
void (*get_supported_fields) (EBookBackend *backend, EDataBook *book, guint32 opid);
919
void (*get_supported_auth_methods) (EBookBackend *backend, EDataBook *book, guint32 opid);
920
GNOME_Evolution_Addressbook_CallStatus (*cancel_operation) (EBookBackend *backend, EDataBook *book);
921
void (*set_mode) (EBookBackend *backend, GNOME_Evolution_Addressbook_BookMode mode);
923
/* Notification signals */
924
void (* last_client_gone) (EBookBackend *backend);
926
void (*sync) (EBookBackend *backend);
928
/* Padding for future expansion */
929
void (*_pas_reserved1) (void);
930
void (*_pas_reserved2) (void);
931
void (*_pas_reserved3) (void);
932
void (*_pas_reserved4) (void);
939
<refsect1 id="EBookBackend.signal-details" role="signals">
940
<title role="signals.title">Signal Details</title>
941
<refsect2 id="EBookBackend-last-client-gone" role="signal"><title>The <literal>"last-client-gone"</literal> signal</title>
942
<indexterm zone="EBookBackend-last-client-gone"><primary>EBookBackend::last-client-gone</primary></indexterm>
943
<programlisting><link linkend="void"><returnvalue>void</returnvalue></link> user_function (<link linkend="EBookBackend"><type>EBookBackend</type></link> *ebookbackend,
944
<link linkend="gpointer"><type>gpointer</type></link> user_data) : Run First</programlisting>
946
</para><variablelist role="params">
947
<varlistentry><term><parameter>ebookbackend</parameter> :</term>
948
<listitem><simpara>the object which received the signal.
949
</simpara></listitem></varlistentry>
950
<varlistentry><term><parameter>user_data</parameter> :</term>
951
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
952
</variablelist></refsect2>
added
removed
docs/reference/addressbook/libedata-book/xml/e-book-backend.xml
