evolution-data-server-doc 3.28.1-1ubuntu1 / usr / share / gtk-doc / html / evolution-data-server / evolution-data-server-EWebDAVCollectionBackend.html

This file is indexed.

/usr/share/gtk-doc/html/evolution-data-server/evolution-data-server-EWebDAVCollectionBackend.html is in evolution-data-server-doc 3.28.1-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>EWebDAVCollectionBackend: Evolution-Data-Server Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.1">
<link rel="home" href="index.html" title="Evolution-Data-Server Reference Manual">
<link rel="up" href="ch07.html" title="Registry Service Classes">
<link rel="prev" href="evolution-data-server-ESourceRegistryServer.html" title="ESourceRegistryServer">
<link rel="next" href="ch08.html" title="Addressbook Backend Classes">
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
<td width="100%" align="left" class="shortcuts">
<a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
                  <a href="#evolution-data-server-EWebDAVCollectionBackend.description" class="shortcut">Description</a></span>
</td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
<td><a accesskey="u" href="ch07.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="evolution-data-server-ESourceRegistryServer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="ch08.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="evolution-data-server-EWebDAVCollectionBackend"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="evolution-data-server-EWebDAVCollectionBackend.top_of_page"></a>EWebDAVCollectionBackend</span></h2>
<p>EWebDAVCollectionBackend</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="evolution-data-server-EWebDAVCollectionBackend.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#e-webdav-collection-backend-get-resource-id" title="e_webdav_collection_backend_get_resource_id ()">e_webdav_collection_backend_get_resource_id</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#e-webdav-collection-backend-is-custom-source" title="e_webdav_collection_backend_is_custom_source ()">e_webdav_collection_backend_is_custom_source</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a class="link" href="evolution-data-server-e-source-enums.html#ESourceAuthenticationResult" title="enum ESourceAuthenticationResult"><span class="returnvalue">ESourceAuthenticationResult</span></a>
</td>
<td class="function_name">
<a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#e-webdav-collection-backend-discover-sync" title="e_webdav_collection_backend_discover_sync ()">e_webdav_collection_backend_discover_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EWebDAVCollectionBackend.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody><tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend">EWebDAVCollectionBackend</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EWebDAVCollectionBackend.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="evolution-data-server-EWebDAVCollectionBackend.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-webdav-collection-backend-get-resource-id"></a><h3>e_webdav_collection_backend_get_resource_id ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_webdav_collection_backend_get_resource_id
                               (<em class="parameter"><code><a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a> *webdav_backend</code></em>,
                                <em class="parameter"><code><a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<p>Verifies that the <em class="parameter"><code>source</code></em>
 is expected here and returns its resource ID,
which is used in call to <a class="link" href="evolution-data-server-ECollectionBackend.html#e-collection-backend-new-child" title="e_collection_backend_new_child ()"><code class="function">e_collection_backend_new_child()</code></a>. It returns <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>,
when the <em class="parameter"><code>source</code></em>
 is not part of the backend and should be removed instead.
The default implementation allows all sources, which has <a class="link" href="evolution-data-server-ESourceResource.html#ESourceResource" title="struct ESourceResource"><code class="literal">ESourceResource</code></a>
extension defined.</p>
<div class="refsect3">
<a name="e-webdav-collection-backend-get-resource-id.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>webdav_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-webdav-collection-backend-get-resource-id.returns"></a><h4>Returns</h4>
<p>a resource ID corresponding to <em class="parameter"><code>source</code></em>
,
or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, when the <em class="parameter"><code>source</code></em>
should be removed. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-webdav-collection-backend-is-custom-source"></a><h3>e_webdav_collection_backend_is_custom_source ()</h3>
<pre class="programlisting"><a href="../glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_webdav_collection_backend_is_custom_source
                               (<em class="parameter"><code><a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a> *webdav_backend</code></em>,
                                <em class="parameter"><code><a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> *source</code></em>);</pre>
<div class="refsect3">
<a name="e-webdav-collection-backend-is-custom-source.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>webdav_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-webdav-collection-backend-is-custom-source.returns"></a><h4>Returns</h4>
<p> <a href="../glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, when the <em class="parameter"><code>source</code></em>
is a custom source, thus it
should not be removed as an obsolete source; <a href="../glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> to not
force to keep it. It still can be left, when it's one of
the WebDAV-discovered sources.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-webdav-collection-backend-discover-sync"></a><h3>e_webdav_collection_backend_discover_sync ()</h3>
<pre class="programlisting"><a class="link" href="evolution-data-server-e-source-enums.html#ESourceAuthenticationResult" title="enum ESourceAuthenticationResult"><span class="returnvalue">ESourceAuthenticationResult</span></a>
e_webdav_collection_backend_discover_sync
                               (<em class="parameter"><code><a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a> *webdav_backend</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *calendar_url</code></em>,
                                <em class="parameter"><code>const <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *contacts_url</code></em>,
                                <em class="parameter"><code>const <a class="link" href="evolution-data-server-e-data-server-util.html#ENamedParameters" title="ENamedParameters"><span class="type">ENamedParameters</span></a> *credentials</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **out_certificate_pem</code></em>,
                                <em class="parameter"><code><a href="../gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a> *out_certificate_errors</code></em>,
                                <em class="parameter"><code><a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                <em class="parameter"><code><a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>This function is usually called in EBackend::<code class="function">authenticate_sync()</code> implementation
of the descendant, causing discovery of CalDAV and CardDAV sources on given URLs.
If either of <em class="parameter"><code>calendar_url</code></em>
 and <em class="parameter"><code>contacts_url</code></em>
 is <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, that that part is skipped.
The <em class="parameter"><code>calendar_url</code></em>
 covers all calendars, memo lists and task lists.</p>
<p>The function also takes care of <a class="link" href="evolution-data-server-ECollectionBackend.html#e-collection-backend-authenticate-children" title="e_collection_backend_authenticate_children ()"><code class="function">e_collection_backend_authenticate_children()</code></a> on success.</p>
<div class="refsect3">
<a name="e-webdav-collection-backend-discover-sync.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody>
<tr>
<td class="parameter_name"><p>webdav_backend</p></td>
<td class="parameter_description"><p>an <a class="link" href="evolution-data-server-EWebDAVCollectionBackend.html#EWebDAVCollectionBackend" title="struct EWebDAVCollectionBackend"><span class="type">EWebDAVCollectionBackend</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>calendar_url</p></td>
<td class="parameter_description"><p>a URL to search calendars at, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>contacts_url</p></td>
<td class="parameter_description"><p>a URL to search contacts at, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>credentials</p></td>
<td class="parameter_description"><p>credentials to use when running the discovery</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>out_certificate_pem</p></td>
<td class="parameter_description"><p>optional return location
for a server SSL certificate in PEM format, when the operation failed
with an SSL error. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_certificate_errors</p></td>
<td class="parameter_description"><p>optional <a href="../gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a>,
with certificate error flags when the operation failed with SSL error. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p>optional <a href="../gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>return location for a <a href="../glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="../glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-webdav-collection-backend-discover-sync.returns"></a><h4>Returns</h4>
<p> an <a class="link" href="evolution-data-server-e-source-enums.html#ESourceAuthenticationResult" title="enum ESourceAuthenticationResult"><span class="type">ESourceAuthenticationResult</span></a> describing whether discovery on given
addresses succeeded.</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
</div>
<div class="refsect1">
<a name="evolution-data-server-EWebDAVCollectionBackend.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EWebDAVCollectionBackend"></a><h3>struct EWebDAVCollectionBackend</h3>
<pre class="programlisting">struct EWebDAVCollectionBackend {
};
</pre>
<p>Contains only private data that should be read and manipulated using the
functions below.</p>
<p class="since">Since: <a class="link" href="api-index-3-26.html#api-index-3.26">3.26</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.27</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.