← Back to branch summary

~ubuntu-branches/ubuntu/natty/evolution-data-server/natty

« 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): Sebastien Bacher
  • Date: 2010-03-01 22:47:15 UTC
  • mfrom: (1.1.77 upstream)
  • Revision ID: james.westby@ubuntu.com-20100301224715-drsxc2y3t8anz3c0
Tags: 2.28.3-0ubuntu1
https://launchpad.net/bugs/455020
https://launchpad.net/bugs/475147
https://launchpad.net/bugs/305428
https://launchpad.net/bugs/341909
https://launchpad.net/bugs/444177
* New upstream version:
  Bug Fixes:
  - #602723 - Contact list name doesn't get displayed in 'To' dialog 
  - #600322 - assertion failed: (reply == msg) in cs_waitinfo()
              (lp: #455020, #475147)
  - #564727 - Few memory leaks (lp: #305428)
  - #574940 - Always ref returned info from message_info_from_uid 
              (lp: #341909)
  - #429317 - Use the relative URI returned if the server 
              re-directs a request
  - #602820 - Test validity of a book_view before using it in LDAP 
  - #590762 - Recurring google calendar items are not changeable
  - #604236 - Slow GPG processing 
  - #597816 - Do not crash on incorrect parameters used in sexp to SQL 
              (lp: #444177)
  - #604544 - Try Exchange fallback authentication only once 
  - #600778 - Fix --enable-e2k-debug configure option resolution 
  - #260407 - 'endswith' address book search doesn't work 
  - #549221 - (bnc) delete, sync flags immediately
* debian/patches/99_reconfigure.patch:
  - new version update

Show diffs side-by-side

added added

removed removed

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