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

« back to all changes in this revision

Viewing changes to docs/reference/addressbook/libebook/html/EBookClient.html

  • Committer: Package Import Robot
  • Author(s): Chris Coulson
  • Date: 2012-10-08 12:58:16 UTC
  • mfrom: (181.1.7 quantal)
  • Revision ID: package-import@ubuntu.com-20121008125816-i3n76e8c0m64e7xp
Tags: 3.6.0-0ubuntu2
* Fix LP: #1038047 part 1 - Don't abort in e_source_registry_new* when a
  problem occurs connecting to the Dbus service
  - add debian/patches/dont-abort-in-e_source_registry_new.patch
  - update debian/patches/series
* Fix LP: #1038047 part 2 - libedataserver depends on
  evolution-data-server-common to ensure that the GSettings schemas are
  present
  - update debian/control

Show diffs side-by-side

added added

removed removed

Lines of Context:
48
48
<span class="returnvalue">GError</span> *            <a class="link" href="EBookClient.html#e-book-client-error-create" title="e_book_client_error_create ()">e_book_client_error_create</a>          (<em class="parameter"><code><a class="link" href="EBookClient.html#EBookClientError" title="enum EBookClientError"><span class="type">EBookClientError</span></a> code</code></em>,
49
49
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *custom_msg</code></em>);
50
50
struct              <a class="link" href="EBookClient.html#EBookClient-struct" title="struct EBookClient">EBookClient</a>;
51
 
<a class="link" href="EBookClient.html" title="EBookClient"><span class="returnvalue">EBookClient</span></a> *       <a class="link" href="EBookClient.html#e-book-client-new" title="e_book_client_new ()">e_book_client_new</a>                   (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
 
51
<a class="link" href="EBookClient.html" title="EBookClient"><span class="returnvalue">EBookClient</span></a> *       <a class="link" href="EBookClient.html#e-book-client-new" title="e_book_client_new ()">e_book_client_new</a>                   (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
52
52
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
53
53
<span class="returnvalue">gboolean</span>            <a class="link" href="EBookClient.html#e-book-client-get-self" title="e_book_client_get_self ()">e_book_client_get_self</a>              (<em class="parameter"><code><span class="type">ESourceRegistry</span> *registry</code></em>,
54
54
                                                         <em class="parameter"><code><a class="link" href="EContact.html" title="EContact"><span class="type">EContact</span></a> **contact</code></em>,
214
214
<a name="EBookClient.object-hierarchy"></a><h2>Object Hierarchy</h2>
215
215
<pre class="synopsis">
216
216
  GObject
217
 
   +----EClient
 
217
   +----<a href="../libedataserver/EClient.html">EClient</a>
218
218
         +----EBookClient
219
219
</pre>
220
220
</div>
329
329
<hr>
330
330
<div class="refsect2">
331
331
<a name="e-book-client-new"></a><h3>e_book_client_new ()</h3>
332
 
<pre class="programlisting"><a class="link" href="EBookClient.html" title="EBookClient"><span class="returnvalue">EBookClient</span></a> *       e_book_client_new                   (<em class="parameter"><code><span class="type">ESource</span> *source</code></em>,
 
332
<pre class="programlisting"><a class="link" href="EBookClient.html" title="EBookClient"><span class="returnvalue">EBookClient</span></a> *       e_book_client_new                   (<em class="parameter"><code><a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> *source</code></em>,
333
333
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
334
334
<p>
335
335
Creates a new <a class="link" href="EBookClient.html" title="EBookClient"><span class="type">EBookClient</span></a> corresponding to the given source.  There are
336
336
only two operations that are valid on this book at this point:
337
 
<code class="function">e_client_open()</code>, and <code class="function">e_client_remove()</code>.
 
337
<a href="../libedataserver/EClient.html#e-client-open"><code class="function">e_client_open()</code></a>, and <a href="../libedataserver/EClient.html#e-client-remove"><code class="function">e_client_remove()</code></a>.
338
338
</p>
339
339
<div class="variablelist"><table border="0">
340
340
<col align="left" valign="top">
341
341
<tbody>
342
342
<tr>
343
343
<td><p><span class="term"><em class="parameter"><code>source</code></em> :</span></p></td>
344
 
<td>An <span class="type">ESource</span> pointer</td>
 
344
<td>An <a href="../libedataserver/ESource.html"><span class="type">ESource</span></a> pointer</td>
345
345
</tr>
346
346
<tr>
347
347
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
656
656
<p>
657
657
Finishes previous call of <a class="link" href="EBookClient.html#e-book-client-add-contacts" title="e_book_client_add_contacts ()"><code class="function">e_book_client_add_contacts()</code></a> and
658
658
sets <em class="parameter"><code>added_uids</code></em> to the UIDs of newly added contacts if successful.
659
 
This <span class="type">GSList</span> should be freed with <code class="function">e_client_util_free_string_slist()</code>.
 
659
This <span class="type">GSList</span> should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-string-slist"><code class="function">e_client_util_free_string_slist()</code></a>.
660
660
</p>
661
661
<p>
662
662
If any of the contacts cannot be inserted, all of the insertions will be
709
709
<p>
710
710
Adds <em class="parameter"><code>contacts</code></em> to <em class="parameter"><code>client</code></em> and
711
711
sets <em class="parameter"><code>added_uids</code></em> to the UIDs of newly added contacts if successful.
712
 
This <span class="type">GSList</span> should be freed with <code class="function">e_client_util_free_string_slist()</code>.
 
712
This <span class="type">GSList</span> should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-string-slist"><code class="function">e_client_util_free_string_slist()</code></a>.
713
713
</p>
714
714
<p>
715
715
If any of the contacts cannot be inserted, all of the insertions will be
1568
1568
<p>
1569
1569
Finishes previous call of <a class="link" href="EBookClient.html#e-book-client-get-contacts" title="e_book_client_get_contacts ()"><code class="function">e_book_client_get_contacts()</code></a>.
1570
1570
If successful, then the <em class="parameter"><code>contacts</code></em> is set to newly allocated list of <span class="type">EContact-s</span>,
1571
 
which should be freed with <code class="function">e_client_util_free_object_slist()</code>.
 
1571
which should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-object-slist"><code class="function">e_client_util_free_object_slist()</code></a>.
1572
1572
</p>
1573
1573
<div class="variablelist"><table border="0">
1574
1574
<col align="left" valign="top">
1613
1613
<p>
1614
1614
Query <em class="parameter"><code>client</code></em> with <em class="parameter"><code>sexp</code></em>, receiving a list of contacts which matched.
1615
1615
If successful, then the <em class="parameter"><code>contacts</code></em> is set to newly allocated <span class="type">GSList</span> of
1616
 
<span class="type">EContact-s</span>, which should be freed with <code class="function">e_client_util_free_object_slist()</code>.
 
1616
<span class="type">EContact-s</span>, which should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-object-slist"><code class="function">e_client_util_free_object_slist()</code></a>.
1617
1617
</p>
1618
1618
<p>
1619
1619
Note: <em class="parameter"><code>sexp</code></em> can be obtained through <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a>, by converting it
1713
1713
<p>
1714
1714
Finishes previous call of <a class="link" href="EBookClient.html#e-book-client-get-contacts-uids" title="e_book_client_get_contacts_uids ()"><code class="function">e_book_client_get_contacts_uids()</code></a>.
1715
1715
If successful, then the <em class="parameter"><code>contacts_uids</code></em> is set to newly allocated list
1716
 
of UID strings, which should be freed with <code class="function">e_client_util_free_string_slist()</code>.
 
1716
of UID strings, which should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-string-slist"><code class="function">e_client_util_free_string_slist()</code></a>.
1717
1717
</p>
1718
1718
<div class="variablelist"><table border="0">
1719
1719
<col align="left" valign="top">
1759
1759
<p>
1760
1760
Query <em class="parameter"><code>client</code></em> with <em class="parameter"><code>sexp</code></em>, receiving a list of contacts UIDs which matched.
1761
1761
If successful, then the <em class="parameter"><code>contacts_uids</code></em> is set to newly allocated list
1762
 
of UID strings, which should be freed with <code class="function">e_client_util_free_string_slist()</code>.
 
1762
of UID strings, which should be freed with <a href="../libedataserver/EClient.html#e-client-util-free-string-slist"><code class="function">e_client_util_free_string_slist()</code></a>.
1763
1763
</p>
1764
1764
<p>
1765
1765
Note: <em class="parameter"><code>sexp</code></em> can be obtained through <a class="link" href="libebook-e-book-query.html#EBookQuery" title="EBookQuery"><span class="type">EBookQuery</span></a>, by converting it