evolution-data-server-doc 3.22.7-1 / usr / share / gtk-doc / html / eds / eds-e-webdav-discover.html

This file is indexed.

/usr/share/gtk-doc/html/eds/eds-e-webdav-discover.html is in evolution-data-server-doc 3.22.7-1.

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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>e-webdav-discover: 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="ch10.html" title="Available for clients and backends">
<link rel="prev" href="eds-e-uid.html" title="e-uid">
<link rel="next" href="eds-e-xml-hash-utils.html" title="e-xml-hash-utils">
<meta name="generator" content="GTK-Doc V1.25 (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="#eds-e-webdav-discover.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="ch10.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-e-uid.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-e-xml-hash-utils.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-e-webdav-discover"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-e-webdav-discover.top_of_page"></a>e-webdav-discover</span></h2>
<p>e-webdav-discover</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-e-webdav-discover.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">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-free-discovered-sources" title="e_webdav_discover_free_discovered_sources ()">e_webdav_discover_free_discovered_sources</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">void</span>
</td>
<td class="function_name">
<a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources" title="e_webdav_discover_sources ()">e_webdav_discover_sources</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources-finish" title="e_webdav_discover_sources_finish ()">e_webdav_discover_sources_finish</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources-sync" title="e_webdav_discover_sources_sync ()">e_webdav_discover_sources_sync</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-e-webdav-discover.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">enum</td>
<td class="function_name"><a class="link" href="eds-e-webdav-discover.html#EWebDAVDiscoverSupports" title="enum EWebDAVDiscoverSupports">EWebDAVDiscoverSupports</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="eds-e-webdav-discover.html#EWebDAVDiscoveredSource" title="EWebDAVDiscoveredSource">EWebDAVDiscoveredSource</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-e-webdav-discover.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="eds-e-webdav-discover.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-webdav-discover-free-discovered-sources"></a><h3>e_webdav_discover_free_discovered_sources ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_webdav_discover_free_discovered_sources
                               (<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> *discovered_sources</code></em>);</pre>
<p>Frees a <em class="parameter"><code>GSList</code></em>
 of discovered sources returned from
<a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources-finish" title="e_webdav_discover_sources_finish ()"><code class="function">e_webdav_discover_sources_finish()</code></a> or <a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources-sync" title="e_webdav_discover_sources_sync ()"><code class="function">e_webdav_discover_sources_sync()</code></a>.</p>
<div class="refsect3">
<a name="e-webdav-discover-free-discovered-sources.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>discovered_sources</p></td>
<td class="parameter_description"><p> A <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of discovered sources. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> EWebDAVDiscoveredSource]</span></td>
</tr></tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.18.html" title="Index of new symbols in 3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-webdav-discover-sources"></a><h3>e_webdav_discover_sources ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_webdav_discover_sources (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
                           <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url_use_path</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> only_supports</code></em>,
                           <em class="parameter"><code>const <a class="link" href="eds-e-data-server-util.html#ENamedParameters"><span class="type">ENamedParameters</span></a> *credentials</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
                           <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre>
<p>Asynchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually
limited by the <em class="parameter"><code>only_supports</code></em>
 filter, which can be <a class="link" href="eds-e-webdav-discover.html#E-WEBDAV-DISCOVER-SUPPORTS-NONE:CAPS"><code class="literal">E_WEBDAV_DISCOVER_SUPPORTS_NONE</code></a>
to search all types. Note that the list of returned calendars can be more general,
thus check for its actual support type for further filtering of the results.
The <em class="parameter"><code>url_use_path</code></em>
 can be used to override actual server path, or even complete URL,
for the given <em class="parameter"><code>source</code></em>
.</p>
<p>When the operation is finished, <em class="parameter"><code>callback</code></em>
 will be called. You can then
call <a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources-finish" title="e_webdav_discover_sources_finish ()"><code class="function">e_webdav_discover_sources_finish()</code></a> to get the result of the operation.</p>
<div class="refsect3">
<a name="e-webdav-discover-sources.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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> from which to take connection details</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>url_use_path</p></td>
<td class="parameter_description"><p> optional URL override, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>only_supports</p></td>
<td class="parameter_description"><p>bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>credentials</p></td>
<td class="parameter_description"><p> credentials to use for authentication to the server. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>callback</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the request
is satisfied. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> data to pass to the callback function. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="api-index-3.18.html" title="Index of new symbols in 3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-webdav-discover-sources-finish"></a><h3>e_webdav_discover_sources_finish ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_webdav_discover_sources_finish (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **out_certificate_pem</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a> *out_certificate_errors</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **out_discovered_sources</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **out_calendar_user_addresses</code></em>,
                                  <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Finishes the operation started with <a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-sources" title="e_webdav_discover_sources ()"><code class="function">e_webdav_discover_sources()</code></a>. If an
error occurred, the function will set <em class="parameter"><code>error</code></em>
 and return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. The function
can return success and no discovered sources, the same as it can return failure,
but still set some output arguments, like the certificate related output
arguments with SOUP_STATUS_SSL_FAILED error.</p>
<p>The return value of <em class="parameter"><code>out_certificate_pem</code></em>
 should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
when no longer needed.</p>
<p>The return value of <em class="parameter"><code>out_discovered_sources</code></em>
 should be freed
with <a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-free-discovered-sources" title="e_webdav_discover_free_discovered_sources ()"><code class="function">e_webdav_discover_free_discovered_sources()</code></a> when no longer needed.</p>
<p>The return value of <em class="parameter"><code>out_calendar_user_addresses</code></em>
 should be freed
with g_slist_free_full (calendar_user_addresses, g_free); when
no longer needed.</p>
<div class="refsect3">
<a name="e-webdav-discover-sources-finish.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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> on which the operation was started</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>result</p></td>
<td class="parameter_description"><p>a <a href="/usr/share/gtk-doc/html/gio/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a></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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_certificate_errors</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_discovered_sources</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a>
of all discovered sources. </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="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> EWebDAVDiscoveredSource]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_calendar_user_addresses</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
all discovered mail addresses for calendar sources. </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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-webdav-discover-sources-finish.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.18.html" title="Index of new symbols in 3.18">3.18</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-webdav-discover-sources-sync"></a><h3>e_webdav_discover_sources_sync ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
e_webdav_discover_sources_sync (<em class="parameter"><code><a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> *source</code></em>,
                                <em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *url_use_path</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint32"><span class="type">guint32</span></a> only_supports</code></em>,
                                <em class="parameter"><code>const <a class="link" href="eds-e-data-server-util.html#ENamedParameters"><span class="type">ENamedParameters</span></a> *credentials</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **out_certificate_pem</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/gio-TLS-Overview.html#GTlsCertificateFlags"><span class="type">GTlsCertificateFlags</span></a> *out_certificate_errors</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **out_discovered_sources</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> **out_calendar_user_addresses</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>,
                                <em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>Synchronously runs discovery of the WebDAV sources (CalDAV and CardDAV), eventually
limited by the <em class="parameter"><code>only_supports</code></em>
 filter, which can be <a class="link" href="eds-e-webdav-discover.html#E-WEBDAV-DISCOVER-SUPPORTS-NONE:CAPS"><code class="literal">E_WEBDAV_DISCOVER_SUPPORTS_NONE</code></a>
to search all types. Note that the list of returned calendars can be more general,
thus check for its actual support type for further filtering of the results.
The <em class="parameter"><code>url_use_path</code></em>
 can be used to override actual server path, or even complete URL,
for the given <em class="parameter"><code>source</code></em>
.</p>
<p>If an error occurred, the function will set <em class="parameter"><code>error</code></em>
 and return <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a>. The function
can return success and no discovered sources, the same as it can return failure,
but still set some output arguments, like the certificate related output
arguments with SOUP_STATUS_SSL_FAILED error.</p>
<p>The return value of <em class="parameter"><code>out_certificate_pem</code></em>
 should be freed with <a href="/usr/share/gtk-doc/html/glib/glib-Memory-Allocation.html#g-free"><code class="function">g_free()</code></a>
when no longer needed.</p>
<p>The return value of <em class="parameter"><code>out_discovered_sources</code></em>
 should be freed
with <a class="link" href="eds-e-webdav-discover.html#e-webdav-discover-free-discovered-sources" title="e_webdav_discover_free_discovered_sources ()"><code class="function">e_webdav_discover_free_discovered_sources()</code></a> when no longer needed.</p>
<p>The return value of <em class="parameter"><code>out_calendar_user_addresses</code></em>
 should be freed
with g_slist_free_full (calendar_user_addresses, g_free); when
no longer needed.</p>
<div class="refsect3">
<a name="e-webdav-discover-sources-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>source</p></td>
<td class="parameter_description"><p>an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> from which to take connection details</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>url_use_path</p></td>
<td class="parameter_description"><p> optional URL override, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>only_supports</p></td>
<td class="parameter_description"><p>bit-or of EWebDAVDiscoverSupports, to limit what type of sources to search</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>credentials</p></td>
<td class="parameter_description"><p> credentials to use for authentication to the server. </p></td>
<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_certificate_errors</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_discovered_sources</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a>
of all discovered sources. </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="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> EWebDAVDiscoveredSource]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>out_calendar_user_addresses</p></td>
<td class="parameter_description"><p> a <a href="/usr/share/gtk-doc/html/glib/glib-Singly-Linked-Lists.html#GSList"><span class="type">GSList</span></a> of
all discovered mail addresses for calendar sources. </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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Generics and defining elements of containers and arrays."><span class="acronym">element-type</span></acronym> utf8]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="/usr/share/gtk-doc/html/gio/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p> return location for a <a href="/usr/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/usr/share/gtk-doc/html/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 is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="e-webdav-discover-sources-sync.returns"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> on failure</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.18.html" title="Index of new symbols in 3.18">3.18</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-e-webdav-discover.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="EWebDAVDiscoverSupports"></a><h3>enum EWebDAVDiscoverSupports</h3>
<div class="refsect3">
<a name="EWebDAVDiscoverSupports.members"></a><h4>Members</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="300px" class="enum_members_name">
<col class="enum_members_description">
<col width="200px" class="enum_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="enum_member_name"><p><a name="E-WEBDAV-DISCOVER-SUPPORTS-NONE:CAPS"></a>E_WEBDAV_DISCOVER_SUPPORTS_NONE</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-WEBDAV-DISCOVER-SUPPORTS-CONTACTS:CAPS"></a>E_WEBDAV_DISCOVER_SUPPORTS_CONTACTS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-WEBDAV-DISCOVER-SUPPORTS-EVENTS:CAPS"></a>E_WEBDAV_DISCOVER_SUPPORTS_EVENTS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-WEBDAV-DISCOVER-SUPPORTS-MEMOS:CAPS"></a>E_WEBDAV_DISCOVER_SUPPORTS_MEMOS</p></td>
<td> </td>
<td> </td>
</tr>
<tr>
<td class="enum_member_name"><p><a name="E-WEBDAV-DISCOVER-SUPPORTS-TASKS:CAPS"></a>E_WEBDAV_DISCOVER_SUPPORTS_TASKS</p></td>
<td> </td>
<td> </td>
</tr>
</tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="EWebDAVDiscoveredSource"></a><h3>EWebDAVDiscoveredSource</h3>
<pre class="programlisting">typedef struct {
	gchar *href;
	guint32 supports;
	gchar *display_name;
	gchar *description;
	gchar *color;
} EWebDAVDiscoveredSource;
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.25</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.