← 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/html/EDataBook.html

  • 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/html/EDataBook.html
3
3
<head>
4
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
5
<title>EDataBook</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.74.0">
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
8
8
<link rel="up" href="ch01.html" title="Evolution-Data-Server Manual: Address Book Backend (libedata-book)">
9
9
<link rel="prev" href="EBookBackendSync.html" title="EBookBackendSync">
26
26
                  <a href="#EDataBook.description" class="shortcut">Description</a>
27
27
                   | 
28
28
                  <a href="#EDataBook.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#EDataBook.signals" class="shortcut">Signals</a>
29
31
</td></tr>
30
32
</table>
31
 
<div class="refentry" lang="en">
 
33
<div class="refentry" title="EDataBook">
32
34
<a name="EDataBook"></a><div class="titlepage"></div>
33
35
<div class="refnamediv"><table width="100%"><tr>
34
36
<td valign="top">
37
39
</td>
38
40
<td valign="top" align="right"></td>
39
41
</tr></table></div>
40
 
<div class="refsynopsisdiv">
 
42
<div class="refsynopsisdiv" title="Synopsis">
41
43
<a name="EDataBook.synopsis"></a><h2>Synopsis</h2>
42
44
<pre class="synopsis">struct              <a class="link" href="EDataBook.html#EDataBook-struct" title="struct EDataBook">EDataBook</a>;
 
45
#define             <a class="link" href="EDataBook.html#E-DATA-BOOK-ERROR:CAPS" title="E_DATA_BOOK_ERROR">E_DATA_BOOK_ERROR</a>
43
46
<a class="link" href="EDataBook.html" title="EDataBook"><span class="returnvalue">EDataBook</span></a> *         <a class="link" href="EDataBook.html#e-data-book-new" title="e_data_book_new ()">e_data_book_new</a>                     (<em class="parameter"><code><a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> *backend</code></em>,
44
 
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
45
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_BookListener</span> listener</code></em>);
46
 
<span class="returnvalue">GNOME_Evolution_Addressbook_BookListener</span>  <a class="link" href="EDataBook.html#e-data-book-get-listener" title="e_data_book_get_listener ()">e_data_book_get_listener</a>
47
 
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);
 
47
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);
48
48
<a class="link" href="EBookBackend.html" title="EBookBackend"><span class="returnvalue">EBookBackend</span></a> *      <a class="link" href="EDataBook.html#e-data-book-get-backend" title="e_data_book_get_backend ()">e_data_book_get_backend</a>             (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);
49
 
<a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           <a class="link" href="EDataBook.html#e-data-book-get-source" title="e_data_book_get_source ()">e_data_book_get_source</a>              (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);
 
49
<span class="returnvalue">ESource</span> *           <a class="link" href="EDataBook.html#e-data-book-get-source" title="e_data_book_get_source ()">e_data_book_get_source</a>              (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);
50
50
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-open" title="e_data_book_respond_open ()">e_data_book_respond_open</a>            (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
51
51
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
52
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);
 
52
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);
53
53
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-remove" title="e_data_book_respond_remove ()">e_data_book_respond_remove</a>          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
54
54
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
55
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);
 
55
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);
56
56
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-create" title="e_data_book_respond_create ()">e_data_book_respond_create</a>          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
57
57
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
58
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
59
 
                                                         <em class="parameter"><code><a href="../libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);
 
58
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
 
59
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);
60
60
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-remove-contacts" title="e_data_book_respond_remove_contacts ()">e_data_book_respond_remove_contacts</a> (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
61
61
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
62
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
62
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
63
63
                                                         <em class="parameter"><code><span class="type">GList</span> *ids</code></em>);
64
64
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-modify" title="e_data_book_respond_modify ()">e_data_book_respond_modify</a>          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
65
65
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
66
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
67
 
                                                         <em class="parameter"><code><a href="../libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);
 
66
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
 
67
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);
68
68
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-authenticate-user" title="e_data_book_respond_authenticate_user ()">e_data_book_respond_authenticate_user</a>
69
69
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
70
70
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
71
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);
 
71
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);
72
72
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-supported-fields" title="e_data_book_respond_get_supported_fields ()">e_data_book_respond_get_supported_fields</a>
73
73
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
74
74
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
75
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
76
76
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);
77
77
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-required-fields" title="e_data_book_respond_get_required_fields ()">e_data_book_respond_get_required_fields</a>
78
78
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
79
79
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
80
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
80
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
81
81
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);
82
82
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-supported-auth-methods" title="e_data_book_respond_get_supported_auth_methods ()">e_data_book_respond_get_supported_auth_methods</a>
83
83
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
84
84
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
85
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
85
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
86
86
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);
87
 
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-book-view" title="e_data_book_respond_get_book_view ()">e_data_book_respond_get_book_view</a>   (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
88
 
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
89
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
90
 
                                                         <em class="parameter"><code><a class="link" href="EDataBookView.html" title="EDataBookView"><span class="type">EDataBookView</span></a> *book_view</code></em>);
91
87
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-contact" title="e_data_book_respond_get_contact ()">e_data_book_respond_get_contact</a>     (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
92
88
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
93
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
89
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
94
90
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard</code></em>);
95
91
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-contact-list" title="e_data_book_respond_get_contact_list ()">e_data_book_respond_get_contact_list</a>
96
92
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
97
93
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
98
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
94
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
99
95
                                                         <em class="parameter"><code><span class="type">GList</span> *cards</code></em>);
100
96
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-respond-get-changes" title="e_data_book_respond_get_changes ()">e_data_book_respond_get_changes</a>     (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
101
97
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
102
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
98
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
103
99
                                                         <em class="parameter"><code><span class="type">GList</span> *changes</code></em>);
104
100
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-report-writable" title="e_data_book_report_writable ()">e_data_book_report_writable</a>         (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
105
101
                                                         <em class="parameter"><code><span class="type">gboolean</span> writable</code></em>);
109
105
<span class="returnvalue">void</span>                <a class="link" href="EDataBook.html#e-data-book-report-auth-required" title="e_data_book_report_auth_required ()">e_data_book_report_auth_required</a>    (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);
110
106
</pre>
111
107
</div>
112
 
<div class="refsect1" lang="en">
 
108
<div class="refsect1" title="Object Hierarchy">
113
109
<a name="EDataBook.object-hierarchy"></a><h2>Object Hierarchy</h2>
114
110
<pre class="synopsis">
115
111
  GObject
116
 
   +----BonoboObject
117
 
         +----EDataBook
118
 
</pre>
119
 
</div>
120
 
<div class="refsect1" lang="en">
 
112
   +----EDataBook
 
113
</pre>
 
114
</div>
 
115
<div class="refsect1" title="Signals">
 
116
<a name="EDataBook.signals"></a><h2>Signals</h2>
 
117
<pre class="synopsis">
 
118
  "<a class="link" href="EDataBook.html#EDataBook-auth-required" title='The "auth-required" signal'>auth-required</a>"                                  : Run Last / Has Details
 
119
  "<a class="link" href="EDataBook.html#EDataBook-connection" title='The "connection" signal'>connection</a>"                                     : Run Last / Has Details
 
120
  "<a class="link" href="EDataBook.html#EDataBook-writable" title='The "writable" signal'>writable</a>"                                       : Run Last / Has Details
 
121
</pre>
 
122
</div>
 
123
<div class="refsect1" title="Description">
121
124
<a name="EDataBook.description"></a><h2>Description</h2>
122
125
<p>
123
126
</p>
124
127
</div>
125
 
<div class="refsect1" lang="en">
 
128
<div class="refsect1" title="Details">
126
129
<a name="EDataBook.details"></a><h2>Details</h2>
127
 
<div class="refsect2" lang="en">
 
130
<div class="refsect2" title="struct EDataBook">
128
131
<a name="EDataBook-struct"></a><h3>struct EDataBook</h3>
129
132
<pre class="programlisting">struct EDataBook;</pre>
130
133
<p>
131
134
</p>
132
135
</div>
133
136
<hr>
134
 
<div class="refsect2" lang="en">
 
137
<div class="refsect2" title="E_DATA_BOOK_ERROR">
 
138
<a name="E-DATA-BOOK-ERROR:CAPS"></a><h3>E_DATA_BOOK_ERROR</h3>
 
139
<pre class="programlisting">#define E_DATA_BOOK_ERROR e_data_book_error_quark ()
 
140
</pre>
 
141
<p class="since">Since 2.30</p>
 
142
</div>
 
143
<hr>
 
144
<div class="refsect2" title="e_data_book_new ()">
135
145
<a name="e-data-book-new"></a><h3>e_data_book_new ()</h3>
136
146
<pre class="programlisting"><a class="link" href="EDataBook.html" title="EDataBook"><span class="returnvalue">EDataBook</span></a> *         e_data_book_new                     (<em class="parameter"><code><a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> *backend</code></em>,
137
 
                                                         <em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
138
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_BookListener</span> listener</code></em>);</pre>
 
147
                                                         <em class="parameter"><code><span class="type">ESource</span> *source</code></em>);</pre>
139
148
<p>
140
 
Create a new <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> using <em class="parameter"><code>backend</code></em> for storage, <em class="parameter"><code>source</code></em> as the
141
 
storage location and <em class="parameter"><code>listener</code></em> for reporting status.</p>
 
149
</p>
142
150
<div class="variablelist"><table border="0">
143
151
<col align="left" valign="top">
144
152
<tbody>
145
153
<tr>
146
154
<td><p><span class="term"><em class="parameter"><code>backend</code></em> :</span></p></td>
147
 
<td>an <a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a>
 
155
<td>
148
156
</td>
149
157
</tr>
150
158
<tr>
151
159
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
152
 
<td>an <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>
153
 
</td>
154
 
</tr>
155
 
<tr>
156
 
<td><p><span class="term"><em class="parameter"><code>listener</code></em> :</span></p></td>
157
 
<td>a <span class="type">GNOME_Evolution_Addressbook_BookListener</span> CORBA object
158
 
</td>
159
 
</tr>
160
 
<tr>
161
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
162
 
<td> A new <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>.
163
 
</td>
164
 
</tr>
165
 
</tbody>
166
 
</table></div>
167
 
</div>
168
 
<hr>
169
 
<div class="refsect2" lang="en">
170
 
<a name="e-data-book-get-listener"></a><h3>e_data_book_get_listener ()</h3>
171
 
<pre class="programlisting"><span class="returnvalue">GNOME_Evolution_Addressbook_BookListener</span>  e_data_book_get_listener
172
 
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);</pre>
173
 
<p>
174
 
Gets the CORBA listener associated with <em class="parameter"><code>book</code></em>.</p>
175
 
<div class="variablelist"><table border="0">
176
 
<col align="left" valign="top">
177
 
<tbody>
178
 
<tr>
179
 
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
180
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
181
 
</td>
182
 
</tr>
183
 
<tr>
184
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
185
 
<td> A <span class="type">GNOME_Evolution_Addressbook_BookListener</span>.
186
 
</td>
187
 
</tr>
188
 
</tbody>
189
 
</table></div>
190
 
</div>
191
 
<hr>
192
 
<div class="refsect2" lang="en">
 
160
<td>
 
161
</td>
 
162
</tr>
 
163
<tr>
 
164
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
165
<td>
 
166
</td>
 
167
</tr>
 
168
</tbody>
 
169
</table></div>
 
170
</div>
 
171
<hr>
 
172
<div class="refsect2" title="e_data_book_get_backend ()">
193
173
<a name="e-data-book-get-backend"></a><h3>e_data_book_get_backend ()</h3>
194
174
<pre class="programlisting"><a class="link" href="EBookBackend.html" title="EBookBackend"><span class="returnvalue">EBookBackend</span></a> *      e_data_book_get_backend             (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);</pre>
195
175
<p>
196
 
Gets the <a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> being used to store data for <em class="parameter"><code>book</code></em>.</p>
 
176
</p>
197
177
<div class="variablelist"><table border="0">
198
178
<col align="left" valign="top">
199
179
<tbody>
200
180
<tr>
201
181
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
202
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
182
<td>
203
183
</td>
204
184
</tr>
205
185
<tr>
206
186
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
207
 
<td> The <a class="link" href="EBookBackend.html" title="EBookBackend"><span class="type">EBookBackend</span></a> being used.
 
187
<td>
208
188
</td>
209
189
</tr>
210
190
</tbody>
211
191
</table></div>
212
192
</div>
213
193
<hr>
214
 
<div class="refsect2" lang="en">
 
194
<div class="refsect2" title="e_data_book_get_source ()">
215
195
<a name="e-data-book-get-source"></a><h3>e_data_book_get_source ()</h3>
216
 
<pre class="programlisting"><a href="../libedataserver/ESource.html"><span class="returnvalue">ESource</span></a> *           e_data_book_get_source              (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);</pre>
 
196
<pre class="programlisting"><span class="returnvalue">ESource</span> *           e_data_book_get_source              (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);</pre>
217
197
<p>
218
 
Gets the <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> associated with <em class="parameter"><code>book</code></em>.</p>
 
198
</p>
219
199
<div class="variablelist"><table border="0">
220
200
<col align="left" valign="top">
221
201
<tbody>
222
202
<tr>
223
203
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
224
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
204
<td>
225
205
</td>
226
206
</tr>
227
207
<tr>
228
208
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
229
 
<td> An <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a>.
 
209
<td>
230
210
</td>
231
211
</tr>
232
212
</tbody>
233
213
</table></div>
234
214
</div>
235
215
<hr>
236
 
<div class="refsect2" lang="en">
 
216
<div class="refsect2" title="e_data_book_respond_open ()">
237
217
<a name="e-data-book-respond-open"></a><h3>e_data_book_respond_open ()</h3>
238
218
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_open            (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
239
219
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
240
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);</pre>
 
220
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);</pre>
241
221
<p>
242
 
Respond to an 'open' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
243
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
222
</p>
244
223
<div class="variablelist"><table border="0">
245
224
<col align="left" valign="top">
246
225
<tbody>
247
226
<tr>
248
227
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
249
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
228
<td>
250
229
</td>
251
230
</tr>
252
231
<tr>
253
232
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
254
 
<td>the operation ID that generated the response
 
233
<td>
255
234
</td>
256
235
</tr>
257
236
<tr>
258
237
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
259
 
<td>the outcome of the operation
 
238
<td>
260
239
</td>
261
240
</tr>
262
241
</tbody>
263
242
</table></div>
264
243
</div>
265
244
<hr>
266
 
<div class="refsect2" lang="en">
 
245
<div class="refsect2" title="e_data_book_respond_remove ()">
267
246
<a name="e-data-book-respond-remove"></a><h3>e_data_book_respond_remove ()</h3>
268
247
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_remove          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
269
248
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
270
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);</pre>
 
249
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);</pre>
271
250
<p>
272
 
Respond to a 'remove' request to remove all of <em class="parameter"><code>book</code></em>'s data,
273
 
specified by <em class="parameter"><code>opid</code></em>, indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
251
</p>
274
252
<div class="variablelist"><table border="0">
275
253
<col align="left" valign="top">
276
254
<tbody>
277
255
<tr>
278
256
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
279
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
257
<td>
280
258
</td>
281
259
</tr>
282
260
<tr>
283
261
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
284
 
<td>the operation ID that generated the response
 
262
<td>
285
263
</td>
286
264
</tr>
287
265
<tr>
288
266
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
289
 
<td>the outcome of the operation
 
267
<td>
290
268
</td>
291
269
</tr>
292
270
</tbody>
293
271
</table></div>
294
272
</div>
295
273
<hr>
296
 
<div class="refsect2" lang="en">
 
274
<div class="refsect2" title="e_data_book_respond_create ()">
297
275
<a name="e-data-book-respond-create"></a><h3>e_data_book_respond_create ()</h3>
298
276
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_create          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
299
277
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
300
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
301
 
                                                         <em class="parameter"><code><a href="../libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);</pre>
 
278
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
 
279
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);</pre>
302
280
<p>
303
 
Respond to a 'create' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
304
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
281
</p>
305
282
<div class="variablelist"><table border="0">
306
283
<col align="left" valign="top">
307
284
<tbody>
308
285
<tr>
309
286
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
310
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
287
<td>
311
288
</td>
312
289
</tr>
313
290
<tr>
314
291
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
315
 
<td>the operation ID that generated the response
 
292
<td>
316
293
</td>
317
294
</tr>
318
295
<tr>
319
296
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
320
 
<td>the outcome of the operation
 
297
<td>
321
298
</td>
322
299
</tr>
323
300
<tr>
324
301
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
325
 
<td>the contact created, or <code class="literal">NULL</code>
 
302
<td>
326
303
</td>
327
304
</tr>
328
305
</tbody>
329
306
</table></div>
330
307
</div>
331
308
<hr>
332
 
<div class="refsect2" lang="en">
 
309
<div class="refsect2" title="e_data_book_respond_remove_contacts ()">
333
310
<a name="e-data-book-respond-remove-contacts"></a><h3>e_data_book_respond_remove_contacts ()</h3>
334
311
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_remove_contacts (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
335
312
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
336
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
313
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
337
314
                                                         <em class="parameter"><code><span class="type">GList</span> *ids</code></em>);</pre>
338
315
<p>
339
 
Respond to a 'remove contacts' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
340
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
316
</p>
341
317
<div class="variablelist"><table border="0">
342
318
<col align="left" valign="top">
343
319
<tbody>
344
320
<tr>
345
321
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
346
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
322
<td>
347
323
</td>
348
324
</tr>
349
325
<tr>
350
326
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
351
 
<td>the operation ID that generated the response
 
327
<td>
352
328
</td>
353
329
</tr>
354
330
<tr>
355
331
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
356
 
<td>the outcome of the operation
 
332
<td>
357
333
</td>
358
334
</tr>
359
335
<tr>
360
336
<td><p><span class="term"><em class="parameter"><code>ids</code></em> :</span></p></td>
361
 
<td>a list of contact IDs removed
 
337
<td>
362
338
</td>
363
339
</tr>
364
340
</tbody>
365
341
</table></div>
366
342
</div>
367
343
<hr>
368
 
<div class="refsect2" lang="en">
 
344
<div class="refsect2" title="e_data_book_respond_modify ()">
369
345
<a name="e-data-book-respond-modify"></a><h3>e_data_book_respond_modify ()</h3>
370
346
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_modify          (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
371
347
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
372
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
373
 
                                                         <em class="parameter"><code><a href="../libebook/EContact.html"><span class="type">EContact</span></a> *contact</code></em>);</pre>
 
348
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
 
349
                                                         <em class="parameter"><code><span class="type">EContact</span> *contact</code></em>);</pre>
374
350
<p>
375
 
Respond to a 'modify' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
376
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
351
</p>
377
352
<div class="variablelist"><table border="0">
378
353
<col align="left" valign="top">
379
354
<tbody>
380
355
<tr>
381
356
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
382
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
357
<td>
383
358
</td>
384
359
</tr>
385
360
<tr>
386
361
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
387
 
<td>the operation ID that generated the response
 
362
<td>
388
363
</td>
389
364
</tr>
390
365
<tr>
391
366
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
392
 
<td>the outcome of the operation
 
367
<td>
393
368
</td>
394
369
</tr>
395
370
<tr>
396
371
<td><p><span class="term"><em class="parameter"><code>contact</code></em> :</span></p></td>
397
 
<td>the modified <a href="../libebook/EContact.html"><span class="type">EContact</span></a>
 
372
<td>
398
373
</td>
399
374
</tr>
400
375
</tbody>
401
376
</table></div>
402
377
</div>
403
378
<hr>
404
 
<div class="refsect2" lang="en">
 
379
<div class="refsect2" title="e_data_book_respond_authenticate_user ()">
405
380
<a name="e-data-book-respond-authenticate-user"></a><h3>e_data_book_respond_authenticate_user ()</h3>
406
381
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_authenticate_user
407
382
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
408
383
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
409
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>);</pre>
 
384
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>);</pre>
410
385
<p>
411
 
Respond to an 'authenticate' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
412
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
386
</p>
413
387
<div class="variablelist"><table border="0">
414
388
<col align="left" valign="top">
415
389
<tbody>
416
390
<tr>
417
391
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
418
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
392
<td>
419
393
</td>
420
394
</tr>
421
395
<tr>
422
396
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
423
 
<td>the operation ID that generated the response
 
397
<td>
424
398
</td>
425
399
</tr>
426
400
<tr>
427
401
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
428
 
<td>the outcome of the operation
 
402
<td>
429
403
</td>
430
404
</tr>
431
405
</tbody>
432
406
</table></div>
433
407
</div>
434
408
<hr>
435
 
<div class="refsect2" lang="en">
 
409
<div class="refsect2" title="e_data_book_respond_get_supported_fields ()">
436
410
<a name="e-data-book-respond-get-supported-fields"></a><h3>e_data_book_respond_get_supported_fields ()</h3>
437
411
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_supported_fields
438
412
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
439
413
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
440
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
414
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
441
415
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);</pre>
442
416
<p>
443
 
Respond to a 'get supported fields' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
444
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
417
</p>
445
418
<div class="variablelist"><table border="0">
446
419
<col align="left" valign="top">
447
420
<tbody>
448
421
<tr>
449
422
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
450
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
423
<td>
451
424
</td>
452
425
</tr>
453
426
<tr>
454
427
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
455
 
<td>the operation ID that generated the response
 
428
<td>
456
429
</td>
457
430
</tr>
458
431
<tr>
459
432
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
460
 
<td>the outcome of the operation
 
433
<td>
461
434
</td>
462
435
</tr>
463
436
<tr>
464
437
<td><p><span class="term"><em class="parameter"><code>fields</code></em> :</span></p></td>
465
 
<td>a list of supported field names
 
438
<td>
466
439
</td>
467
440
</tr>
468
441
</tbody>
469
442
</table></div>
470
443
</div>
471
444
<hr>
472
 
<div class="refsect2" lang="en">
 
445
<div class="refsect2" title="e_data_book_respond_get_required_fields ()">
473
446
<a name="e-data-book-respond-get-required-fields"></a><h3>e_data_book_respond_get_required_fields ()</h3>
474
447
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_required_fields
475
448
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
476
449
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
477
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
450
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
478
451
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);</pre>
479
452
<p>
480
 
Respond to a 'get required fields' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
481
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
453
</p>
482
454
<div class="variablelist"><table border="0">
483
455
<col align="left" valign="top">
484
456
<tbody>
485
457
<tr>
486
458
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
487
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
459
<td>
488
460
</td>
489
461
</tr>
490
462
<tr>
491
463
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
492
 
<td>the operation ID that generated the response
 
464
<td>
493
465
</td>
494
466
</tr>
495
467
<tr>
496
468
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
497
 
<td>the outcome of the operation
 
469
<td>
498
470
</td>
499
471
</tr>
500
472
<tr>
501
473
<td><p><span class="term"><em class="parameter"><code>fields</code></em> :</span></p></td>
502
 
<td>a list of required field names
 
474
<td>
503
475
</td>
504
476
</tr>
505
477
</tbody>
506
478
</table></div>
507
479
</div>
508
480
<hr>
509
 
<div class="refsect2" lang="en">
 
481
<div class="refsect2" title="e_data_book_respond_get_supported_auth_methods ()">
510
482
<a name="e-data-book-respond-get-supported-auth-methods"></a><h3>e_data_book_respond_get_supported_auth_methods ()</h3>
511
483
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_supported_auth_methods
512
484
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
513
485
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
514
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
486
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
515
487
                                                         <em class="parameter"><code><span class="type">GList</span> *fields</code></em>);</pre>
516
488
<p>
517
 
Respond to a 'get supported auth methods' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
518
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
489
</p>
519
490
<div class="variablelist"><table border="0">
520
491
<col align="left" valign="top">
521
492
<tbody>
522
493
<tr>
523
494
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
524
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
495
<td>
525
496
</td>
526
497
</tr>
527
498
<tr>
528
499
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
529
 
<td>the operation ID that generated the response
 
500
<td>
530
501
</td>
531
502
</tr>
532
503
<tr>
533
504
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
534
 
<td>the outcome of the operation
 
505
<td>
535
506
</td>
536
507
</tr>
537
508
<tr>
543
514
</table></div>
544
515
</div>
545
516
<hr>
546
 
<div class="refsect2" lang="en">
547
 
<a name="e-data-book-respond-get-book-view"></a><h3>e_data_book_respond_get_book_view ()</h3>
548
 
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_book_view   (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
549
 
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
550
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
551
 
                                                         <em class="parameter"><code><a class="link" href="EDataBookView.html" title="EDataBookView"><span class="type">EDataBookView</span></a> *book_view</code></em>);</pre>
552
 
<p>
553
 
Respond to a 'get book view' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
554
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
555
 
<div class="variablelist"><table border="0">
556
 
<col align="left" valign="top">
557
 
<tbody>
558
 
<tr>
559
 
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
560
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
561
 
</td>
562
 
</tr>
563
 
<tr>
564
 
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
565
 
<td>the operation ID that generated the response
566
 
</td>
567
 
</tr>
568
 
<tr>
569
 
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
570
 
<td>the outcome of the operation
571
 
</td>
572
 
</tr>
573
 
<tr>
574
 
<td><p><span class="term"><em class="parameter"><code>book_view</code></em> :</span></p></td>
575
 
<td>the <a class="link" href="EDataBookView.html" title="EDataBookView"><span class="type">EDataBookView</span></a> created
576
 
</td>
577
 
</tr>
578
 
</tbody>
579
 
</table></div>
580
 
</div>
581
 
<hr>
582
 
<div class="refsect2" lang="en">
 
517
<div class="refsect2" title="e_data_book_respond_get_contact ()">
583
518
<a name="e-data-book-respond-get-contact"></a><h3>e_data_book_respond_get_contact ()</h3>
584
519
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_contact     (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
585
520
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
586
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
521
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
587
522
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *vcard</code></em>);</pre>
588
523
<p>
589
 
Respond to a 'get contact' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
590
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
524
</p>
591
525
<div class="variablelist"><table border="0">
592
526
<col align="left" valign="top">
593
527
<tbody>
594
528
<tr>
595
529
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
596
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
530
<td>
597
531
</td>
598
532
</tr>
599
533
<tr>
600
534
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
601
 
<td>the operation ID that generated the response
 
535
<td>
602
536
</td>
603
537
</tr>
604
538
<tr>
605
539
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
606
 
<td>the outcome of the operation
 
540
<td>
607
541
</td>
608
542
</tr>
609
543
<tr>
610
544
<td><p><span class="term"><em class="parameter"><code>vcard</code></em> :</span></p></td>
611
 
<td>the found VCard, or <code class="literal">NULL</code>
 
545
<td>
612
546
</td>
613
547
</tr>
614
548
</tbody>
615
549
</table></div>
616
550
</div>
617
551
<hr>
618
 
<div class="refsect2" lang="en">
 
552
<div class="refsect2" title="e_data_book_respond_get_contact_list ()">
619
553
<a name="e-data-book-respond-get-contact-list"></a><h3>e_data_book_respond_get_contact_list ()</h3>
620
554
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_contact_list
621
555
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
622
556
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
623
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
557
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
624
558
                                                         <em class="parameter"><code><span class="type">GList</span> *cards</code></em>);</pre>
625
559
<p>
626
 
Respond to a 'get contact list' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
627
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
560
</p>
628
561
<div class="variablelist"><table border="0">
629
562
<col align="left" valign="top">
630
563
<tbody>
631
564
<tr>
632
565
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
633
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
566
<td>
634
567
</td>
635
568
</tr>
636
569
<tr>
637
570
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
638
 
<td>the operation ID that generated the response
 
571
<td>
639
572
</td>
640
573
</tr>
641
574
<tr>
642
575
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
643
 
<td>the outcome of the operation
 
576
<td>
644
577
</td>
645
578
</tr>
646
579
<tr>
652
585
</table></div>
653
586
</div>
654
587
<hr>
655
 
<div class="refsect2" lang="en">
 
588
<div class="refsect2" title="e_data_book_respond_get_changes ()">
656
589
<a name="e-data-book-respond-get-changes"></a><h3>e_data_book_respond_get_changes ()</h3>
657
590
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_respond_get_changes     (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
658
591
                                                         <em class="parameter"><code><span class="type">guint32</span> opid</code></em>,
659
 
                                                         <em class="parameter"><code><span class="type">GNOME_Evolution_Addressbook_CallStatus</span> status</code></em>,
 
592
                                                         <em class="parameter"><code><span class="type">EDataBookStatus</span> status</code></em>,
660
593
                                                         <em class="parameter"><code><span class="type">GList</span> *changes</code></em>);</pre>
661
594
<p>
662
 
Respond to a 'get changes' request specified by <em class="parameter"><code>opid</code></em> on <em class="parameter"><code>book</code></em>,
663
 
indicating <em class="parameter"><code>status</code></em> as the outcome.</p>
 
595
</p>
664
596
<div class="variablelist"><table border="0">
665
597
<col align="left" valign="top">
666
598
<tbody>
667
599
<tr>
668
600
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
669
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
601
<td>
670
602
</td>
671
603
</tr>
672
604
<tr>
673
605
<td><p><span class="term"><em class="parameter"><code>opid</code></em> :</span></p></td>
674
 
<td>the operation ID that generated the response
 
606
<td>
675
607
</td>
676
608
</tr>
677
609
<tr>
678
610
<td><p><span class="term"><em class="parameter"><code>status</code></em> :</span></p></td>
679
 
<td>the outcome of the operation
 
611
<td>
680
612
</td>
681
613
</tr>
682
614
<tr>
683
615
<td><p><span class="term"><em class="parameter"><code>changes</code></em> :</span></p></td>
684
 
<td>a list of GNOME_Evolution_Addressbook_BookChangeItem items
 
616
<td>
685
617
</td>
686
618
</tr>
687
619
</tbody>
688
620
</table></div>
689
621
</div>
690
622
<hr>
691
 
<div class="refsect2" lang="en">
 
623
<div class="refsect2" title="e_data_book_report_writable ()">
692
624
<a name="e-data-book-report-writable"></a><h3>e_data_book_report_writable ()</h3>
693
625
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_report_writable         (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
694
626
                                                         <em class="parameter"><code><span class="type">gboolean</span> writable</code></em>);</pre>
695
627
<p>
696
 
Notify listeners that <em class="parameter"><code>book</code></em>'s writeable status has changed
697
 
to <em class="parameter"><code>writable</code></em>.</p>
 
628
</p>
698
629
<div class="variablelist"><table border="0">
699
630
<col align="left" valign="top">
700
631
<tbody>
701
632
<tr>
702
633
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
703
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
634
<td>
704
635
</td>
705
636
</tr>
706
637
<tr>
707
638
<td><p><span class="term"><em class="parameter"><code>writable</code></em> :</span></p></td>
708
639
<td>
709
 
<code class="literal">TRUE</code> if <em class="parameter"><code>book</code></em> is writeable, <code class="literal">FALSE</code> otherwise
710
640
</td>
711
641
</tr>
712
642
</tbody>
713
643
</table></div>
714
644
</div>
715
645
<hr>
716
 
<div class="refsect2" lang="en">
 
646
<div class="refsect2" title="e_data_book_report_connection_status ()">
717
647
<a name="e-data-book-report-connection-status"></a><h3>e_data_book_report_connection_status ()</h3>
718
648
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_report_connection_status
719
649
                                                        (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>,
720
650
                                                         <em class="parameter"><code><span class="type">gboolean</span> is_online</code></em>);</pre>
721
651
<p>
722
 
Notify listeners that <em class="parameter"><code>book</code></em> requires authentication.</p>
 
652
</p>
723
653
<div class="variablelist"><table border="0">
724
654
<col align="left" valign="top">
725
655
<tbody>
726
656
<tr>
727
657
<td><p><span class="term"><em class="parameter"><code>book</code></em> :</span></p></td>
728
 
<td>an <a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a>
 
658
<td>
729
659
</td>
730
660
</tr>
731
661
<tr>
737
667
</table></div>
738
668
</div>
739
669
<hr>
740
 
<div class="refsect2" lang="en">
 
670
<div class="refsect2" title="e_data_book_report_auth_required ()">
741
671
<a name="e-data-book-report-auth-required"></a><h3>e_data_book_report_auth_required ()</h3>
742
672
<pre class="programlisting"><span class="returnvalue">void</span>                e_data_book_report_auth_required    (<em class="parameter"><code><a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *book</code></em>);</pre>
743
673
<p>
752
682
</table></div>
753
683
</div>
754
684
</div>
 
685
<div class="refsect1" title="Signal Details">
 
686
<a name="EDataBook.signal-details"></a><h2>Signal Details</h2>
 
687
<div class="refsect2" title='The "auth-required" signal'>
 
688
<a name="EDataBook-auth-required"></a><h3>The <code class="literal">"auth-required"</code> signal</h3>
 
689
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *edatabook,
 
690
                                                        <span class="type">gpointer</span>   user_data)      : Run Last / Has Details</pre>
 
691
<p>
 
692
</p>
 
693
<div class="variablelist"><table border="0">
 
694
<col align="left" valign="top">
 
695
<tbody>
 
696
<tr>
 
697
<td><p><span class="term"><em class="parameter"><code>edatabook</code></em> :</span></p></td>
 
698
<td>the object which received the signal.
 
699
</td>
 
700
</tr>
 
701
<tr>
 
702
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
703
<td>user data set when the signal handler was connected.</td>
 
704
</tr>
 
705
</tbody>
 
706
</table></div>
 
707
</div>
 
708
<hr>
 
709
<div class="refsect2" title='The "connection" signal'>
 
710
<a name="EDataBook-connection"></a><h3>The <code class="literal">"connection"</code> signal</h3>
 
711
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *edatabook,
 
712
                                                        <span class="type">gboolean</span>   arg1,
 
713
                                                        <span class="type">gpointer</span>   user_data)      : Run Last / Has Details</pre>
 
714
<p>
 
715
</p>
 
716
<div class="variablelist"><table border="0">
 
717
<col align="left" valign="top">
 
718
<tbody>
 
719
<tr>
 
720
<td><p><span class="term"><em class="parameter"><code>edatabook</code></em> :</span></p></td>
 
721
<td>the object which received the signal.
 
722
</td>
 
723
</tr>
 
724
<tr>
 
725
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
 
726
<td>
 
727
</td>
 
728
</tr>
 
729
<tr>
 
730
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
731
<td>user data set when the signal handler was connected.</td>
 
732
</tr>
 
733
</tbody>
 
734
</table></div>
 
735
</div>
 
736
<hr>
 
737
<div class="refsect2" title='The "writable" signal'>
 
738
<a name="EDataBook-writable"></a><h3>The <code class="literal">"writable"</code> signal</h3>
 
739
<pre class="programlisting"><span class="returnvalue">void</span>                user_function                      (<a class="link" href="EDataBook.html" title="EDataBook"><span class="type">EDataBook</span></a> *edatabook,
 
740
                                                        <span class="type">gboolean</span>   arg1,
 
741
                                                        <span class="type">gpointer</span>   user_data)      : Run Last / Has Details</pre>
 
742
<p>
 
743
</p>
 
744
<div class="variablelist"><table border="0">
 
745
<col align="left" valign="top">
 
746
<tbody>
 
747
<tr>
 
748
<td><p><span class="term"><em class="parameter"><code>edatabook</code></em> :</span></p></td>
 
749
<td>the object which received the signal.
 
750
</td>
 
751
</tr>
 
752
<tr>
 
753
<td><p><span class="term"><em class="parameter"><code>arg1</code></em> :</span></p></td>
 
754
<td>
 
755
</td>
 
756
</tr>
 
757
<tr>
 
758
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
759
<td>user data set when the signal handler was connected.</td>
 
760
</tr>
 
761
</tbody>
 
762
</table></div>
 
763
</div>
 
764
</div>
755
765
</div>
756
766
<div class="footer">
757
767
<hr>