← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/eds/html/eds-EClient.html

  • Committer: Package Import Robot
  • Author(s): Iain Lane
  • Date: 2014-06-13 12:02:14 UTC
  • mfrom: (1.1.116) (1.2.35 sid)
  • Revision ID: package-import@ubuntu.com-20140613120214-1zx93d8jxwt093aw
Tags: 3.12.2-1ubuntu1
* Merge with Debian, remaining changes:
  - debian/control: build depend on hardening-wrapper
  - Add build-depends and pass configure flag to enable Ubuntu Online
    Accounts support.
  - Filter out -Bsymbolic-functions from LDFLAGS (for future people
    wondering about this change, see e.g. BGO #594473 and duplicates).
  - Enable Ubuntu Online Accounts and split it and GOA into a separate
    package

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/eds/html/eds-EClient.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 
2
<html>
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 
5
<title>EClient</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
 
8
<link rel="up" href="ch03.html" title="Shared Interaces">
 
9
<link rel="prev" href="ch03.html" title="Shared Interaces">
 
10
<link rel="next" href="ch04.html" title="Addressbook">
 
11
<meta name="generator" content="GTK-Doc V1.19 (XML mode)">
 
12
<link rel="stylesheet" href="style.css" type="text/css">
 
13
</head>
 
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
 
15
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
 
16
<tr valign="middle">
 
17
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
 
19
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
 
20
<th width="100%" align="center">Evolution-Data-Server Reference Manual</th>
 
21
<td><a accesskey="n" href="ch04.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
 
22
</tr>
 
23
<tr><td colspan="5" class="shortcuts">
 
24
<a href="#eds-EClient.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#eds-EClient.description" class="shortcut">Description</a>
 
27
</td></tr>
 
28
</table>
 
29
<div class="refentry">
 
30
<a name="eds-EClient"></a><div class="titlepage"></div>
 
31
<div class="refnamediv"><table width="100%"><tr>
 
32
<td valign="top">
 
33
<h2><span class="refentrytitle"><a name="eds-EClient.top_of_page"></a>EClient</span></h2>
 
34
<p>EClient — Base class for client handles</p>
 
35
</td>
 
36
<td valign="top" align="right"></td>
 
37
</tr></table></div>
 
38
<div class="refsynopsisdiv">
 
39
<a name="eds-EClient.synopsis"></a><h2>Synopsis</h2>
 
40
<pre class="synopsis">
 
41
#include &lt;libedataserver/libedataserver.h&gt;
 
42
 
 
43
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-ONLINE:CAPS" title="CLIENT_BACKEND_PROPERTY_ONLINE">CLIENT_BACKEND_PROPERTY_ONLINE</a>
 
44
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-READONLY:CAPS" title="CLIENT_BACKEND_PROPERTY_READONLY">CLIENT_BACKEND_PROPERTY_READONLY</a>
 
45
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-CACHE-DIR:CAPS" title="CLIENT_BACKEND_PROPERTY_CACHE_DIR">CLIENT_BACKEND_PROPERTY_CACHE_DIR</a>
 
46
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-CAPABILITIES:CAPS" title="CLIENT_BACKEND_PROPERTY_CAPABILITIES">CLIENT_BACKEND_PROPERTY_CAPABILITIES</a>
 
47
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-REVISION:CAPS" title="CLIENT_BACKEND_PROPERTY_REVISION">CLIENT_BACKEND_PROPERTY_REVISION</a>
 
48
#define             <a class="link" href="eds-EClient.html#E-CLIENT-ERROR:CAPS" title="E_CLIENT_ERROR">E_CLIENT_ERROR</a>
 
49
<span class="returnvalue">GQuark</span>              <a class="link" href="eds-EClient.html#e-client-error-quark" title="e_client_error_quark ()">e_client_error_quark</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
 
50
enum                <a class="link" href="eds-EClient.html#EClientError" title="enum EClientError">EClientError</a>;
 
51
const <span class="returnvalue">gchar</span> *       <a class="link" href="eds-EClient.html#e-client-error-to-string" title="e_client_error_to_string ()">e_client_error_to_string</a>            (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> code</code></em>);
 
52
struct              <a class="link" href="eds-EClient.html#EClient" title="struct EClient">EClient</a>;
 
53
struct              <a class="link" href="eds-EClient.html#EClientClass" title="struct EClientClass">EClientClass</a>;
 
54
<a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *           <a class="link" href="eds-EClient.html#e-client-get-source" title="e_client_get_source ()">e_client_get_source</a>                 (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
55
const <span class="returnvalue">GSList</span> *      <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()">e_client_get_capabilities</a>           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
56
<span class="returnvalue">GMainContext</span> *      <a class="link" href="eds-EClient.html#e-client-ref-main-context" title="e_client_ref_main_context ()">e_client_ref_main_context</a>           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
57
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-check-capability" title="e_client_check_capability ()">e_client_check_capability</a>           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
58
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *capability</code></em>);
 
59
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-check-refresh-supported" title="e_client_check_refresh_supported ()">e_client_check_refresh_supported</a>    (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
60
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-is-readonly" title="e_client_is_readonly ()">e_client_is_readonly</a>                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
61
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-is-online" title="e_client_is_online ()">e_client_is_online</a>                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
62
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-get-backend-property" title="e_client_get_backend_property ()">e_client_get_backend_property</a>       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
63
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
64
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
65
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
66
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
67
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-get-backend-property-finish" title="e_client_get_backend_property_finish ()">e_client_get_backend_property_finish</a>
 
68
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
69
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
70
                                                         <em class="parameter"><code><span class="type">gchar</span> **prop_value</code></em>,
 
71
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
72
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-get-backend-property-sync" title="e_client_get_backend_property_sync ()">e_client_get_backend_property_sync</a>  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
73
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
74
                                                         <em class="parameter"><code><span class="type">gchar</span> **prop_value</code></em>,
 
75
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
76
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
77
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-refresh" title="e_client_refresh ()">e_client_refresh</a>                    (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
78
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
79
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
80
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
81
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-refresh-finish" title="e_client_refresh_finish ()">e_client_refresh_finish</a>             (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
82
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
83
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
84
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-refresh-sync" title="e_client_refresh_sync ()">e_client_refresh_sync</a>               (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
85
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
86
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
87
<span class="returnvalue">GSList</span> *            <a class="link" href="eds-EClient.html#e-client-util-parse-comma-strings" title="e_client_util_parse_comma_strings ()">e_client_util_parse_comma_strings</a>   (<em class="parameter"><code>const <span class="type">gchar</span> *strings</code></em>);
 
88
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-OPENED:CAPS" title="CLIENT_BACKEND_PROPERTY_OPENED">CLIENT_BACKEND_PROPERTY_OPENED</a>
 
89
#define             <a class="link" href="eds-EClient.html#CLIENT-BACKEND-PROPERTY-OPENING:CAPS" title="CLIENT_BACKEND_PROPERTY_OPENING">CLIENT_BACKEND_PROPERTY_OPENING</a>
 
90
<span class="returnvalue">GError</span> *            <a class="link" href="eds-EClient.html#e-client-error-create" title="e_client_error_create ()">e_client_error_create</a>               (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> code</code></em>,
 
91
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *custom_msg</code></em>);
 
92
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-is-opened" title="e_client_is_opened ()">e_client_is_opened</a>                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
93
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-cancel-all" title="e_client_cancel_all ()">e_client_cancel_all</a>                 (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);
 
94
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-unwrap-dbus-error" title="e_client_unwrap_dbus_error ()">e_client_unwrap_dbus_error</a>          (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
95
                                                         <em class="parameter"><code><span class="type">GError</span> *dbus_error</code></em>,
 
96
                                                         <em class="parameter"><code><span class="type">GError</span> **out_error</code></em>);
 
97
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-retrieve-capabilities" title="e_client_retrieve_capabilities ()">e_client_retrieve_capabilities</a>      (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
98
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
99
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
100
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
101
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-retrieve-capabilities-finish" title="e_client_retrieve_capabilities_finish ()">e_client_retrieve_capabilities_finish</a>
 
102
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
103
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
104
                                                         <em class="parameter"><code><span class="type">gchar</span> **capabilities</code></em>,
 
105
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
106
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-retrieve-capabilities-sync" title="e_client_retrieve_capabilities_sync ()">e_client_retrieve_capabilities_sync</a> (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
107
                                                         <em class="parameter"><code><span class="type">gchar</span> **capabilities</code></em>,
 
108
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
109
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
110
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-set-backend-property" title="e_client_set_backend_property ()">e_client_set_backend_property</a>       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
111
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
112
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_value</code></em>,
 
113
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
114
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
115
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
116
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-set-backend-property-finish" title="e_client_set_backend_property_finish ()">e_client_set_backend_property_finish</a>
 
117
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
118
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
119
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
120
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-set-backend-property-sync" title="e_client_set_backend_property_sync ()">e_client_set_backend_property_sync</a>  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
121
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
122
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_value</code></em>,
 
123
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
124
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
125
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-open" title="e_client_open ()">e_client_open</a>                       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
126
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
 
127
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
128
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
129
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
130
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-open-finish" title="e_client_open_finish ()">e_client_open_finish</a>                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
131
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
132
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
133
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-open-sync" title="e_client_open_sync ()">e_client_open_sync</a>                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
134
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
 
135
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
136
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
137
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-remove" title="e_client_remove ()">e_client_remove</a>                     (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
138
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
139
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
140
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);
 
141
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-remove-finish" title="e_client_remove_finish ()">e_client_remove_finish</a>              (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
142
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
143
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
144
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-remove-sync" title="e_client_remove_sync ()">e_client_remove_sync</a>                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
145
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
146
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
 
147
<span class="returnvalue">gchar</span> **            <a class="link" href="eds-EClient.html#e-client-util-slist-to-strv" title="e_client_util_slist_to_strv ()">e_client_util_slist_to_strv</a>         (<em class="parameter"><code>const <span class="type">GSList</span> *strings</code></em>);
 
148
<span class="returnvalue">GSList</span> *            <a class="link" href="eds-EClient.html#e-client-util-strv-to-slist" title="e_client_util_strv_to_slist ()">e_client_util_strv_to_slist</a>         (<em class="parameter"><code>const <span class="type">gchar</span> * const *strv</code></em>);
 
149
<span class="returnvalue">GSList</span> *            <a class="link" href="eds-EClient.html#e-client-util-copy-string-slist" title="e_client_util_copy_string_slist ()">e_client_util_copy_string_slist</a>     (<em class="parameter"><code><span class="type">GSList</span> *copy_to</code></em>,
 
150
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *strings</code></em>);
 
151
<span class="returnvalue">GSList</span> *            <a class="link" href="eds-EClient.html#e-client-util-copy-object-slist" title="e_client_util_copy_object_slist ()">e_client_util_copy_object_slist</a>     (<em class="parameter"><code><span class="type">GSList</span> *copy_to</code></em>,
 
152
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *objects</code></em>);
 
153
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-util-free-string-slist" title="e_client_util_free_string_slist ()">e_client_util_free_string_slist</a>     (<em class="parameter"><code><span class="type">GSList</span> *strings</code></em>);
 
154
<span class="returnvalue">void</span>                <a class="link" href="eds-EClient.html#e-client-util-free-object-slist" title="e_client_util_free_object_slist ()">e_client_util_free_object_slist</a>     (<em class="parameter"><code><span class="type">GSList</span> *objects</code></em>);
 
155
struct              <a class="link" href="eds-EClient.html#EClientErrorsList" title="struct EClientErrorsList">EClientErrorsList</a>;
 
156
<span class="returnvalue">gboolean</span>            <a class="link" href="eds-EClient.html#e-client-util-unwrap-dbus-error" title="e_client_util_unwrap_dbus_error ()">e_client_util_unwrap_dbus_error</a>     (<em class="parameter"><code><span class="type">GError</span> *dbus_error</code></em>,
 
157
                                                         <em class="parameter"><code><span class="type">GError</span> **client_error</code></em>,
 
158
                                                         <em class="parameter"><code>const <a class="link" href="eds-EClient.html#EClientErrorsList" title="struct EClientErrorsList"><span class="type">EClientErrorsList</span></a> *known_errors</code></em>,
 
159
                                                         <em class="parameter"><code><span class="type">guint</span> known_errors_count</code></em>,
 
160
                                                         <em class="parameter"><code><span class="type">GQuark</span> known_errors_domain</code></em>,
 
161
                                                         <em class="parameter"><code><span class="type">gboolean</span> fail_when_none_matched</code></em>);
 
162
</pre>
 
163
</div>
 
164
<div class="refsect1">
 
165
<a name="eds-EClient.description"></a><h2>Description</h2>
 
166
<p>
 
167
This class provides some base functionality for clients
 
168
such as <a class="link" href="eds-EBookClient.html#EBookClient" title="struct EBookClient"><span class="type">EBookClient</span></a> and <a class="link" href="eds-ECalClient.html#ECalClient" title="struct ECalClient"><span class="type">ECalClient</span></a>.
 
169
</p>
 
170
</div>
 
171
<div class="refsect1">
 
172
<a name="eds-EClient.details"></a><h2>Details</h2>
 
173
<div class="refsect2">
 
174
<a name="CLIENT-BACKEND-PROPERTY-ONLINE:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_ONLINE</h3>
 
175
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_ONLINE                      "online"
 
176
</pre>
 
177
<p>
 
178
The "online" property is "TRUE" when the client is fully opened and
 
179
online, "FALSE" at all other times.  See also <a class="link" href="eds-EClient.html#e-client-is-online" title="e_client_is_online ()"><code class="function">e_client_is_online()</code></a>.
 
180
</p>
 
181
<p class="since">Since 3.2</p>
 
182
</div>
 
183
<hr>
 
184
<div class="refsect2">
 
185
<a name="CLIENT-BACKEND-PROPERTY-READONLY:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_READONLY</h3>
 
186
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_READONLY            "readonly"
 
187
</pre>
 
188
<p>
 
189
The "online" property is "TRUE" if the backend has only read access
 
190
to its data, "FALSE" if the backend can modify its data.  See also
 
191
<a class="link" href="eds-EClient.html#e-client-is-readonly" title="e_client_is_readonly ()"><code class="function">e_client_is_readonly()</code></a>.
 
192
</p>
 
193
<p class="since">Since 3.2</p>
 
194
</div>
 
195
<hr>
 
196
<div class="refsect2">
 
197
<a name="CLIENT-BACKEND-PROPERTY-CACHE-DIR:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_CACHE_DIR</h3>
 
198
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_CACHE_DIR           "cache-dir"
 
199
</pre>
 
200
<p>
 
201
The "cache-dir" property indicates the backend's local directory for
 
202
cached data.
 
203
</p>
 
204
<p class="since">Since 3.2</p>
 
205
</div>
 
206
<hr>
 
207
<div class="refsect2">
 
208
<a name="CLIENT-BACKEND-PROPERTY-CAPABILITIES:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_CAPABILITIES</h3>
 
209
<pre class="programlisting">#define             CLIENT_BACKEND_PROPERTY_CAPABILITIES</pre>
 
210
<p>
 
211
FIXME: Document me.
 
212
</p>
 
213
<p class="since">Since 3.2</p>
 
214
</div>
 
215
<hr>
 
216
<div class="refsect2">
 
217
<a name="CLIENT-BACKEND-PROPERTY-REVISION:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_REVISION</h3>
 
218
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_REVISION            "revision"
 
219
</pre>
 
220
<p>
 
221
The current overall revision string, this can be used as
 
222
a quick check to see if data has changed at all since the
 
223
last time the revision was observed.
 
224
</p>
 
225
<p class="since">Since 3.4</p>
 
226
</div>
 
227
<hr>
 
228
<div class="refsect2">
 
229
<a name="E-CLIENT-ERROR:CAPS"></a><h3>E_CLIENT_ERROR</h3>
 
230
<pre class="programlisting">#define E_CLIENT_ERROR              e_client_error_quark ()
 
231
</pre>
 
232
<p>
 
233
Error domain for <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> operations.  Errors in this domain will be
 
234
from the <a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> enumeration.  See <span class="type">GError</span> for more information
 
235
on error domains.
 
236
</p>
 
237
<p class="since">Since 3.2</p>
 
238
</div>
 
239
<hr>
 
240
<div class="refsect2">
 
241
<a name="e-client-error-quark"></a><h3>e_client_error_quark ()</h3>
 
242
<pre class="programlisting"><span class="returnvalue">GQuark</span>              e_client_error_quark                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
 
243
</div>
 
244
<hr>
 
245
<div class="refsect2">
 
246
<a name="EClientError"></a><h3>enum EClientError</h3>
 
247
<pre class="programlisting">typedef enum {
 
248
        E_CLIENT_ERROR_INVALID_ARG,
 
249
        E_CLIENT_ERROR_BUSY,
 
250
        E_CLIENT_ERROR_SOURCE_NOT_LOADED,
 
251
        E_CLIENT_ERROR_SOURCE_ALREADY_LOADED,
 
252
        E_CLIENT_ERROR_AUTHENTICATION_FAILED,
 
253
        E_CLIENT_ERROR_AUTHENTICATION_REQUIRED,
 
254
        E_CLIENT_ERROR_REPOSITORY_OFFLINE,
 
255
        E_CLIENT_ERROR_OFFLINE_UNAVAILABLE,
 
256
        E_CLIENT_ERROR_PERMISSION_DENIED,
 
257
        E_CLIENT_ERROR_CANCELLED,
 
258
        E_CLIENT_ERROR_COULD_NOT_CANCEL,
 
259
        E_CLIENT_ERROR_NOT_SUPPORTED,
 
260
        E_CLIENT_ERROR_TLS_NOT_AVAILABLE,
 
261
        E_CLIENT_ERROR_UNSUPPORTED_AUTHENTICATION_METHOD,
 
262
        E_CLIENT_ERROR_SEARCH_SIZE_LIMIT_EXCEEDED,
 
263
        E_CLIENT_ERROR_SEARCH_TIME_LIMIT_EXCEEDED,
 
264
        E_CLIENT_ERROR_INVALID_QUERY,
 
265
        E_CLIENT_ERROR_QUERY_REFUSED,
 
266
        E_CLIENT_ERROR_DBUS_ERROR,
 
267
        E_CLIENT_ERROR_OTHER_ERROR,
 
268
        E_CLIENT_ERROR_NOT_OPENED,
 
269
        E_CLIENT_ERROR_OUT_OF_SYNC
 
270
} EClientError;
 
271
</pre>
 
272
<p>
 
273
FIXME Document each code.
 
274
</p>
 
275
<p>
 
276
Error codes for <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> operations.
 
277
</p>
 
278
<div class="variablelist"><table border="0">
 
279
<col align="left" valign="top">
 
280
<tbody>
 
281
<tr>
 
282
<td><p><a name="E-CLIENT-ERROR-INVALID-ARG:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_INVALID_ARG</code></span></p></td>
 
283
<td></td>
 
284
</tr>
 
285
<tr>
 
286
<td><p><a name="E-CLIENT-ERROR-BUSY:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_BUSY</code></span></p></td>
 
287
<td></td>
 
288
</tr>
 
289
<tr>
 
290
<td><p><a name="E-CLIENT-ERROR-SOURCE-NOT-LOADED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_SOURCE_NOT_LOADED</code></span></p></td>
 
291
<td></td>
 
292
</tr>
 
293
<tr>
 
294
<td><p><a name="E-CLIENT-ERROR-SOURCE-ALREADY-LOADED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_SOURCE_ALREADY_LOADED</code></span></p></td>
 
295
<td></td>
 
296
</tr>
 
297
<tr>
 
298
<td><p><a name="E-CLIENT-ERROR-AUTHENTICATION-FAILED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_AUTHENTICATION_FAILED</code></span></p></td>
 
299
<td></td>
 
300
</tr>
 
301
<tr>
 
302
<td><p><a name="E-CLIENT-ERROR-AUTHENTICATION-REQUIRED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_AUTHENTICATION_REQUIRED</code></span></p></td>
 
303
<td></td>
 
304
</tr>
 
305
<tr>
 
306
<td><p><a name="E-CLIENT-ERROR-REPOSITORY-OFFLINE:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_REPOSITORY_OFFLINE</code></span></p></td>
 
307
<td></td>
 
308
</tr>
 
309
<tr>
 
310
<td><p><a name="E-CLIENT-ERROR-OFFLINE-UNAVAILABLE:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_OFFLINE_UNAVAILABLE</code></span></p></td>
 
311
<td></td>
 
312
</tr>
 
313
<tr>
 
314
<td><p><a name="E-CLIENT-ERROR-PERMISSION-DENIED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_PERMISSION_DENIED</code></span></p></td>
 
315
<td></td>
 
316
</tr>
 
317
<tr>
 
318
<td><p><a name="E-CLIENT-ERROR-CANCELLED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_CANCELLED</code></span></p></td>
 
319
<td></td>
 
320
</tr>
 
321
<tr>
 
322
<td><p><a name="E-CLIENT-ERROR-COULD-NOT-CANCEL:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_COULD_NOT_CANCEL</code></span></p></td>
 
323
<td></td>
 
324
</tr>
 
325
<tr>
 
326
<td><p><a name="E-CLIENT-ERROR-NOT-SUPPORTED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_NOT_SUPPORTED</code></span></p></td>
 
327
<td></td>
 
328
</tr>
 
329
<tr>
 
330
<td><p><a name="E-CLIENT-ERROR-TLS-NOT-AVAILABLE:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_TLS_NOT_AVAILABLE</code></span></p></td>
 
331
<td></td>
 
332
</tr>
 
333
<tr>
 
334
<td><p><a name="E-CLIENT-ERROR-UNSUPPORTED-AUTHENTICATION-METHOD:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_UNSUPPORTED_AUTHENTICATION_METHOD</code></span></p></td>
 
335
<td></td>
 
336
</tr>
 
337
<tr>
 
338
<td><p><a name="E-CLIENT-ERROR-SEARCH-SIZE-LIMIT-EXCEEDED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_SEARCH_SIZE_LIMIT_EXCEEDED</code></span></p></td>
 
339
<td></td>
 
340
</tr>
 
341
<tr>
 
342
<td><p><a name="E-CLIENT-ERROR-SEARCH-TIME-LIMIT-EXCEEDED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_SEARCH_TIME_LIMIT_EXCEEDED</code></span></p></td>
 
343
<td></td>
 
344
</tr>
 
345
<tr>
 
346
<td><p><a name="E-CLIENT-ERROR-INVALID-QUERY:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_INVALID_QUERY</code></span></p></td>
 
347
<td></td>
 
348
</tr>
 
349
<tr>
 
350
<td><p><a name="E-CLIENT-ERROR-QUERY-REFUSED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_QUERY_REFUSED</code></span></p></td>
 
351
<td></td>
 
352
</tr>
 
353
<tr>
 
354
<td><p><a name="E-CLIENT-ERROR-DBUS-ERROR:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_DBUS_ERROR</code></span></p></td>
 
355
<td></td>
 
356
</tr>
 
357
<tr>
 
358
<td><p><a name="E-CLIENT-ERROR-OTHER-ERROR:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_OTHER_ERROR</code></span></p></td>
 
359
<td></td>
 
360
</tr>
 
361
<tr>
 
362
<td><p><a name="E-CLIENT-ERROR-NOT-OPENED:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_NOT_OPENED</code></span></p></td>
 
363
<td></td>
 
364
</tr>
 
365
<tr>
 
366
<td><p><a name="E-CLIENT-ERROR-OUT-OF-SYNC:CAPS"></a><span class="term"><code class="literal">E_CLIENT_ERROR_OUT_OF_SYNC</code></span></p></td>
 
367
<td></td>
 
368
</tr>
 
369
</tbody>
 
370
</table></div>
 
371
<p class="since">Since 3.2</p>
 
372
</div>
 
373
<hr>
 
374
<div class="refsect2">
 
375
<a name="e-client-error-to-string"></a><h3>e_client_error_to_string ()</h3>
 
376
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_client_error_to_string            (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> code</code></em>);</pre>
 
377
<p>
 
378
FIXME: Document me.
 
379
</p>
 
380
<p class="since">Since 3.2</p>
 
381
</div>
 
382
<hr>
 
383
<div class="refsect2">
 
384
<a name="EClient"></a><h3>struct EClient</h3>
 
385
<pre class="programlisting">struct EClient {
 
386
        GObject parent;
 
387
        EClientPrivate *priv;
 
388
};
 
389
</pre>
 
390
<p>
 
391
Contains only private data that should be read and manipulated using the
 
392
functions below.
 
393
</p>
 
394
<p class="since">Since 3.2</p>
 
395
</div>
 
396
<hr>
 
397
<div class="refsect2">
 
398
<a name="EClientClass"></a><h3>struct EClientClass</h3>
 
399
<pre class="programlisting">struct EClientClass {
 
400
        GObjectClass parent;
 
401
 
 
402
        /* This method is deprecated. */
 
403
        GDBusProxy * (*get_dbus_proxy) (EClient *client);
 
404
 
 
405
        /* This method is deprecated. */
 
406
        void            (*unwrap_dbus_error) (EClient *client,
 
407
                                                 GError *dbus_error,
 
408
                                                 GError **out_error);
 
409
 
 
410
        /* This method is deprecated. */
 
411
        void            (*retrieve_capabilities)
 
412
                                                (EClient *client,
 
413
                                                 GCancellable *cancellable,
 
414
                                                 GAsyncReadyCallback callback,
 
415
                                                 gpointer user_data);
 
416
        gboolean (*retrieve_capabilities_finish)
 
417
                                                (EClient *client,
 
418
                                                 GAsyncResult *result,
 
419
                                                 gchar **capabilities,
 
420
                                                 GError **error);
 
421
        gboolean (*retrieve_capabilities_sync)
 
422
                                                (EClient *client,
 
423
                                                 gchar **capabilities,
 
424
                                                 GCancellable *cancellable,
 
425
                                                 GError **error);
 
426
 
 
427
        void            (*get_backend_property) (EClient *client,
 
428
                                                 const gchar *prop_name,
 
429
                                                 GCancellable *cancellable,
 
430
                                                 GAsyncReadyCallback callback,
 
431
                                                 gpointer user_data);
 
432
        gboolean (*get_backend_property_finish)
 
433
                                                (EClient *client,
 
434
                                                 GAsyncResult *result,
 
435
                                                 gchar **prop_value,
 
436
                                                 GError **error);
 
437
        gboolean (*get_backend_property_sync)
 
438
                                                (EClient *client,
 
439
                                                 const gchar *prop_name,
 
440
                                                 gchar **prop_value,
 
441
                                                 GCancellable *cancellable,
 
442
                                                 GError **error);
 
443
 
 
444
        /* This method is deprecated. */
 
445
        void            (*set_backend_property) (EClient *client,
 
446
                                                 const gchar *prop_name,
 
447
                                                 const gchar *prop_value,
 
448
                                                 GCancellable *cancellable,
 
449
                                                 GAsyncReadyCallback callback,
 
450
                                                 gpointer user_data);
 
451
        gboolean (*set_backend_property_finish)
 
452
                                                (EClient *client,
 
453
                                                 GAsyncResult *result,
 
454
                                                 GError **error);
 
455
        gboolean (*set_backend_property_sync)
 
456
                                                (EClient *client,
 
457
                                                 const gchar *prop_name,
 
458
                                                 const gchar *prop_value,
 
459
                                                 GCancellable *cancellable,
 
460
                                                 GError **error);
 
461
 
 
462
        void            (*open)                 (EClient *client,
 
463
                                                 gboolean only_if_exists,
 
464
                                                 GCancellable *cancellable,
 
465
                                                 GAsyncReadyCallback callback,
 
466
                                                 gpointer user_data);
 
467
        gboolean (*open_finish)         (EClient *client,
 
468
                                                 GAsyncResult *result,
 
469
                                                 GError **error);
 
470
        gboolean (*open_sync)           (EClient *client,
 
471
                                                 gboolean only_if_exists,
 
472
                                                 GCancellable *cancellable,
 
473
                                                 GError **error);
 
474
 
 
475
        void            (*remove)               (EClient *client,
 
476
                                                 GCancellable *cancellable,
 
477
                                                 GAsyncReadyCallback callback,
 
478
                                                 gpointer user_data);
 
479
        gboolean (*remove_finish) (EClient *client,
 
480
                                                 GAsyncResult *result,
 
481
                                                 GError **error);
 
482
        gboolean (*remove_sync)         (EClient *client,
 
483
                                                 GCancellable *cancellable,
 
484
                                                 GError **error);
 
485
 
 
486
        void            (*refresh)              (EClient *client,
 
487
                                                 GCancellable *cancellable,
 
488
                                                 GAsyncReadyCallback callback,
 
489
                                                 gpointer user_data);
 
490
        gboolean (*refresh_finish) (EClient *client,
 
491
                                                 GAsyncResult *result,
 
492
                                                 GError **error);
 
493
        gboolean (*refresh_sync)                (EClient *client,
 
494
                                                 GCancellable *cancellable,
 
495
                                                 GError **error);
 
496
 
 
497
        void            (*opened)               (EClient *client,
 
498
                                                 const GError *error);
 
499
        void            (*backend_error) (EClient *client,
 
500
                                                 const gchar *error_msg);
 
501
        void            (*backend_died)         (EClient *client);
 
502
        void            (*backend_property_changed)
 
503
                                                (EClient *client,
 
504
                                                 const gchar *prop_name,
 
505
                                                 const gchar *prop_value);
 
506
};
 
507
</pre>
 
508
</div>
 
509
<hr>
 
510
<div class="refsect2">
 
511
<a name="e-client-get-source"></a><h3>e_client_get_source ()</h3>
 
512
<pre class="programlisting"><a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="returnvalue">ESource</span></a> *           e_client_get_source                 (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
513
<p>
 
514
Get the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> that this client has assigned.
 
515
</p>
 
516
<div class="variablelist"><table border="0">
 
517
<col align="left" valign="top">
 
518
<tbody>
 
519
<tr>
 
520
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
521
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
522
</td>
 
523
</tr>
 
524
<tr>
 
525
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
526
<td>The source. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
527
</td>
 
528
</tr>
 
529
</tbody>
 
530
</table></div>
 
531
<p class="since">Since 3.2</p>
 
532
</div>
 
533
<hr>
 
534
<div class="refsect2">
 
535
<a name="e-client-get-capabilities"></a><h3>e_client_get_capabilities ()</h3>
 
536
<pre class="programlisting">const <span class="returnvalue">GSList</span> *      e_client_get_capabilities           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
537
<p>
 
538
Get list of strings with capabilities advertised by a backend.
 
539
This list, together with inner strings, is owned by the <em class="parameter"><code>client</code></em>.
 
540
To check for individual capabilities use <a class="link" href="eds-EClient.html#e-client-check-capability" title="e_client_check_capability ()"><code class="function">e_client_check_capability()</code></a>.
 
541
</p>
 
542
<div class="variablelist"><table border="0">
 
543
<col align="left" valign="top">
 
544
<tbody>
 
545
<tr>
 
546
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
547
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
548
</td>
 
549
</tr>
 
550
<tr>
 
551
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
552
<td>
 
553
<span class="type">GSList</span> of const strings
 
554
of capabilities. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
 
555
</td>
 
556
</tr>
 
557
</tbody>
 
558
</table></div>
 
559
<p class="since">Since 3.2</p>
 
560
</div>
 
561
<hr>
 
562
<div class="refsect2">
 
563
<a name="e-client-ref-main-context"></a><h3>e_client_ref_main_context ()</h3>
 
564
<pre class="programlisting"><span class="returnvalue">GMainContext</span> *      e_client_ref_main_context           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
565
<p>
 
566
Returns the <span class="type">GMainContext</span> on which event sources for <em class="parameter"><code>client</code></em> are to
 
567
be attached.
 
568
</p>
 
569
<p>
 
570
The returned <span class="type">GMainContext</span> is referenced for thread-safety and must be
 
571
unreferenced with <code class="function">g_main_context_unref()</code> when finished with it.
 
572
</p>
 
573
<div class="variablelist"><table border="0">
 
574
<col align="left" valign="top">
 
575
<tbody>
 
576
<tr>
 
577
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
578
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
579
</td>
 
580
</tr>
 
581
<tr>
 
582
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
583
<td>a <span class="type">GMainContext</span>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
584
</td>
 
585
</tr>
 
586
</tbody>
 
587
</table></div>
 
588
<p class="since">Since 3.8</p>
 
589
</div>
 
590
<hr>
 
591
<div class="refsect2">
 
592
<a name="e-client-check-capability"></a><h3>e_client_check_capability ()</h3>
 
593
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_check_capability           (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
594
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *capability</code></em>);</pre>
 
595
<p>
 
596
Check if backend supports particular capability.
 
597
To get all capabilities use <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a>.
 
598
</p>
 
599
<div class="variablelist"><table border="0">
 
600
<col align="left" valign="top">
 
601
<tbody>
 
602
<tr>
 
603
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
604
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
605
</td>
 
606
</tr>
 
607
<tr>
 
608
<td><p><span class="term"><em class="parameter"><code>capability</code></em> :</span></p></td>
 
609
<td>a capability</td>
 
610
</tr>
 
611
<tr>
 
612
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
613
<td>
 
614
<span class="type">GSList</span> of const strings of capabilities</td>
 
615
</tr>
 
616
</tbody>
 
617
</table></div>
 
618
<p class="since">Since 3.2</p>
 
619
</div>
 
620
<hr>
 
621
<div class="refsect2">
 
622
<a name="e-client-check-refresh-supported"></a><h3>e_client_check_refresh_supported ()</h3>
 
623
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_check_refresh_supported    (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
624
<p>
 
625
Checks whether a client supports explicit refreshing
 
626
(see <a class="link" href="eds-EClient.html#e-client-refresh" title="e_client_refresh ()"><code class="function">e_client_refresh()</code></a>).
 
627
</p>
 
628
<div class="variablelist"><table border="0">
 
629
<col align="left" valign="top">
 
630
<tbody>
 
631
<tr>
 
632
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
633
<td>A client.</td>
 
634
</tr>
 
635
<tr>
 
636
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
637
<td>TRUE if the client supports refreshing, FALSE otherwise.</td>
 
638
</tr>
 
639
</tbody>
 
640
</table></div>
 
641
<p class="since">Since 3.2</p>
 
642
</div>
 
643
<hr>
 
644
<div class="refsect2">
 
645
<a name="e-client-is-readonly"></a><h3>e_client_is_readonly ()</h3>
 
646
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_is_readonly                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
647
<p>
 
648
Check if this <em class="parameter"><code>client</code></em> is read-only.
 
649
</p>
 
650
<div class="variablelist"><table border="0">
 
651
<col align="left" valign="top">
 
652
<tbody>
 
653
<tr>
 
654
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
655
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
656
</td>
 
657
</tr>
 
658
<tr>
 
659
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
660
<td>
 
661
<code class="literal">TRUE</code> if this <em class="parameter"><code>client</code></em> is read-only, otherwise <code class="literal">FALSE</code>.</td>
 
662
</tr>
 
663
</tbody>
 
664
</table></div>
 
665
<p class="since">Since 3.2</p>
 
666
</div>
 
667
<hr>
 
668
<div class="refsect2">
 
669
<a name="e-client-is-online"></a><h3>e_client_is_online ()</h3>
 
670
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_is_online                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
671
<p>
 
672
Check if this <em class="parameter"><code>client</code></em> is connected.
 
673
</p>
 
674
<div class="variablelist"><table border="0">
 
675
<col align="left" valign="top">
 
676
<tbody>
 
677
<tr>
 
678
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
679
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
680
</td>
 
681
</tr>
 
682
<tr>
 
683
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
684
<td>
 
685
<code class="literal">TRUE</code> if this <em class="parameter"><code>client</code></em> is connected, otherwise <code class="literal">FALSE</code>.</td>
 
686
</tr>
 
687
</tbody>
 
688
</table></div>
 
689
<p class="since">Since 3.2</p>
 
690
</div>
 
691
<hr>
 
692
<div class="refsect2">
 
693
<a name="e-client-get-backend-property"></a><h3>e_client_get_backend_property ()</h3>
 
694
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_get_backend_property       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
695
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
696
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
697
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
698
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
699
<p>
 
700
Queries <em class="parameter"><code>client</code></em>'s backend for a property of name <em class="parameter"><code>prop_name</code></em>.
 
701
The call is finished by <a class="link" href="eds-EClient.html#e-client-get-backend-property-finish" title="e_client_get_backend_property_finish ()"><code class="function">e_client_get_backend_property_finish()</code></a>
 
702
from the <em class="parameter"><code>callback</code></em>.
 
703
</p>
 
704
<div class="variablelist"><table border="0">
 
705
<col align="left" valign="top">
 
706
<tbody>
 
707
<tr>
 
708
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
709
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
710
</td>
 
711
</tr>
 
712
<tr>
 
713
<td><p><span class="term"><em class="parameter"><code>prop_name</code></em> :</span></p></td>
 
714
<td>property name, whose value to retrieve; cannot be <code class="literal">NULL</code>
 
715
</td>
 
716
</tr>
 
717
<tr>
 
718
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
719
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
720
</td>
 
721
</tr>
 
722
<tr>
 
723
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
724
<td>callback to call when a result is ready</td>
 
725
</tr>
 
726
<tr>
 
727
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
728
<td>user data for the <em class="parameter"><code>callback</code></em>
 
729
</td>
 
730
</tr>
 
731
</tbody>
 
732
</table></div>
 
733
<p class="since">Since 3.2</p>
 
734
</div>
 
735
<hr>
 
736
<div class="refsect2">
 
737
<a name="e-client-get-backend-property-finish"></a><h3>e_client_get_backend_property_finish ()</h3>
 
738
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_get_backend_property_finish
 
739
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
740
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
741
                                                         <em class="parameter"><code><span class="type">gchar</span> **prop_value</code></em>,
 
742
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
743
<p>
 
744
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-get-backend-property" title="e_client_get_backend_property ()"><code class="function">e_client_get_backend_property()</code></a>.
 
745
</p>
 
746
<div class="variablelist"><table border="0">
 
747
<col align="left" valign="top">
 
748
<tbody>
 
749
<tr>
 
750
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
751
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
752
</td>
 
753
</tr>
 
754
<tr>
 
755
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
756
<td>a <span class="type">GAsyncResult</span>
 
757
</td>
 
758
</tr>
 
759
<tr>
 
760
<td><p><span class="term"><em class="parameter"><code>prop_value</code></em> :</span></p></td>
 
761
<td>Retrieved backend property value; cannot be <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
762
</td>
 
763
</tr>
 
764
<tr>
 
765
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
766
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
767
</td>
 
768
</tr>
 
769
<tr>
 
770
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
771
<td>
 
772
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
773
</tr>
 
774
</tbody>
 
775
</table></div>
 
776
<p class="since">Since 3.2</p>
 
777
</div>
 
778
<hr>
 
779
<div class="refsect2">
 
780
<a name="e-client-get-backend-property-sync"></a><h3>e_client_get_backend_property_sync ()</h3>
 
781
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_get_backend_property_sync  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
782
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
783
                                                         <em class="parameter"><code><span class="type">gchar</span> **prop_value</code></em>,
 
784
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
785
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
786
<p>
 
787
Queries <em class="parameter"><code>client</code></em>'s backend for a property of name <em class="parameter"><code>prop_name</code></em>.
 
788
</p>
 
789
<div class="variablelist"><table border="0">
 
790
<col align="left" valign="top">
 
791
<tbody>
 
792
<tr>
 
793
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
794
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
795
</td>
 
796
</tr>
 
797
<tr>
 
798
<td><p><span class="term"><em class="parameter"><code>prop_name</code></em> :</span></p></td>
 
799
<td>property name, whose value to retrieve; cannot be <code class="literal">NULL</code>
 
800
</td>
 
801
</tr>
 
802
<tr>
 
803
<td><p><span class="term"><em class="parameter"><code>prop_value</code></em> :</span></p></td>
 
804
<td>Retrieved backend property value; cannot be <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
805
</td>
 
806
</tr>
 
807
<tr>
 
808
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
809
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
810
</td>
 
811
</tr>
 
812
<tr>
 
813
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
814
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
815
</td>
 
816
</tr>
 
817
<tr>
 
818
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
819
<td>
 
820
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
821
</tr>
 
822
</tbody>
 
823
</table></div>
 
824
<p class="since">Since 3.2</p>
 
825
</div>
 
826
<hr>
 
827
<div class="refsect2">
 
828
<a name="e-client-refresh"></a><h3>e_client_refresh ()</h3>
 
829
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_refresh                    (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
830
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
831
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
832
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
833
<p>
 
834
Initiates refresh on the <em class="parameter"><code>client</code></em>. Finishing the method doesn't mean
 
835
that the refresh is done, backend only notifies whether it started
 
836
refreshing or not. Use <a class="link" href="eds-EClient.html#e-client-check-refresh-supported" title="e_client_check_refresh_supported ()"><code class="function">e_client_check_refresh_supported()</code></a> to check
 
837
whether the backend supports this method.
 
838
The call is finished by <a class="link" href="eds-EClient.html#e-client-refresh-finish" title="e_client_refresh_finish ()"><code class="function">e_client_refresh_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
 
839
</p>
 
840
<div class="variablelist"><table border="0">
 
841
<col align="left" valign="top">
 
842
<tbody>
 
843
<tr>
 
844
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
845
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
846
</td>
 
847
</tr>
 
848
<tr>
 
849
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
850
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
851
</td>
 
852
</tr>
 
853
<tr>
 
854
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
855
<td>callback to call when a result is ready</td>
 
856
</tr>
 
857
<tr>
 
858
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
859
<td>user data for the <em class="parameter"><code>callback</code></em>
 
860
</td>
 
861
</tr>
 
862
</tbody>
 
863
</table></div>
 
864
<p class="since">Since 3.2</p>
 
865
</div>
 
866
<hr>
 
867
<div class="refsect2">
 
868
<a name="e-client-refresh-finish"></a><h3>e_client_refresh_finish ()</h3>
 
869
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_refresh_finish             (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
870
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
871
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
872
<p>
 
873
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-refresh" title="e_client_refresh ()"><code class="function">e_client_refresh()</code></a>.
 
874
</p>
 
875
<div class="variablelist"><table border="0">
 
876
<col align="left" valign="top">
 
877
<tbody>
 
878
<tr>
 
879
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
880
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
881
</td>
 
882
</tr>
 
883
<tr>
 
884
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
885
<td>a <span class="type">GAsyncResult</span>
 
886
</td>
 
887
</tr>
 
888
<tr>
 
889
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
890
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
891
</td>
 
892
</tr>
 
893
<tr>
 
894
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
895
<td>
 
896
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
897
</tr>
 
898
</tbody>
 
899
</table></div>
 
900
<p class="since">Since 3.2</p>
 
901
</div>
 
902
<hr>
 
903
<div class="refsect2">
 
904
<a name="e-client-refresh-sync"></a><h3>e_client_refresh_sync ()</h3>
 
905
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_refresh_sync               (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
906
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
907
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
908
<p>
 
909
Initiates refresh on the <em class="parameter"><code>client</code></em>. Finishing the method doesn't mean
 
910
that the refresh is done, backend only notifies whether it started
 
911
refreshing or not. Use <a class="link" href="eds-EClient.html#e-client-check-refresh-supported" title="e_client_check_refresh_supported ()"><code class="function">e_client_check_refresh_supported()</code></a> to check
 
912
whether the backend supports this method.
 
913
</p>
 
914
<div class="variablelist"><table border="0">
 
915
<col align="left" valign="top">
 
916
<tbody>
 
917
<tr>
 
918
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
919
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
920
</td>
 
921
</tr>
 
922
<tr>
 
923
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
924
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
925
</td>
 
926
</tr>
 
927
<tr>
 
928
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
929
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
930
</td>
 
931
</tr>
 
932
<tr>
 
933
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
934
<td>
 
935
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
936
</tr>
 
937
</tbody>
 
938
</table></div>
 
939
<p class="since">Since 3.2</p>
 
940
</div>
 
941
<hr>
 
942
<div class="refsect2">
 
943
<a name="e-client-util-parse-comma-strings"></a><h3>e_client_util_parse_comma_strings ()</h3>
 
944
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_client_util_parse_comma_strings   (<em class="parameter"><code>const <span class="type">gchar</span> *strings</code></em>);</pre>
 
945
<p>
 
946
Parses comma-separated list of values into <span class="type">GSList</span>.
 
947
</p>
 
948
<div class="variablelist"><table border="0">
 
949
<col align="left" valign="top">
 
950
<tbody>
 
951
<tr>
 
952
<td><p><span class="term"><em class="parameter"><code>strings</code></em> :</span></p></td>
 
953
<td>string of comma-separated values</td>
 
954
</tr>
 
955
<tr>
 
956
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
957
<td>Newly allocated <span class="type">GSList</span> of
 
958
newly allocated strings corresponding to values parsed from <em class="parameter"><code>strings</code></em>.
 
959
Free the returned pointer with <a class="link" href="eds-EClient.html#e-client-util-free-string-slist" title="e_client_util_free_string_slist ()"><code class="function">e_client_util_free_string_slist()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
960
</td>
 
961
</tr>
 
962
</tbody>
 
963
</table></div>
 
964
<p class="since">Since 3.2</p>
 
965
</div>
 
966
<hr>
 
967
<div class="refsect2">
 
968
<a name="CLIENT-BACKEND-PROPERTY-OPENED:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_OPENED</h3>
 
969
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_OPENED                      "opened"
 
970
</pre>
 
971
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
972
<h3 class="title">Warning</h3>
 
973
<p><code class="literal">CLIENT_BACKEND_PROPERTY_OPENED</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients don't need to care if they're fully opened
 
974
                 anymore.  This property will always return <code class="literal">TRUE</code>.</p>
 
975
</div>
 
976
<p>
 
977
The "opened" property is "TRUE" when the client is fully opened,
 
978
"FALSE" at all other times.
 
979
</p>
 
980
<p class="since">Since 3.2</p>
 
981
</div>
 
982
<hr>
 
983
<div class="refsect2">
 
984
<a name="CLIENT-BACKEND-PROPERTY-OPENING:CAPS"></a><h3>CLIENT_BACKEND_PROPERTY_OPENING</h3>
 
985
<pre class="programlisting">#define CLIENT_BACKEND_PROPERTY_OPENING                     "opening"
 
986
</pre>
 
987
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
988
<h3 class="title">Warning</h3>
 
989
<p><code class="literal">CLIENT_BACKEND_PROPERTY_OPENING</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients don't need to care if they're fully opened
 
990
                 anymore.  This property will always return <code class="literal">FALSE</code>.</p>
 
991
</div>
 
992
<p>
 
993
The "opening" property is "TRUE" when the client is in the process of
 
994
opening, "FALSE" at all other times.
 
995
</p>
 
996
<p class="since">Since 3.2</p>
 
997
</div>
 
998
<hr>
 
999
<div class="refsect2">
 
1000
<a name="e-client-error-create"></a><h3>e_client_error_create ()</h3>
 
1001
<pre class="programlisting"><span class="returnvalue">GError</span> *            e_client_error_create               (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> code</code></em>,
 
1002
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *custom_msg</code></em>);</pre>
 
1003
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1004
<h3 class="title">Warning</h3>
 
1005
<p><code class="literal">e_client_error_create</code> has been deprecated since version 3.8 and should not be used in newly-written code. Just use the <span class="type">GError</span> API directly.</p>
 
1006
</div>
 
1007
<div class="variablelist"><table border="0">
 
1008
<col align="left" valign="top">
 
1009
<tbody>
 
1010
<tr>
 
1011
<td><p><span class="term"><em class="parameter"><code>code</code></em> :</span></p></td>
 
1012
<td>an <a class="link" href="eds-EClient.html#EClientError" title="enum EClientError"><span class="type">EClientError</span></a> code to create</td>
 
1013
</tr>
 
1014
<tr>
 
1015
<td><p><span class="term"><em class="parameter"><code>custom_msg</code></em> :</span></p></td>
 
1016
<td>custom message to use for the error; can be <code class="literal">NULL</code>
 
1017
</td>
 
1018
</tr>
 
1019
<tr>
 
1020
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1021
<td>a new <span class="type">GError</span> containing an E_CLIENT_ERROR of the given
 
1022
<em class="parameter"><code>code</code></em>. If the <em class="parameter"><code>custom_msg</code></em> is NULL, then the error message is
 
1023
the one returned from <a class="link" href="eds-EClient.html#e-client-error-to-string" title="e_client_error_to_string ()"><code class="function">e_client_error_to_string()</code></a> for the <em class="parameter"><code>code</code></em>,
 
1024
otherwise the given message is used.
 
1025
Returned pointer should be freed with <code class="function">g_error_free()</code>.</td>
 
1026
</tr>
 
1027
</tbody>
 
1028
</table></div>
 
1029
<p class="since">Since 3.2</p>
 
1030
</div>
 
1031
<hr>
 
1032
<div class="refsect2">
 
1033
<a name="e-client-is-opened"></a><h3>e_client_is_opened ()</h3>
 
1034
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_is_opened                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
1035
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1036
<h3 class="title">Warning</h3>
 
1037
<p><code class="literal">e_client_is_opened</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients don't need to care if they're fully opened
 
1038
                 anymore.  This function always returns <code class="literal">TRUE</code>.</p>
 
1039
</div>
 
1040
<p>
 
1041
Check if this <em class="parameter"><code>client</code></em> is fully opened. This includes
 
1042
everything from <a class="link" href="eds-EClient.html#e-client-open" title="e_client_open ()"><code class="function">e_client_open()</code></a> call up to the authentication,
 
1043
if required by a backend. Client cannot do any other operation
 
1044
during the opening phase except of authenticate or cancel it.
 
1045
Every other operation results in an <a class="link" href="eds-EClient.html#E-CLIENT-ERROR-BUSY:CAPS"><code class="literal">E_CLIENT_ERROR_BUSY</code></a> error.
 
1046
</p>
 
1047
<div class="variablelist"><table border="0">
 
1048
<col align="left" valign="top">
 
1049
<tbody>
 
1050
<tr>
 
1051
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1052
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1053
</td>
 
1054
</tr>
 
1055
<tr>
 
1056
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1057
<td>always <code class="literal">TRUE</code>
 
1058
</td>
 
1059
</tr>
 
1060
</tbody>
 
1061
</table></div>
 
1062
<p class="since">Since 3.2.</p>
 
1063
</div>
 
1064
<hr>
 
1065
<div class="refsect2">
 
1066
<a name="e-client-cancel-all"></a><h3>e_client_cancel_all ()</h3>
 
1067
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_cancel_all                 (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>);</pre>
 
1068
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1069
<h3 class="title">Warning</h3>
 
1070
<p><code class="literal">e_client_cancel_all</code> has been deprecated since version 3.8 and should not be used in newly-written code. The function no longer does anything.</p>
 
1071
</div>
 
1072
<p>
 
1073
Cancels all pending operations started on <em class="parameter"><code>client</code></em>.
 
1074
</p>
 
1075
<div class="variablelist"><table border="0">
 
1076
<col align="left" valign="top">
 
1077
<tbody><tr>
 
1078
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1079
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1080
</td>
 
1081
</tr></tbody>
 
1082
</table></div>
 
1083
<p class="since">Since 3.2</p>
 
1084
</div>
 
1085
<hr>
 
1086
<div class="refsect2">
 
1087
<a name="e-client-unwrap-dbus-error"></a><h3>e_client_unwrap_dbus_error ()</h3>
 
1088
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_unwrap_dbus_error          (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1089
                                                         <em class="parameter"><code><span class="type">GError</span> *dbus_error</code></em>,
 
1090
                                                         <em class="parameter"><code><span class="type">GError</span> **out_error</code></em>);</pre>
 
1091
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1092
<h3 class="title">Warning</h3>
 
1093
<p><code class="literal">e_client_unwrap_dbus_error</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <code class="function">g_dbus_error_strip_remote_error()</code> instead.</p>
 
1094
</div>
 
1095
<p>
 
1096
Unwraps D-Bus error to local error. <em class="parameter"><code>dbus_error</code></em> is automatically freed.
 
1097
<em class="parameter"><code>dbus_erorr</code></em> and <em class="parameter"><code>out_error</code></em> can point to the same variable.
 
1098
</p>
 
1099
<div class="variablelist"><table border="0">
 
1100
<col align="left" valign="top">
 
1101
<tbody>
 
1102
<tr>
 
1103
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1104
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1105
</td>
 
1106
</tr>
 
1107
<tr>
 
1108
<td><p><span class="term"><em class="parameter"><code>dbus_error</code></em> :</span></p></td>
 
1109
<td>a <span class="type">GError</span> returned bu D-Bus</td>
 
1110
</tr>
 
1111
<tr>
 
1112
<td><p><span class="term"><em class="parameter"><code>out_error</code></em> :</span></p></td>
 
1113
<td>a <span class="type">GError</span> variable where to store the result</td>
 
1114
</tr>
 
1115
</tbody>
 
1116
</table></div>
 
1117
<p class="since">Since 3.2</p>
 
1118
</div>
 
1119
<hr>
 
1120
<div class="refsect2">
 
1121
<a name="e-client-retrieve-capabilities"></a><h3>e_client_retrieve_capabilities ()</h3>
 
1122
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_retrieve_capabilities      (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1123
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1124
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1125
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1126
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1127
<h3 class="title">Warning</h3>
 
1128
<p><code class="literal">e_client_retrieve_capabilities</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a> instead.</p>
 
1129
</div>
 
1130
<p>
 
1131
Initiates retrieval of capabilities on the <em class="parameter"><code>client</code></em>. This is usually
 
1132
required only once, after the <em class="parameter"><code>client</code></em> is opened. The returned value
 
1133
is cached and any subsequent call of <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a> and
 
1134
<a class="link" href="eds-EClient.html#e-client-check-capability" title="e_client_check_capability ()"><code class="function">e_client_check_capability()</code></a> is using the cached value.
 
1135
The call is finished by <a class="link" href="eds-EClient.html#e-client-retrieve-capabilities-finish" title="e_client_retrieve_capabilities_finish ()"><code class="function">e_client_retrieve_capabilities_finish()</code></a>
 
1136
from the <em class="parameter"><code>callback</code></em>.
 
1137
</p>
 
1138
<div class="variablelist"><table border="0">
 
1139
<col align="left" valign="top">
 
1140
<tbody>
 
1141
<tr>
 
1142
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1143
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1144
</td>
 
1145
</tr>
 
1146
<tr>
 
1147
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1148
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1149
</td>
 
1150
</tr>
 
1151
<tr>
 
1152
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1153
<td>callback to call when a result is ready</td>
 
1154
</tr>
 
1155
<tr>
 
1156
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1157
<td>user data for the <em class="parameter"><code>callback</code></em>
 
1158
</td>
 
1159
</tr>
 
1160
</tbody>
 
1161
</table></div>
 
1162
<p class="since">Since 3.2</p>
 
1163
</div>
 
1164
<hr>
 
1165
<div class="refsect2">
 
1166
<a name="e-client-retrieve-capabilities-finish"></a><h3>e_client_retrieve_capabilities_finish ()</h3>
 
1167
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_retrieve_capabilities_finish
 
1168
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1169
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1170
                                                         <em class="parameter"><code><span class="type">gchar</span> **capabilities</code></em>,
 
1171
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1172
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1173
<h3 class="title">Warning</h3>
 
1174
<p><code class="literal">e_client_retrieve_capabilities_finish</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a> instead.</p>
 
1175
</div>
 
1176
<p>
 
1177
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-retrieve-capabilities" title="e_client_retrieve_capabilities ()"><code class="function">e_client_retrieve_capabilities()</code></a>.
 
1178
Returned value of <em class="parameter"><code>capabilities</code></em> should be freed with <code class="function">g_free()</code>,
 
1179
when no longer needed.
 
1180
</p>
 
1181
<div class="variablelist"><table border="0">
 
1182
<col align="left" valign="top">
 
1183
<tbody>
 
1184
<tr>
 
1185
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1186
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1187
</td>
 
1188
</tr>
 
1189
<tr>
 
1190
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1191
<td>a <span class="type">GAsyncResult</span>
 
1192
</td>
 
1193
</tr>
 
1194
<tr>
 
1195
<td><p><span class="term"><em class="parameter"><code>capabilities</code></em> :</span></p></td>
 
1196
<td>Comma-separated list of capabilities of the <em class="parameter"><code>client</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1197
</td>
 
1198
</tr>
 
1199
<tr>
 
1200
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1201
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1202
</td>
 
1203
</tr>
 
1204
<tr>
 
1205
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1206
<td>
 
1207
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1208
</tr>
 
1209
</tbody>
 
1210
</table></div>
 
1211
<p class="since">Since 3.2</p>
 
1212
</div>
 
1213
<hr>
 
1214
<div class="refsect2">
 
1215
<a name="e-client-retrieve-capabilities-sync"></a><h3>e_client_retrieve_capabilities_sync ()</h3>
 
1216
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_retrieve_capabilities_sync (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1217
                                                         <em class="parameter"><code><span class="type">gchar</span> **capabilities</code></em>,
 
1218
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1219
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1220
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1221
<h3 class="title">Warning</h3>
 
1222
<p><code class="literal">e_client_retrieve_capabilities_sync</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a> instead.</p>
 
1223
</div>
 
1224
<p>
 
1225
Initiates retrieval of capabilities on the <em class="parameter"><code>client</code></em>. This is usually
 
1226
required only once, after the <em class="parameter"><code>client</code></em> is opened. The returned value
 
1227
is cached and any subsequent call of <a class="link" href="eds-EClient.html#e-client-get-capabilities" title="e_client_get_capabilities ()"><code class="function">e_client_get_capabilities()</code></a> and
 
1228
<a class="link" href="eds-EClient.html#e-client-check-capability" title="e_client_check_capability ()"><code class="function">e_client_check_capability()</code></a> is using the cached value. Returned value
 
1229
of <em class="parameter"><code>capabilities</code></em> should be freed with <code class="function">g_free()</code>, when no longer needed.
 
1230
</p>
 
1231
<div class="variablelist"><table border="0">
 
1232
<col align="left" valign="top">
 
1233
<tbody>
 
1234
<tr>
 
1235
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1236
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1237
</td>
 
1238
</tr>
 
1239
<tr>
 
1240
<td><p><span class="term"><em class="parameter"><code>capabilities</code></em> :</span></p></td>
 
1241
<td>Comma-separated list of capabilities of the <em class="parameter"><code>client</code></em>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1242
</td>
 
1243
</tr>
 
1244
<tr>
 
1245
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1246
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1247
</td>
 
1248
</tr>
 
1249
<tr>
 
1250
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1251
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1252
</td>
 
1253
</tr>
 
1254
<tr>
 
1255
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1256
<td>
 
1257
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1258
</tr>
 
1259
</tbody>
 
1260
</table></div>
 
1261
<p class="since">Since 3.2</p>
 
1262
</div>
 
1263
<hr>
 
1264
<div class="refsect2">
 
1265
<a name="e-client-set-backend-property"></a><h3>e_client_set_backend_property ()</h3>
 
1266
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_set_backend_property       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1267
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
1268
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_value</code></em>,
 
1269
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1270
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1271
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1272
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1273
<h3 class="title">Warning</h3>
 
1274
<p><code class="literal">e_client_set_backend_property</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients cannot set backend properties.  Any attempt
 
1275
                 will fail with an <a class="link" href="eds-EClient.html#E-CLIENT-ERROR-NOT-SUPPORTED:CAPS"><code class="literal">E_CLIENT_ERROR_NOT_SUPPORTED</code></a> error.</p>
 
1276
</div>
 
1277
<p>
 
1278
Sets <em class="parameter"><code>client</code></em>'s backend property of name <em class="parameter"><code>prop_name</code></em>
 
1279
to value <em class="parameter"><code>prop_value</code></em>. The call is finished
 
1280
by <a class="link" href="eds-EClient.html#e-client-set-backend-property-finish" title="e_client_set_backend_property_finish ()"><code class="function">e_client_set_backend_property_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
 
1281
</p>
 
1282
<div class="variablelist"><table border="0">
 
1283
<col align="left" valign="top">
 
1284
<tbody>
 
1285
<tr>
 
1286
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1287
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1288
</td>
 
1289
</tr>
 
1290
<tr>
 
1291
<td><p><span class="term"><em class="parameter"><code>prop_name</code></em> :</span></p></td>
 
1292
<td>property name, whose value to change; cannot be <code class="literal">NULL</code>
 
1293
</td>
 
1294
</tr>
 
1295
<tr>
 
1296
<td><p><span class="term"><em class="parameter"><code>prop_value</code></em> :</span></p></td>
 
1297
<td>property value, to set; cannot be <code class="literal">NULL</code>
 
1298
</td>
 
1299
</tr>
 
1300
<tr>
 
1301
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1302
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1303
</td>
 
1304
</tr>
 
1305
<tr>
 
1306
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1307
<td>callback to call when a result is ready</td>
 
1308
</tr>
 
1309
<tr>
 
1310
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1311
<td>user data for the <em class="parameter"><code>callback</code></em>
 
1312
</td>
 
1313
</tr>
 
1314
</tbody>
 
1315
</table></div>
 
1316
<p class="since">Since 3.2</p>
 
1317
</div>
 
1318
<hr>
 
1319
<div class="refsect2">
 
1320
<a name="e-client-set-backend-property-finish"></a><h3>e_client_set_backend_property_finish ()</h3>
 
1321
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_set_backend_property_finish
 
1322
                                                        (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1323
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1324
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1325
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1326
<h3 class="title">Warning</h3>
 
1327
<p><code class="literal">e_client_set_backend_property_finish</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients cannot set backend properties.  Any attempt
 
1328
                 will fail with an <a class="link" href="eds-EClient.html#E-CLIENT-ERROR-NOT-SUPPORTED:CAPS"><code class="literal">E_CLIENT_ERROR_NOT_SUPPORTED</code></a> error.</p>
 
1329
</div>
 
1330
<p>
 
1331
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-set-backend-property" title="e_client_set_backend_property ()"><code class="function">e_client_set_backend_property()</code></a>.
 
1332
</p>
 
1333
<div class="variablelist"><table border="0">
 
1334
<col align="left" valign="top">
 
1335
<tbody>
 
1336
<tr>
 
1337
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1338
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1339
</td>
 
1340
</tr>
 
1341
<tr>
 
1342
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1343
<td>a <span class="type">GAsyncResult</span>
 
1344
</td>
 
1345
</tr>
 
1346
<tr>
 
1347
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1348
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1349
</td>
 
1350
</tr>
 
1351
<tr>
 
1352
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1353
<td>
 
1354
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1355
</tr>
 
1356
</tbody>
 
1357
</table></div>
 
1358
<p class="since">Since 3.2</p>
 
1359
</div>
 
1360
<hr>
 
1361
<div class="refsect2">
 
1362
<a name="e-client-set-backend-property-sync"></a><h3>e_client_set_backend_property_sync ()</h3>
 
1363
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_set_backend_property_sync  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1364
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_name</code></em>,
 
1365
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *prop_value</code></em>,
 
1366
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1367
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1368
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1369
<h3 class="title">Warning</h3>
 
1370
<p><code class="literal">e_client_set_backend_property_sync</code> has been deprecated since version 3.8 and should not be used in newly-written code. Clients cannot set backend properties.  Any attempt
 
1371
                 will fail with an <a class="link" href="eds-EClient.html#E-CLIENT-ERROR-NOT-SUPPORTED:CAPS"><code class="literal">E_CLIENT_ERROR_NOT_SUPPORTED</code></a> error.</p>
 
1372
</div>
 
1373
<p>
 
1374
Sets <em class="parameter"><code>client</code></em>'s backend property of name <em class="parameter"><code>prop_name</code></em>
 
1375
to value <em class="parameter"><code>prop_value</code></em>.
 
1376
</p>
 
1377
<div class="variablelist"><table border="0">
 
1378
<col align="left" valign="top">
 
1379
<tbody>
 
1380
<tr>
 
1381
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1382
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1383
</td>
 
1384
</tr>
 
1385
<tr>
 
1386
<td><p><span class="term"><em class="parameter"><code>prop_name</code></em> :</span></p></td>
 
1387
<td>property name, whose value to change; cannot be <code class="literal">NULL</code>
 
1388
</td>
 
1389
</tr>
 
1390
<tr>
 
1391
<td><p><span class="term"><em class="parameter"><code>prop_value</code></em> :</span></p></td>
 
1392
<td>property value, to set; cannot be <code class="literal">NULL</code>
 
1393
</td>
 
1394
</tr>
 
1395
<tr>
 
1396
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1397
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1398
</td>
 
1399
</tr>
 
1400
<tr>
 
1401
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1402
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1403
</td>
 
1404
</tr>
 
1405
<tr>
 
1406
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1407
<td>
 
1408
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1409
</tr>
 
1410
</tbody>
 
1411
</table></div>
 
1412
<p class="since">Since 3.2</p>
 
1413
</div>
 
1414
<hr>
 
1415
<div class="refsect2">
 
1416
<a name="e-client-open"></a><h3>e_client_open ()</h3>
 
1417
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_open                       (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1418
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
 
1419
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1420
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1421
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1422
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1423
<h3 class="title">Warning</h3>
 
1424
<p><code class="literal">e_client_open</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EBookClient.html#e-book-client-connect" title="e_book_client_connect ()"><code class="function">e_book_client_connect()</code></a> and
 
1425
                 <a class="link" href="eds-EBookClient.html#e-book-client-connect-finish" title="e_book_client_connect_finish ()"><code class="function">e_book_client_connect_finish()</code></a> or
 
1426
                 <a class="link" href="eds-ECalClient.html#e-cal-client-connect" title="e_cal_client_connect ()"><code class="function">e_cal_client_connect()</code></a> and
 
1427
                 <a class="link" href="eds-ECalClient.html#e-cal-client-connect-finish" title="e_cal_client_connect_finish ()"><code class="function">e_cal_client_connect_finish()</code></a> instead.</p>
 
1428
</div>
 
1429
<p>
 
1430
Opens the <em class="parameter"><code>client</code></em>, making it ready for queries and other operations.
 
1431
The call is finished by <a class="link" href="eds-EClient.html#e-client-open-finish" title="e_client_open_finish ()"><code class="function">e_client_open_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
 
1432
</p>
 
1433
<div class="variablelist"><table border="0">
 
1434
<col align="left" valign="top">
 
1435
<tbody>
 
1436
<tr>
 
1437
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1438
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1439
</td>
 
1440
</tr>
 
1441
<tr>
 
1442
<td><p><span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></p></td>
 
1443
<td>if <code class="literal">TRUE</code>, fail if this book doesn't already exist,
 
1444
otherwise create it first</td>
 
1445
</tr>
 
1446
<tr>
 
1447
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1448
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1449
</td>
 
1450
</tr>
 
1451
<tr>
 
1452
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1453
<td>callback to call when a result is ready</td>
 
1454
</tr>
 
1455
<tr>
 
1456
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1457
<td>user data for the <em class="parameter"><code>callback</code></em>
 
1458
</td>
 
1459
</tr>
 
1460
</tbody>
 
1461
</table></div>
 
1462
<p class="since">Since 3.2</p>
 
1463
</div>
 
1464
<hr>
 
1465
<div class="refsect2">
 
1466
<a name="e-client-open-finish"></a><h3>e_client_open_finish ()</h3>
 
1467
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_open_finish                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1468
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1469
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1470
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1471
<h3 class="title">Warning</h3>
 
1472
<p><code class="literal">e_client_open_finish</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EBookClient.html#e-book-client-connect" title="e_book_client_connect ()"><code class="function">e_book_client_connect()</code></a> and
 
1473
                 <a class="link" href="eds-EBookClient.html#e-book-client-connect-finish" title="e_book_client_connect_finish ()"><code class="function">e_book_client_connect_finish()</code></a> or
 
1474
                 <a class="link" href="eds-ECalClient.html#e-cal-client-connect" title="e_cal_client_connect ()"><code class="function">e_cal_client_connect()</code></a> and
 
1475
                 <a class="link" href="eds-ECalClient.html#e-cal-client-connect-finish" title="e_cal_client_connect_finish ()"><code class="function">e_cal_client_connect_finish()</code></a> instead.</p>
 
1476
</div>
 
1477
<p>
 
1478
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-open" title="e_client_open ()"><code class="function">e_client_open()</code></a>.
 
1479
</p>
 
1480
<div class="variablelist"><table border="0">
 
1481
<col align="left" valign="top">
 
1482
<tbody>
 
1483
<tr>
 
1484
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1485
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1486
</td>
 
1487
</tr>
 
1488
<tr>
 
1489
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1490
<td>a <span class="type">GAsyncResult</span>
 
1491
</td>
 
1492
</tr>
 
1493
<tr>
 
1494
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1495
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1496
</td>
 
1497
</tr>
 
1498
<tr>
 
1499
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1500
<td>
 
1501
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1502
</tr>
 
1503
</tbody>
 
1504
</table></div>
 
1505
<p class="since">Since 3.2</p>
 
1506
</div>
 
1507
<hr>
 
1508
<div class="refsect2">
 
1509
<a name="e-client-open-sync"></a><h3>e_client_open_sync ()</h3>
 
1510
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_open_sync                  (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1511
                                                         <em class="parameter"><code><span class="type">gboolean</span> only_if_exists</code></em>,
 
1512
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1513
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1514
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1515
<h3 class="title">Warning</h3>
 
1516
<p><code class="literal">e_client_open_sync</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-EBookClient.html#e-book-client-connect-sync" title="e_book_client_connect_sync ()"><code class="function">e_book_client_connect_sync()</code></a> or
 
1517
                 <a class="link" href="eds-ECalClient.html#e-cal-client-connect-sync" title="e_cal_client_connect_sync ()"><code class="function">e_cal_client_connect_sync()</code></a> instead.</p>
 
1518
</div>
 
1519
<p>
 
1520
Opens the <em class="parameter"><code>client</code></em>, making it ready for queries and other operations.
 
1521
</p>
 
1522
<div class="variablelist"><table border="0">
 
1523
<col align="left" valign="top">
 
1524
<tbody>
 
1525
<tr>
 
1526
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1527
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1528
</td>
 
1529
</tr>
 
1530
<tr>
 
1531
<td><p><span class="term"><em class="parameter"><code>only_if_exists</code></em> :</span></p></td>
 
1532
<td>if <code class="literal">TRUE</code>, fail if this book doesn't already exist,
 
1533
otherwise create it first</td>
 
1534
</tr>
 
1535
<tr>
 
1536
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1537
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1538
</td>
 
1539
</tr>
 
1540
<tr>
 
1541
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1542
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1543
</td>
 
1544
</tr>
 
1545
<tr>
 
1546
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1547
<td>
 
1548
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1549
</tr>
 
1550
</tbody>
 
1551
</table></div>
 
1552
<p class="since">Since 3.2</p>
 
1553
</div>
 
1554
<hr>
 
1555
<div class="refsect2">
 
1556
<a name="e-client-remove"></a><h3>e_client_remove ()</h3>
 
1557
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_remove                     (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1558
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1559
                                                         <em class="parameter"><code><span class="type">GAsyncReadyCallback</span> callback</code></em>,
 
1560
                                                         <em class="parameter"><code><span class="type">gpointer</span> user_data</code></em>);</pre>
 
1561
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1562
<h3 class="title">Warning</h3>
 
1563
<p><code class="literal">e_client_remove</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="eds-ESource.html#e-source-remove" title="e_source_remove ()"><code class="function">e_source_remove()</code></a> instead.</p>
 
1564
</div>
 
1565
<p>
 
1566
Removes the backing data for this <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>. For example, with the file
 
1567
backend this deletes the database file. You cannot get it back!
 
1568
The call is finished by <a class="link" href="eds-EClient.html#e-client-remove-finish" title="e_client_remove_finish ()"><code class="function">e_client_remove_finish()</code></a> from the <em class="parameter"><code>callback</code></em>.
 
1569
</p>
 
1570
<div class="variablelist"><table border="0">
 
1571
<col align="left" valign="top">
 
1572
<tbody>
 
1573
<tr>
 
1574
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1575
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1576
</td>
 
1577
</tr>
 
1578
<tr>
 
1579
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1580
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1581
</td>
 
1582
</tr>
 
1583
<tr>
 
1584
<td><p><span class="term"><em class="parameter"><code>callback</code></em> :</span></p></td>
 
1585
<td>callback to call when a result is ready</td>
 
1586
</tr>
 
1587
<tr>
 
1588
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
 
1589
<td>user data for the <em class="parameter"><code>callback</code></em>
 
1590
</td>
 
1591
</tr>
 
1592
</tbody>
 
1593
</table></div>
 
1594
<p class="since">Since 3.2</p>
 
1595
</div>
 
1596
<hr>
 
1597
<div class="refsect2">
 
1598
<a name="e-client-remove-finish"></a><h3>e_client_remove_finish ()</h3>
 
1599
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_finish              (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1600
                                                         <em class="parameter"><code><span class="type">GAsyncResult</span> *result</code></em>,
 
1601
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1602
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1603
<h3 class="title">Warning</h3>
 
1604
<p><code class="literal">e_client_remove_finish</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="eds-ESource.html#e-source-remove-finish" title="e_source_remove_finish ()"><code class="function">e_source_remove_finish()</code></a> instead.</p>
 
1605
</div>
 
1606
<p>
 
1607
Finishes previous call of <a class="link" href="eds-EClient.html#e-client-remove" title="e_client_remove ()"><code class="function">e_client_remove()</code></a>.
 
1608
</p>
 
1609
<div class="variablelist"><table border="0">
 
1610
<col align="left" valign="top">
 
1611
<tbody>
 
1612
<tr>
 
1613
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1614
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1615
</td>
 
1616
</tr>
 
1617
<tr>
 
1618
<td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
 
1619
<td>a <span class="type">GAsyncResult</span>
 
1620
</td>
 
1621
</tr>
 
1622
<tr>
 
1623
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1624
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1625
</td>
 
1626
</tr>
 
1627
<tr>
 
1628
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1629
<td>
 
1630
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1631
</tr>
 
1632
</tbody>
 
1633
</table></div>
 
1634
<p class="since">Since 3.2</p>
 
1635
</div>
 
1636
<hr>
 
1637
<div class="refsect2">
 
1638
<a name="e-client-remove-sync"></a><h3>e_client_remove_sync ()</h3>
 
1639
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_remove_sync                (<em class="parameter"><code><a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a> *client</code></em>,
 
1640
                                                         <em class="parameter"><code><span class="type">GCancellable</span> *cancellable</code></em>,
 
1641
                                                         <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
 
1642
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1643
<h3 class="title">Warning</h3>
 
1644
<p><code class="literal">e_client_remove_sync</code> has been deprecated since version 3.6 and should not be used in newly-written code. Use <a class="link" href="eds-ESource.html#e-source-remove-sync" title="e_source_remove_sync ()"><code class="function">e_source_remove_sync()</code></a> instead.</p>
 
1645
</div>
 
1646
<p>
 
1647
Removes the backing data for this <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>. For example, with the file
 
1648
backend this deletes the database file. You cannot get it back!
 
1649
</p>
 
1650
<div class="variablelist"><table border="0">
 
1651
<col align="left" valign="top">
 
1652
<tbody>
 
1653
<tr>
 
1654
<td><p><span class="term"><em class="parameter"><code>client</code></em> :</span></p></td>
 
1655
<td>an <a class="link" href="eds-EClient.html#EClient" title="struct EClient"><span class="type">EClient</span></a>
 
1656
</td>
 
1657
</tr>
 
1658
<tr>
 
1659
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
 
1660
<td>a <span class="type">GCancellable</span>; can be <code class="literal">NULL</code>
 
1661
</td>
 
1662
</tr>
 
1663
<tr>
 
1664
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
 
1665
<td>a <span class="type">GError</span> to set an error, if any. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1666
</td>
 
1667
</tr>
 
1668
<tr>
 
1669
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1670
<td>
 
1671
<code class="literal">TRUE</code> if successful, <code class="literal">FALSE</code> otherwise.</td>
 
1672
</tr>
 
1673
</tbody>
 
1674
</table></div>
 
1675
<p class="since">Since 3.2</p>
 
1676
</div>
 
1677
<hr>
 
1678
<div class="refsect2">
 
1679
<a name="e-client-util-slist-to-strv"></a><h3>e_client_util_slist_to_strv ()</h3>
 
1680
<pre class="programlisting"><span class="returnvalue">gchar</span> **            e_client_util_slist_to_strv         (<em class="parameter"><code>const <span class="type">GSList</span> *strings</code></em>);</pre>
 
1681
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1682
<h3 class="title">Warning</h3>
 
1683
<p><code class="literal">e_client_util_slist_to_strv</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-Main-Utility-Toolbox.html#e-util-slist-to-strv" title="e_util_slist_to_strv ()"><code class="function">e_util_slist_to_strv()</code></a> instead.</p>
 
1684
</div>
 
1685
<p>
 
1686
Convert a list of strings into a <code class="literal">NULL</code>-terminated array of strings.
 
1687
</p>
 
1688
<div class="variablelist"><table border="0">
 
1689
<col align="left" valign="top">
 
1690
<tbody>
 
1691
<tr>
 
1692
<td><p><span class="term"><em class="parameter"><code>strings</code></em> :</span></p></td>
 
1693
<td>a <span class="type">GSList</span> of strings (const gchar *). <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
1694
</td>
 
1695
</tr>
 
1696
<tr>
 
1697
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1698
<td>Newly allocated <code class="literal">NULL</code>-terminated array of strings.
 
1699
The returned pointer should be freed with <code class="function">g_strfreev()</code>.
 
1700
Note: Paired function for this is <a class="link" href="eds-EClient.html#e-client-util-strv-to-slist" title="e_client_util_strv_to_slist ()"><code class="function">e_client_util_strv_to_slist()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
 
1701
</td>
 
1702
</tr>
 
1703
</tbody>
 
1704
</table></div>
 
1705
<p class="since">Since 3.2</p>
 
1706
</div>
 
1707
<hr>
 
1708
<div class="refsect2">
 
1709
<a name="e-client-util-strv-to-slist"></a><h3>e_client_util_strv_to_slist ()</h3>
 
1710
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_client_util_strv_to_slist         (<em class="parameter"><code>const <span class="type">gchar</span> * const *strv</code></em>);</pre>
 
1711
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1712
<h3 class="title">Warning</h3>
 
1713
<p><code class="literal">e_client_util_strv_to_slist</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-Main-Utility-Toolbox.html#e-util-strv-to-slist" title="e_util_strv_to_slist ()"><code class="function">e_util_strv_to_slist()</code></a> instead.</p>
 
1714
</div>
 
1715
<p>
 
1716
Convert a <code class="literal">NULL</code>-terminated array of strings to a list of strings.
 
1717
</p>
 
1718
<div class="variablelist"><table border="0">
 
1719
<col align="left" valign="top">
 
1720
<tbody>
 
1721
<tr>
 
1722
<td><p><span class="term"><em class="parameter"><code>strv</code></em> :</span></p></td>
 
1723
<td>a <code class="literal">NULL</code>-terminated array of strings (const gchar *)</td>
 
1724
</tr>
 
1725
<tr>
 
1726
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1727
<td>Newly allocated <span class="type">GSList</span> of
 
1728
newly allocated strings. The returned pointer should be freed with
 
1729
<a class="link" href="eds-EClient.html#e-client-util-free-string-slist" title="e_client_util_free_string_slist ()"><code class="function">e_client_util_free_string_slist()</code></a>.
 
1730
Note: Paired function for this is <a class="link" href="eds-EClient.html#e-client-util-slist-to-strv" title="e_client_util_slist_to_strv ()"><code class="function">e_client_util_slist_to_strv()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
1731
</td>
 
1732
</tr>
 
1733
</tbody>
 
1734
</table></div>
 
1735
<p class="since">Since 3.2</p>
 
1736
</div>
 
1737
<hr>
 
1738
<div class="refsect2">
 
1739
<a name="e-client-util-copy-string-slist"></a><h3>e_client_util_copy_string_slist ()</h3>
 
1740
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_client_util_copy_string_slist     (<em class="parameter"><code><span class="type">GSList</span> *copy_to</code></em>,
 
1741
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *strings</code></em>);</pre>
 
1742
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1743
<h3 class="title">Warning</h3>
 
1744
<p><code class="literal">e_client_util_copy_string_slist</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-Main-Utility-Toolbox.html#e-util-copy-string-slist" title="e_util_copy_string_slist ()"><code class="function">e_util_copy_string_slist()</code></a> instead.</p>
 
1745
</div>
 
1746
<p>
 
1747
Copies the <span class="type">GSList</span> of strings to the end of <em class="parameter"><code>copy_to</code></em>.
 
1748
</p>
 
1749
<div class="variablelist"><table border="0">
 
1750
<col align="left" valign="top">
 
1751
<tbody>
 
1752
<tr>
 
1753
<td><p><span class="term"><em class="parameter"><code>copy_to</code></em> :</span></p></td>
 
1754
<td>Where to copy; may be <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1755
</td>
 
1756
</tr>
 
1757
<tr>
 
1758
<td><p><span class="term"><em class="parameter"><code>strings</code></em> :</span></p></td>
 
1759
<td>
 
1760
<span class="type">GSList</span> of strings to be copied. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
1761
</td>
 
1762
</tr>
 
1763
<tr>
 
1764
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1765
<td>New head of <em class="parameter"><code>copy_to</code></em>.
 
1766
The returned pointer can be freed with <a class="link" href="eds-EClient.html#e-client-util-free-string-slist" title="e_client_util_free_string_slist ()"><code class="function">e_client_util_free_string_slist()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
1767
</td>
 
1768
</tr>
 
1769
</tbody>
 
1770
</table></div>
 
1771
<p class="since">Since 3.2</p>
 
1772
</div>
 
1773
<hr>
 
1774
<div class="refsect2">
 
1775
<a name="e-client-util-copy-object-slist"></a><h3>e_client_util_copy_object_slist ()</h3>
 
1776
<pre class="programlisting"><span class="returnvalue">GSList</span> *            e_client_util_copy_object_slist     (<em class="parameter"><code><span class="type">GSList</span> *copy_to</code></em>,
 
1777
                                                         <em class="parameter"><code>const <span class="type">GSList</span> *objects</code></em>);</pre>
 
1778
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1779
<h3 class="title">Warning</h3>
 
1780
<p><code class="literal">e_client_util_copy_object_slist</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <a class="link" href="eds-Main-Utility-Toolbox.html#e-util-copy-object-slist" title="e_util_copy_object_slist ()"><code class="function">e_util_copy_object_slist()</code></a> instead.</p>
 
1781
</div>
 
1782
<p>
 
1783
Copies a <span class="type">GSList</span> of <span class="type">GObject</span>s to the end of <em class="parameter"><code>copy_to</code></em>.
 
1784
</p>
 
1785
<div class="variablelist"><table border="0">
 
1786
<col align="left" valign="top">
 
1787
<tbody>
 
1788
<tr>
 
1789
<td><p><span class="term"><em class="parameter"><code>copy_to</code></em> :</span></p></td>
 
1790
<td>Where to copy; may be <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
1791
</td>
 
1792
</tr>
 
1793
<tr>
 
1794
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
 
1795
<td>
 
1796
<span class="type">GSList</span> of <span class="type">GObject</span>s to be copied. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject]</span>
 
1797
</td>
 
1798
</tr>
 
1799
<tr>
 
1800
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1801
<td>New head of <em class="parameter"><code>copy_to</code></em>.
 
1802
The returned pointer can be freed with <a class="link" href="eds-EClient.html#e-client-util-free-object-slist" title="e_client_util_free_object_slist ()"><code class="function">e_client_util_free_object_slist()</code></a>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject]</span>
 
1803
</td>
 
1804
</tr>
 
1805
</tbody>
 
1806
</table></div>
 
1807
<p class="since">Since 3.2</p>
 
1808
</div>
 
1809
<hr>
 
1810
<div class="refsect2">
 
1811
<a name="e-client-util-free-string-slist"></a><h3>e_client_util_free_string_slist ()</h3>
 
1812
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_util_free_string_slist     (<em class="parameter"><code><span class="type">GSList</span> *strings</code></em>);</pre>
 
1813
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1814
<h3 class="title">Warning</h3>
 
1815
<p><code class="literal">e_client_util_free_string_slist</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <code class="function">g_slist_free_full()</code> instead.</p>
 
1816
</div>
 
1817
<p>
 
1818
Frees memory previously allocated by <a class="link" href="eds-EClient.html#e-client-util-strv-to-slist" title="e_client_util_strv_to_slist ()"><code class="function">e_client_util_strv_to_slist()</code></a>.
 
1819
</p>
 
1820
<div class="variablelist"><table border="0">
 
1821
<col align="left" valign="top">
 
1822
<tbody><tr>
 
1823
<td><p><span class="term"><em class="parameter"><code>strings</code></em> :</span></p></td>
 
1824
<td>a <span class="type">GSList</span> of strings (gchar *). <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span>
 
1825
</td>
 
1826
</tr></tbody>
 
1827
</table></div>
 
1828
<p class="since">Since 3.2</p>
 
1829
</div>
 
1830
<hr>
 
1831
<div class="refsect2">
 
1832
<a name="e-client-util-free-object-slist"></a><h3>e_client_util_free_object_slist ()</h3>
 
1833
<pre class="programlisting"><span class="returnvalue">void</span>                e_client_util_free_object_slist     (<em class="parameter"><code><span class="type">GSList</span> *objects</code></em>);</pre>
 
1834
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1835
<h3 class="title">Warning</h3>
 
1836
<p><code class="literal">e_client_util_free_object_slist</code> has been deprecated since version 3.8 and should not be used in newly-written code. Use <code class="function">g_slist_free_full()</code> instead.</p>
 
1837
</div>
 
1838
<p>
 
1839
Calls <code class="function">g_object_unref()</code> on each member of <em class="parameter"><code>objects</code></em> and then frees <em class="parameter"><code>objects</code></em>
 
1840
itself.
 
1841
</p>
 
1842
<div class="variablelist"><table border="0">
 
1843
<col align="left" valign="top">
 
1844
<tbody><tr>
 
1845
<td><p><span class="term"><em class="parameter"><code>objects</code></em> :</span></p></td>
 
1846
<td>a <span class="type">GSList</span> of <span class="type">GObject</span>s. <span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> GObject]</span>
 
1847
</td>
 
1848
</tr></tbody>
 
1849
</table></div>
 
1850
<p class="since">Since 3.2</p>
 
1851
</div>
 
1852
<hr>
 
1853
<div class="refsect2">
 
1854
<a name="EClientErrorsList"></a><h3>struct EClientErrorsList</h3>
 
1855
<pre class="programlisting">struct EClientErrorsList {
 
1856
        const gchar *name;
 
1857
        gint err_code;
 
1858
};
 
1859
</pre>
 
1860
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1861
<h3 class="title">Warning</h3>
 
1862
<p><code class="literal">EClientErrorsList</code> has been deprecated since version 3.8 and should not be used in newly-written code. This structure is no longer used.</p>
 
1863
</div>
 
1864
<p class="since">Since 3.2</p>
 
1865
</div>
 
1866
<hr>
 
1867
<div class="refsect2">
 
1868
<a name="e-client-util-unwrap-dbus-error"></a><h3>e_client_util_unwrap_dbus_error ()</h3>
 
1869
<pre class="programlisting"><span class="returnvalue">gboolean</span>            e_client_util_unwrap_dbus_error     (<em class="parameter"><code><span class="type">GError</span> *dbus_error</code></em>,
 
1870
                                                         <em class="parameter"><code><span class="type">GError</span> **client_error</code></em>,
 
1871
                                                         <em class="parameter"><code>const <a class="link" href="eds-EClient.html#EClientErrorsList" title="struct EClientErrorsList"><span class="type">EClientErrorsList</span></a> *known_errors</code></em>,
 
1872
                                                         <em class="parameter"><code><span class="type">guint</span> known_errors_count</code></em>,
 
1873
                                                         <em class="parameter"><code><span class="type">GQuark</span> known_errors_domain</code></em>,
 
1874
                                                         <em class="parameter"><code><span class="type">gboolean</span> fail_when_none_matched</code></em>);</pre>
 
1875
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
 
1876
<h3 class="title">Warning</h3>
 
1877
<p><code class="literal">e_client_util_unwrap_dbus_error</code> has been deprecated since version 3.8 and should not be used in newly-written code. This function is no longer used.</p>
 
1878
</div>
 
1879
<p>
 
1880
The function takes a <em class="parameter"><code>dbus_error</code></em> and tries to find a match in <em class="parameter"><code>known_errors</code></em>
 
1881
for it, if it is a G_IO_ERROR, G_IO_ERROR_DBUS_ERROR. If it is anything else
 
1882
then the <em class="parameter"><code>dbus_error</code></em> is moved to <em class="parameter"><code>client_error</code></em>.
 
1883
</p>
 
1884
<p>
 
1885
The <em class="parameter"><code>fail_when_none_matched</code></em> influences behaviour. If it's <code class="literal">TRUE</code>, and none of
 
1886
<em class="parameter"><code>known_errors</code></em> matches, or this is not a G_IO_ERROR_DBUS_ERROR, then <code class="literal">FALSE</code>
 
1887
is returned and the <em class="parameter"><code>client_error</code></em> is left without change. Otherwise, the
 
1888
<em class="parameter"><code>fail_when_none_matched</code></em> is <code class="literal">FALSE</code>, the error is always processed and will
 
1889
result in E_CLIENT_ERROR, E_CLIENT_ERROR_OTHER_ERROR if none of <em class="parameter"><code>known_error</code></em>
 
1890
matches.
 
1891
</p>
 
1892
<div class="variablelist"><table border="0">
 
1893
<col align="left" valign="top">
 
1894
<tbody>
 
1895
<tr>
 
1896
<td><p><span class="term"><em class="parameter"><code>dbus_error</code></em> :</span></p></td>
 
1897
<td>DBus <span class="type">GError</span> to unwrap</td>
 
1898
</tr>
 
1899
<tr>
 
1900
<td><p><span class="term"><em class="parameter"><code>client_error</code></em> :</span></p></td>
 
1901
<td>Resulting <span class="type">GError</span>; can be <code class="literal">NULL</code>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
 
1902
</td>
 
1903
</tr>
 
1904
<tr>
 
1905
<td><p><span class="term"><em class="parameter"><code>known_errors</code></em> :</span></p></td>
 
1906
<td>List of known errors against which try to match</td>
 
1907
</tr>
 
1908
<tr>
 
1909
<td><p><span class="term"><em class="parameter"><code>known_errors_count</code></em> :</span></p></td>
 
1910
<td>How many items are stored in <em class="parameter"><code>known_errors</code></em>
 
1911
</td>
 
1912
</tr>
 
1913
<tr>
 
1914
<td><p><span class="term"><em class="parameter"><code>known_errors_domain</code></em> :</span></p></td>
 
1915
<td>Error domain for <em class="parameter"><code>known_errors</code></em>
 
1916
</td>
 
1917
</tr>
 
1918
<tr>
 
1919
<td><p><span class="term"><em class="parameter"><code>fail_when_none_matched</code></em> :</span></p></td>
 
1920
<td>Whether to fail when none of <em class="parameter"><code>known_errors</code></em> matches</td>
 
1921
</tr>
 
1922
<tr>
 
1923
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
1924
<td>Whether was <em class="parameter"><code>dbus_error</code></em> processed into <em class="parameter"><code>client_error</code></em>.
 
1925
Note: The <em class="parameter"><code>dbus_error</code></em> is automatically freed if returned <code class="literal">TRUE</code>.</td>
 
1926
</tr>
 
1927
</tbody>
 
1928
</table></div>
 
1929
<p class="since">Since 3.2</p>
 
1930
</div>
 
1931
</div>
 
1932
</div>
 
1933
<div class="footer">
 
1934
<hr>
 
1935
          Generated by GTK-Doc V1.19</div>
 
1936
</body>
 
1937
</html>
 
 
b'\\ No newline at end of file'