/usr/share/gtk-doc/html/eds/eds-ESourceResource.html is in evolution-data-server-doc 3.18.5-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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>ESourceResource: 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="ch02.html" title="Data Source Extensions">
<link rel="prev" href="eds-ESourceRefresh.html" title="ESourceRefresh">
<link rel="next" href="eds-ESourceRevisionGuards.html" title="ESourceRevisionGuards">
<meta name="generator" content="GTK-Doc V1.24 (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-ESourceResource.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="ch02.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="eds-ESourceRefresh.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="eds-ESourceRevisionGuards.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="eds-ESourceResource"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="eds-ESourceResource.top_of_page"></a>ESourceResource</span></h2>
<p>ESourceResource — <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> extension for a remote resource</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="eds-ESourceResource.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">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceResource.html#e-source-resource-get-identity" title="e_source_resource_get_identity ()">e_source_resource_get_identity</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#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="eds-ESourceResource.html#e-source-resource-dup-identity" title="e_source_resource_dup_identity ()">e_source_resource_dup_identity</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-ESourceResource.html#e-source-resource-set-identity" title="e_source_resource_set_identity ()">e_source_resource_set_identity</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceResource.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="define_keyword">#define</td>
<td class="function_name"><a class="link" href="eds-ESourceResource.html#E-SOURCE-EXTENSION-RESOURCE:CAPS" title="E_SOURCE_EXTENSION_RESOURCE">E_SOURCE_EXTENSION_RESOURCE</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource">ESourceResource</a></td>
</tr>
<tr>
<td class="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="eds-ESourceResource.html#ESourceResourceClass" title="struct ESourceResourceClass">ESourceResourceClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="eds-ESourceResource.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <libedataserver/libedataserver.h>
</pre>
</div>
<div class="refsect1">
<a name="eds-ESourceResource.description"></a><h2>Description</h2>
<p>The <a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a> extension holds the server-assigned identity of a
remote calendar, address book, or whatever else an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> can represent.</p>
<p>This extension is typically used by an <a class="link" href="eds-ECollectionBackend.html#ECollectionBackend" title="struct ECollectionBackend"><span class="type">ECollectionBackend</span></a> to note a
server-assigned resource identity in an <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a>. Then in a later session,
after querying the server for available resources, a resource identity can
be paired with the same <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> <span class="type">“uid”</span> from the previous session,
allowing locally cached data from the previous session to be reused.</p>
<p>Access the extension as follows:</p>
<div class="informalexample"><pre class="programlisting">
#include <libedataserver/libedataserver.h>
ESourceResource *extension;
extension = e_source_get_extension (source, E_SOURCE_EXTENSION_RESOURCE);
</pre></div>
<p></p>
</div>
<div class="refsect1">
<a name="eds-ESourceResource.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="e-source-resource-get-identity"></a><h3>e_source_resource_get_identity ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_resource_get_identity (<em class="parameter"><code><a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);</pre>
<p>Returns the server-assigned identity of the remote resource associated
with the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<div class="refsect3">
<a name="id-1.2.3.25.7.2.5"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.25.7.2.6"></a><h4>Returns</h4>
<p> the identity of a remote resource</p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-resource-dup-identity"></a><h3>e_source_resource_dup_identity ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
e_source_resource_dup_identity (<em class="parameter"><code><a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);</pre>
<p>Thread-safe variation of <a class="link" href="eds-ESourceResource.html#e-source-resource-get-identity" title="e_source_resource_get_identity ()"><code class="function">e_source_resource_get_identity()</code></a>.
Use this function when accessing <em class="parameter"><code>extension</code></em>
from multiple threads.</p>
<p>The returned string 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>
<div class="refsect3">
<a name="id-1.2.3.25.7.3.6"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.3.25.7.3.7"></a><h4>Returns</h4>
<p> a newly-allocated copy of <span class="type">“identity”</span></p>
</div>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="e-source-resource-set-identity"></a><h3>e_source_resource_set_identity ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
e_source_resource_set_identity (<em class="parameter"><code><a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a> *extension</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> *identity</code></em>);</pre>
<p>Sets the server-assigned identity of the remote resource associated with
the <a class="link" href="eds-ESource.html#ESource" title="struct ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em>
belongs.</p>
<p>The internal copy of <em class="parameter"><code>identity</code></em>
is automatically stripped of leading and
trailing whitespace. If the resulting string is empty, <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> is set
instead.</p>
<div class="refsect3">
<a name="id-1.2.3.25.7.4.6"></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>extension</p></td>
<td class="parameter_description"><p>an <a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>identity</p></td>
<td class="parameter_description"><p> the identity of a remote resource. </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>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
</div>
<div class="refsect1">
<a name="eds-ESourceResource.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="E-SOURCE-EXTENSION-RESOURCE:CAPS"></a><h3>E_SOURCE_EXTENSION_RESOURCE</h3>
<pre class="programlisting">#define E_SOURCE_EXTENSION_RESOURCE "Resource"
</pre>
<p>Pass this extension name to <a class="link" href="eds-ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
<a class="link" href="eds-ESourceResource.html#ESourceResource" title="struct ESourceResource"><span class="type">ESourceResource</span></a>. This is also used as a group name in key files.</p>
<p class="since">Since: <a class="link" href="api-index-3.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceResource"></a><h3>struct ESourceResource</h3>
<pre class="programlisting">struct ESourceResource {
ESourceExtension parent;
ESourceResourcePrivate *priv;
};
</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.6.html" title="Index of new symbols in 3.6">3.6</a></p>
</div>
<hr>
<div class="refsect2">
<a name="ESourceResourceClass"></a><h3>struct ESourceResourceClass</h3>
<pre class="programlisting">struct ESourceResourceClass {
ESourceExtensionClass parent_class;
};
</pre>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|