← Back to branch summary

~ubuntu-branches/ubuntu/maverick/evolution-data-server/maverick-proposed

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libedata-book/xml/e-book-backend-sync.xml

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-05-17 17:02:06 UTC
  • mfrom: (1.1.79 upstream) (1.6.12 experimental)
  • Revision ID: james.westby@ubuntu.com-20100517170206-4ufr52vwrhh26yh0
Tags: 2.30.1-1ubuntu1
https://launchpad.net/bugs/42199
https://launchpad.net/bugs/229669
https://launchpad.net/bugs/173703
https://launchpad.net/bugs/360344
https://launchpad.net/bugs/508494
* Merge from debian experimental. Remaining change:
  (LP: #42199, #229669, #173703, #360344, #508494)
  + debian/control:
    - add Vcs-Bzr tag
    - don't use libgnome
    - Use Breaks instead of Conflicts against evolution 2.25 and earlier.
  + debian/evolution-data-server.install,
    debian/patches/45_libcamel_providers_version.patch:
    - use the upstream versioning, not a Debian-specific one 
  + debian/libedata-book1.2-dev.install, debian/libebackend-1.2-dev.install,
    debian/libcamel1.2-dev.install, debian/libedataserverui1.2-dev.install:
    - install html documentation
  + debian/rules:
    - don't build documentation it's shipped with the tarball

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/addressbook/libedata-book/xml/e-book-backend-sync.xml
1
 
<?xml version="1.0"?>
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="EBookBackendSync">
5
 
<refmeta>
6
 
<refentrytitle role="top_of_page" id="EBookBackendSync.top_of_page">EBookBackendSync</refentrytitle>
7
 
<manvolnum>3</manvolnum>
8
 
<refmiscinfo>
9
 
  LIBEDATA-BOOK Library
10
 
</refmiscinfo>
11
 
</refmeta>
12
 
<refnamediv>
13
 
<refname>EBookBackendSync</refname>
14
 
<refpurpose></refpurpose>
15
 
</refnamediv>
16
 
 
17
 
<refsynopsisdiv id="EBookBackendSync.synopsis" role="synopsis">
18
 
<title role="synopsis.title">Synopsis</title>
19
 
 
20
 
<synopsis>typedef             <link linkend="EBookBackendSyncStatus">EBookBackendSyncStatus</link>;
21
 
struct              <link linkend="EBookBackendSync-struct">EBookBackendSync</link>;
22
 
<link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            <link linkend="e-book-backend-sync-construct">e_book_backend_sync_construct</link>       (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>);
23
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-remove">e_book_backend_sync_remove</link>      (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
24
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
25
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);
26
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-create-contact">e_book_backend_sync_create_contact</link>
27
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
28
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
29
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
30
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>,
31
 
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> **contact</parameter>);
32
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-remove-contacts">e_book_backend_sync_remove_contacts</link>
33
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
34
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
35
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
36
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>,
37
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **removed_ids</parameter>);
38
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-modify-contact">e_book_backend_sync_modify_contact</link>
39
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
40
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
41
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
42
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>,
43
 
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> **contact</parameter>);
44
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-contact">e_book_backend_sync_get_contact</link> (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
45
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
46
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
47
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>,
48
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **vcard</parameter>);
49
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-contact-list">e_book_backend_sync_get_contact_list</link>
50
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
51
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
52
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
53
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
54
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **contacts</parameter>);
55
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-changes">e_book_backend_sync_get_changes</link> (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
56
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
57
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
58
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>,
59
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **changes</parameter>);
60
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-authenticate-user">e_book_backend_sync_authenticate_user</link>
61
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</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> *user</parameter>,
65
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
66
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);
67
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-required-fields">e_book_backend_sync_get_required_fields</link>
68
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
69
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
70
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
71
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **fields</parameter>);
72
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-supported-fields">e_book_backend_sync_get_supported_fields</link>
73
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
74
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
75
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
76
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **fields</parameter>);
77
 
<link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  <link linkend="e-book-backend-sync-get-supported-auth-methods">e_book_backend_sync_get_supported_auth_methods</link>
78
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</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
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **methods</parameter>);
82
 
</synopsis>
83
 
</refsynopsisdiv>
84
 
<refsect1 id="EBookBackendSync.object-hierarchy" role="object_hierarchy">
85
 
<title role="object_hierarchy.title">Object Hierarchy</title>
86
 
<synopsis>
87
 
  <link linkend="GObject">GObject</link>
88
 
   +----<link linkend="EBookBackend">EBookBackend</link>
89
 
         +----EBookBackendSync
90
 
</synopsis>
91
 
</refsect1>
92
 
 
93
 
<refsect1 id="EBookBackendSync.description" role="desc">
94
 
<title role="desc.title">Description</title>
95
 
<para>
96
 
</para>
97
 
</refsect1>
98
 
<refsect1 id="EBookBackendSync.details" role="details">
99
 
<title role="details.title">Details</title>
100
 
<refsect2 id="EBookBackendSyncStatus" role="typedef">
101
 
<title>EBookBackendSyncStatus</title>
102
 
<indexterm zone="EBookBackendSyncStatus"><primary>EBookBackendSyncStatus</primary></indexterm>
103
 
<programlisting>typedef GNOME_Evolution_Addressbook_CallStatus EBookBackendSyncStatus;
104
 
</programlisting>
105
 
<para>
106
 
</para></refsect2>
107
 
<refsect2 id="EBookBackendSync-struct" role="struct">
108
 
<title>struct EBookBackendSync</title>
109
 
<indexterm zone="EBookBackendSync-struct"><primary>EBookBackendSync</primary></indexterm>
110
 
<programlisting>struct EBookBackendSync;</programlisting>
111
 
<para>
112
 
</para></refsect2>
113
 
<refsect2 id="e-book-backend-sync-construct" role="function">
114
 
<title>e_book_backend_sync_construct ()</title>
115
 
<indexterm zone="e-book-backend-sync-construct"><primary>e_book_backend_sync_construct</primary></indexterm>
116
 
<programlisting><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>            e_book_backend_sync_construct       (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>);</programlisting>
117
 
<para>
118
 
Does nothing.</para>
119
 
<variablelist role="params">
120
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
121
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
122
 
</simpara></listitem></varlistentry>
123
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>.
124
 
</simpara></listitem></varlistentry>
125
 
</variablelist></refsect2>
126
 
<refsect2 id="e-book-backend-sync-remove" role="function">
127
 
<title>e_book_backend_sync_remove ()</title>
128
 
<indexterm zone="e-book-backend-sync-remove"><primary>e_book_backend_sync_remove</primary></indexterm>
129
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_remove      (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
130
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
131
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>);</programlisting>
132
 
<para>
133
 
Remove <parameter>book</parameter>'s database and storage overhead from the storage
134
 
medium. This will delete all contacts in <parameter>book</parameter>.</para>
135
 
<variablelist role="params">
136
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
137
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
138
 
</simpara></listitem></varlistentry>
139
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
140
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
141
 
</simpara></listitem></varlistentry>
142
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
143
 
<listitem><simpara>the unique ID of the operation
144
 
</simpara></listitem></varlistentry>
145
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
146
 
</simpara></listitem></varlistentry>
147
 
</variablelist></refsect2>
148
 
<refsect2 id="e-book-backend-sync-create-contact" role="function">
149
 
<title>e_book_backend_sync_create_contact ()</title>
150
 
<indexterm zone="e-book-backend-sync-create-contact"><primary>e_book_backend_sync_create_contact</primary></indexterm>
151
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_create_contact
152
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
153
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
154
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
155
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>,
156
 
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> **contact</parameter>);</programlisting>
157
 
<para>
158
 
Creates a new contact with the contents of <parameter>vcard</parameter> in <parameter>backend</parameter>.</para>
159
 
<variablelist role="params">
160
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
161
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
162
 
</simpara></listitem></varlistentry>
163
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
164
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
165
 
</simpara></listitem></varlistentry>
166
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
167
 
<listitem><simpara>the unique ID of the operation
168
 
</simpara></listitem></varlistentry>
169
 
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
170
 
<listitem><simpara>a VCard representation of a contact
171
 
</simpara></listitem></varlistentry>
172
 
<varlistentry><term><parameter>contact</parameter>&#160;:</term>
173
 
<listitem><simpara>a pointer to a location to store the resulting <link linkend="EContact"><type>EContact</type></link>
174
 
</simpara></listitem></varlistentry>
175
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
176
 
</simpara></listitem></varlistentry>
177
 
</variablelist></refsect2>
178
 
<refsect2 id="e-book-backend-sync-remove-contacts" role="function">
179
 
<title>e_book_backend_sync_remove_contacts ()</title>
180
 
<indexterm zone="e-book-backend-sync-remove-contacts"><primary>e_book_backend_sync_remove_contacts</primary></indexterm>
181
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_remove_contacts
182
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
183
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
184
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
185
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> *id_list</parameter>,
186
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **removed_ids</parameter>);</programlisting>
187
 
<para>
188
 
Removes the contacts specified by <parameter>id_list</parameter> from <parameter>backend</parameter>. The returned list
189
 
of removed contacts is in the same format as the passed-in list, and must be
190
 
freed by the caller.</para>
191
 
<variablelist role="params">
192
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
193
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
194
 
</simpara></listitem></varlistentry>
195
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
196
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
197
 
</simpara></listitem></varlistentry>
198
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
199
 
<listitem><simpara>the unique ID of the operation
200
 
</simpara></listitem></varlistentry>
201
 
<varlistentry><term><parameter>id_list</parameter>&#160;:</term>
202
 
<listitem><simpara>a <link linkend="GList"><type>GList</type></link> of pointers to unique contact ID strings
203
 
</simpara></listitem></varlistentry>
204
 
<varlistentry><term><parameter>removed_ids</parameter>&#160;:</term>
205
 
<listitem><simpara>a pointer to a location to store a list of the contacts actually removed
206
 
</simpara></listitem></varlistentry>
207
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
208
 
</simpara></listitem></varlistentry>
209
 
</variablelist></refsect2>
210
 
<refsect2 id="e-book-backend-sync-modify-contact" role="function">
211
 
<title>e_book_backend_sync_modify_contact ()</title>
212
 
<indexterm zone="e-book-backend-sync-modify-contact"><primary>e_book_backend_sync_modify_contact</primary></indexterm>
213
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_modify_contact
214
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
215
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
216
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
217
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *vcard</parameter>,
218
 
                                                         <parameter><link linkend="EContact"><type>EContact</type></link> **contact</parameter>);</programlisting>
219
 
<para>
220
 
Modifies the contact specified by the ID embedded in <parameter>vcard</parameter>, to
221
 
reflect the full contents of <parameter>vcard</parameter>.</para>
222
 
<variablelist role="params">
223
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
224
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
225
 
</simpara></listitem></varlistentry>
226
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
227
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
228
 
</simpara></listitem></varlistentry>
229
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
230
 
<listitem><simpara>the unique ID of the operation
231
 
</simpara></listitem></varlistentry>
232
 
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
233
 
<listitem><simpara>the string representation of a contact
234
 
</simpara></listitem></varlistentry>
235
 
<varlistentry><term><parameter>contact</parameter>&#160;:</term>
236
 
<listitem><simpara>a pointer to a location to store the resulting <link linkend="EContact"><type>EContact</type></link>
237
 
</simpara></listitem></varlistentry>
238
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
239
 
</simpara></listitem></varlistentry>
240
 
</variablelist></refsect2>
241
 
<refsect2 id="e-book-backend-sync-get-contact" role="function">
242
 
<title>e_book_backend_sync_get_contact ()</title>
243
 
<indexterm zone="e-book-backend-sync-get-contact"><primary>e_book_backend_sync_get_contact</primary></indexterm>
244
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_contact (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
245
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
246
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
247
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *id</parameter>,
248
 
                                                         <parameter><link linkend="gchar"><type>gchar</type></link> **vcard</parameter>);</programlisting>
249
 
<para>
250
 
Gets a contact from <parameter>book</parameter>.</para>
251
 
<variablelist role="params">
252
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
253
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
254
 
</simpara></listitem></varlistentry>
255
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
256
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
257
 
</simpara></listitem></varlistentry>
258
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
259
 
<listitem><simpara>the unique ID of the operation
260
 
</simpara></listitem></varlistentry>
261
 
<varlistentry><term><parameter>id</parameter>&#160;:</term>
262
 
<listitem><simpara>a unique contact ID
263
 
</simpara></listitem></varlistentry>
264
 
<varlistentry><term><parameter>vcard</parameter>&#160;:</term>
265
 
<listitem><simpara>a pointer to a location to store the resulting VCard string
266
 
</simpara></listitem></varlistentry>
267
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
268
 
</simpara></listitem></varlistentry>
269
 
</variablelist></refsect2>
270
 
<refsect2 id="e-book-backend-sync-get-contact-list" role="function">
271
 
<title>e_book_backend_sync_get_contact_list ()</title>
272
 
<indexterm zone="e-book-backend-sync-get-contact-list"><primary>e_book_backend_sync_get_contact_list</primary></indexterm>
273
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_contact_list
274
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
275
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
276
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
277
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *query</parameter>,
278
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **contacts</parameter>);</programlisting>
279
 
<para>
280
 
Gets a list of contacts from <parameter>book</parameter>. The list and its elements must be freed
281
 
by the caller.</para>
282
 
<variablelist role="params">
283
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
284
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
285
 
</simpara></listitem></varlistentry>
286
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
287
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
288
 
</simpara></listitem></varlistentry>
289
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
290
 
<listitem><simpara>the unique ID of the operation
291
 
</simpara></listitem></varlistentry>
292
 
<varlistentry><term><parameter>query</parameter>&#160;:</term>
293
 
<listitem><simpara>an s-expression of the query to perform
294
 
</simpara></listitem></varlistentry>
295
 
<varlistentry><term><parameter>contacts</parameter>&#160;:</term>
296
 
<listitem><simpara>a pointer to a location to store the resulting list of VCard strings
297
 
</simpara></listitem></varlistentry>
298
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
299
 
</simpara></listitem></varlistentry>
300
 
</variablelist></refsect2>
301
 
<refsect2 id="e-book-backend-sync-get-changes" role="function">
302
 
<title>e_book_backend_sync_get_changes ()</title>
303
 
<indexterm zone="e-book-backend-sync-get-changes"><primary>e_book_backend_sync_get_changes</primary></indexterm>
304
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_changes (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
305
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
306
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
307
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *change_id</parameter>,
308
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **changes</parameter>);</programlisting>
309
 
<para>
310
 
Gets the changes made to <parameter>book</parameter> since the last call to this function.
311
 
The returned list will contain items of CORBA type
312
 
<link linkend="GNOME-Evolution-Addressbook-BookChangeItem"><type>GNOME_Evolution_Addressbook_BookChangeItem</type></link>.</para>
313
 
<variablelist role="params">
314
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
315
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
316
 
</simpara></listitem></varlistentry>
317
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
318
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
319
 
</simpara></listitem></varlistentry>
320
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
321
 
<listitem><simpara>the unique ID of the operation
322
 
</simpara></listitem></varlistentry>
323
 
<varlistentry><term><parameter>change_id</parameter>&#160;:</term>
324
 
<listitem><simpara>a unique changes ID
325
 
</simpara></listitem></varlistentry>
326
 
<varlistentry><term><parameter>changes</parameter>&#160;:</term>
327
 
<listitem><simpara>a pointer to a location to store the resulting list of changes
328
 
</simpara></listitem></varlistentry>
329
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
330
 
</simpara></listitem></varlistentry>
331
 
</variablelist></refsect2>
332
 
<refsect2 id="e-book-backend-sync-authenticate-user" role="function">
333
 
<title>e_book_backend_sync_authenticate_user ()</title>
334
 
<indexterm zone="e-book-backend-sync-authenticate-user"><primary>e_book_backend_sync_authenticate_user</primary></indexterm>
335
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_authenticate_user
336
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
337
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
338
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
339
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *user</parameter>,
340
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *passwd</parameter>,
341
 
                                                         <parameter>const <link linkend="gchar"><type>gchar</type></link> *auth_method</parameter>);</programlisting>
342
 
<para>
343
 
Authenticates <parameter>user</parameter> against <parameter>book</parameter>.</para>
344
 
<variablelist role="params">
345
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
346
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
347
 
</simpara></listitem></varlistentry>
348
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
349
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
350
 
</simpara></listitem></varlistentry>
351
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
352
 
<listitem><simpara>the unique ID of the operation
353
 
</simpara></listitem></varlistentry>
354
 
<varlistentry><term><parameter>user</parameter>&#160;:</term>
355
 
<listitem><simpara>the user's name
356
 
</simpara></listitem></varlistentry>
357
 
<varlistentry><term><parameter>passwd</parameter>&#160;:</term>
358
 
<listitem><simpara>the user's password
359
 
</simpara></listitem></varlistentry>
360
 
<varlistentry><term><parameter>auth_method</parameter>&#160;:</term>
361
 
<listitem><simpara>the authentication method desired
362
 
</simpara></listitem></varlistentry>
363
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
364
 
</simpara></listitem></varlistentry>
365
 
</variablelist></refsect2>
366
 
<refsect2 id="e-book-backend-sync-get-required-fields" role="function">
367
 
<title>e_book_backend_sync_get_required_fields ()</title>
368
 
<indexterm zone="e-book-backend-sync-get-required-fields"><primary>e_book_backend_sync_get_required_fields</primary></indexterm>
369
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_required_fields
370
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
371
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
372
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
373
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **fields</parameter>);</programlisting>
374
 
<para>
375
 
Gets a list of the fields required for all contacts in <parameter>book</parameter>. The
376
 
fields are represented by strings from <link linkend="e-contact-field-name"><type>e_contact_field_name</type></link>. The list
377
 
and its contents must be freed by the caller.</para>
378
 
<variablelist role="params">
379
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
380
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
381
 
</simpara></listitem></varlistentry>
382
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
383
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
384
 
</simpara></listitem></varlistentry>
385
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
386
 
<listitem><simpara>the unique ID of the operation
387
 
</simpara></listitem></varlistentry>
388
 
<varlistentry><term><parameter>fields</parameter>&#160;:</term>
389
 
<listitem><simpara>a pointer to a location to store the fields
390
 
</simpara></listitem></varlistentry>
391
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
392
 
</simpara></listitem></varlistentry>
393
 
</variablelist></refsect2>
394
 
<refsect2 id="e-book-backend-sync-get-supported-fields" role="function">
395
 
<title>e_book_backend_sync_get_supported_fields ()</title>
396
 
<indexterm zone="e-book-backend-sync-get-supported-fields"><primary>e_book_backend_sync_get_supported_fields</primary></indexterm>
397
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_supported_fields
398
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
399
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
400
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
401
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **fields</parameter>);</programlisting>
402
 
<para>
403
 
Gets a list of the fields supported for contacts in <parameter>book</parameter>. Other fields
404
 
may not be stored. The fields are represented by strings from <link linkend="e-contact-field-name"><type>e_contact_field_name</type></link>.
405
 
The list and its contents must be freed by the caller.</para>
406
 
<variablelist role="params">
407
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
408
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
409
 
</simpara></listitem></varlistentry>
410
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
411
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
412
 
</simpara></listitem></varlistentry>
413
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
414
 
<listitem><simpara>the unique ID of the operation
415
 
</simpara></listitem></varlistentry>
416
 
<varlistentry><term><parameter>fields</parameter>&#160;:</term>
417
 
<listitem><simpara>a pointer to a location to store the fields
418
 
</simpara></listitem></varlistentry>
419
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
420
 
</simpara></listitem></varlistentry>
421
 
</variablelist></refsect2>
422
 
<refsect2 id="e-book-backend-sync-get-supported-auth-methods" role="function">
423
 
<title>e_book_backend_sync_get_supported_auth_methods ()</title>
424
 
<indexterm zone="e-book-backend-sync-get-supported-auth-methods"><primary>e_book_backend_sync_get_supported_auth_methods</primary></indexterm>
425
 
<programlisting><link linkend="EBookBackendSyncStatus"><returnvalue>EBookBackendSyncStatus</returnvalue></link>  e_book_backend_sync_get_supported_auth_methods
426
 
                                                        (<parameter><link linkend="EBookBackendSync"><type>EBookBackendSync</type></link> *backend</parameter>,
427
 
                                                         <parameter><link linkend="EDataBook"><type>EDataBook</type></link> *book</parameter>,
428
 
                                                         <parameter><link linkend="guint32"><type>guint32</type></link> opid</parameter>,
429
 
                                                         <parameter><link linkend="GList"><type>GList</type></link> **methods</parameter>);</programlisting>
430
 
<para>
431
 
Gets a list of the authentication methods supported by <parameter>book</parameter>. The
432
 
methods are represented by strings. The list and its contents must
433
 
be freed by the caller.</para>
434
 
<variablelist role="params">
435
 
<varlistentry><term><parameter>backend</parameter>&#160;:</term>
436
 
<listitem><simpara>an <link linkend="EBookBackendSync"><type>EBookBackendSync</type></link>
437
 
</simpara></listitem></varlistentry>
438
 
<varlistentry><term><parameter>book</parameter>&#160;:</term>
439
 
<listitem><simpara>an <link linkend="EDataBook"><type>EDataBook</type></link>
440
 
</simpara></listitem></varlistentry>
441
 
<varlistentry><term><parameter>opid</parameter>&#160;:</term>
442
 
<listitem><simpara>the unique ID of the operation
443
 
</simpara></listitem></varlistentry>
444
 
<varlistentry><term><parameter>methods</parameter>&#160;:</term>
445
 
<listitem><simpara>a pointer to a location to store the methods
446
 
</simpara></listitem></varlistentry>
447
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> An <link linkend="EBookBackendSyncStatus"><type>EBookBackendSyncStatus</type></link> indicating the outcome of the operation.
448
 
</simpara></listitem></varlistentry>
449
 
</variablelist></refsect2>
450
 
 
451
 
</refsect1>
452
 
 
453
 
</refentry>