← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/reference/libedataserver/html/ESourceResource.html

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

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/libedataserver/html/ESourceResource.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>ESourceResource</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
 
7
<link rel="home" href="index.html" title="Evolution-Data-Server Manual: Utilities (libedataserver)">
 
8
<link rel="up" href="ch02.html" title="Data Source Extensions">
 
9
<link rel="prev" href="ESourceRefresh.html" title="ESourceRefresh">
 
10
<link rel="next" href="ESourceSecurity.html" title="ESourceSecurity">
 
11
<meta name="generator" content="GTK-Doc V1.18 (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="ESourceRefresh.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch02.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 Manual: Utilities (libedataserver)</th>
 
21
<td><a accesskey="n" href="ESourceSecurity.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="#ESourceResource.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#ESourceResource.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#ESourceResource.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
                   | 
 
30
                  <a href="#ESourceResource.properties" class="shortcut">Properties</a>
 
31
</td></tr>
 
32
</table>
 
33
<div class="refentry">
 
34
<a name="ESourceResource"></a><div class="titlepage"></div>
 
35
<div class="refnamediv"><table width="100%"><tr>
 
36
<td valign="top">
 
37
<h2><span class="refentrytitle"><a name="ESourceResource.top_of_page"></a>ESourceResource</span></h2>
 
38
<p>ESourceResource — <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> extension for a remote resource</p>
 
39
</td>
 
40
<td valign="top" align="right"></td>
 
41
</tr></table></div>
 
42
<div class="refsynopsisdiv">
 
43
<a name="ESourceResource.synopsis"></a><h2>Synopsis</h2>
 
44
<pre class="synopsis">
 
45
#include &lt;libedataserver/libedataserver.h&gt;
 
46
 
 
47
struct              <a class="link" href="ESourceResource.html#ESourceResource-struct" title="struct ESourceResource">ESourceResource</a>;
 
48
#define             <a class="link" href="ESourceResource.html#E-SOURCE-EXTENSION-RESOURCE:CAPS" title="E_SOURCE_EXTENSION_RESOURCE">E_SOURCE_EXTENSION_RESOURCE</a>
 
49
const <span class="returnvalue">gchar</span> *       <a class="link" href="ESourceResource.html#e-source-resource-get-identity" title="e_source_resource_get_identity ()">e_source_resource_get_identity</a>      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);
 
50
<span class="returnvalue">gchar</span> *             <a class="link" href="ESourceResource.html#e-source-resource-dup-identity" title="e_source_resource_dup_identity ()">e_source_resource_dup_identity</a>      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);
 
51
<span class="returnvalue">void</span>                <a class="link" href="ESourceResource.html#e-source-resource-set-identity" title="e_source_resource_set_identity ()">e_source_resource_set_identity</a>      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>,
 
52
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *identity</code></em>);
 
53
</pre>
 
54
</div>
 
55
<div class="refsect1">
 
56
<a name="ESourceResource.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
57
<pre class="synopsis">
 
58
  GObject
 
59
   +----<a class="link" href="ESourceExtension.html" title="ESourceExtension">ESourceExtension</a>
 
60
         +----ESourceResource
 
61
</pre>
 
62
</div>
 
63
<div class="refsect1">
 
64
<a name="ESourceResource.properties"></a><h2>Properties</h2>
 
65
<pre class="synopsis">
 
66
  "<a class="link" href="ESourceResource.html#ESourceResource--identity" title='The "identity" property'>identity</a>"                 <span class="type">gchar</span>*                : Read / Write / Construct
 
67
</pre>
 
68
</div>
 
69
<div class="refsect1">
 
70
<a name="ESourceResource.description"></a><h2>Description</h2>
 
71
<p>
 
72
The <a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> extension holds the server-assigned identity of a
 
73
remote calendar, address book, or whatever else an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> can represent.
 
74
</p>
 
75
<p>
 
76
This extension is typically used by an <span class="type">ECollectionBackend</span> to note a
 
77
server-assigned resource identity in an <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a>.  Then in a later session,
 
78
after querying the server for available resources, a resource identity can
 
79
be paired with the same <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> <a class="link" href="ESource.html#ESource--uid" title='The "uid" property'><span class="type">"uid"</span></a> from the previous session,
 
80
allowing locally cached data from the previous session to be reused.
 
81
</p>
 
82
<p>
 
83
Access the extension as follows:
 
84
</p>
 
85
<p>
 
86
</p>
 
87
<div class="informalexample">
 
88
  <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
 
89
    <tbody>
 
90
      <tr>
 
91
        <td class="listing_lines" align="right"><pre>1
 
92
2
 
93
3
 
94
4
 
95
5</pre></td>
 
96
        <td class="listing_code"><pre class="programlisting"><span class="preproc">#include</span><span class="normal"> </span><span class="string">&lt;libedataserver/e-source-resource.h&gt;</span>
 
97
 
 
98
<span class="usertype">ESourceResource</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">extension</span><span class="symbol">;</span>
 
99
 
 
100
<span class="normal">extension </span><span class="symbol">=</span><span class="normal"> </span><span class="function"><a href="ESource.html#e-source-get-extension">e_source_get_extension</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">source</span><span class="symbol">,</span><span class="normal"> <a href="ESourceResource.html#E-SOURCE-EXTENSION-RESOURCE:CAPS">E_SOURCE_EXTENSION_RESOURCE</a></span><span class="symbol">);</span></pre></td>
 
101
      </tr>
 
102
    </tbody>
 
103
  </table>
 
104
</div>
 
105
 
 
106
<p>
 
107
</p>
 
108
</div>
 
109
<div class="refsect1">
 
110
<a name="ESourceResource.details"></a><h2>Details</h2>
 
111
<div class="refsect2">
 
112
<a name="ESourceResource-struct"></a><h3>struct ESourceResource</h3>
 
113
<pre class="programlisting">struct ESourceResource;</pre>
 
114
<p>
 
115
Contains only private data that should be read and manipulated using the
 
116
functions below.
 
117
</p>
 
118
<p class="since">Since 3.6</p>
 
119
</div>
 
120
<hr>
 
121
<div class="refsect2">
 
122
<a name="E-SOURCE-EXTENSION-RESOURCE:CAPS"></a><h3>E_SOURCE_EXTENSION_RESOURCE</h3>
 
123
<pre class="programlisting">#define E_SOURCE_EXTENSION_RESOURCE "Resource"
 
124
</pre>
 
125
<p>
 
126
Pass this extension name to <a class="link" href="ESource.html#e-source-get-extension" title="e_source_get_extension ()"><code class="function">e_source_get_extension()</code></a> to access
 
127
<a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a>.  This is also used as a group name in key files.
 
128
</p>
 
129
<p class="since">Since 3.6</p>
 
130
</div>
 
131
<hr>
 
132
<div class="refsect2">
 
133
<a name="e-source-resource-get-identity"></a><h3>e_source_resource_get_identity ()</h3>
 
134
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       e_source_resource_get_identity      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);</pre>
 
135
<p>
 
136
Returns the server-assigned identity of the remote resource associated
 
137
with the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em> belongs.
 
138
</p>
 
139
<div class="variablelist"><table border="0">
 
140
<col align="left" valign="top">
 
141
<tbody>
 
142
<tr>
 
143
<td><p><span class="term"><em class="parameter"><code>extension</code></em> :</span></p></td>
 
144
<td>an <a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a>
 
145
</td>
 
146
</tr>
 
147
<tr>
 
148
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
149
<td>the identity of a remote resource</td>
 
150
</tr>
 
151
</tbody>
 
152
</table></div>
 
153
<p class="since">Since 3.6</p>
 
154
</div>
 
155
<hr>
 
156
<div class="refsect2">
 
157
<a name="e-source-resource-dup-identity"></a><h3>e_source_resource_dup_identity ()</h3>
 
158
<pre class="programlisting"><span class="returnvalue">gchar</span> *             e_source_resource_dup_identity      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>);</pre>
 
159
<p>
 
160
Thread-safe variation of <a class="link" href="ESourceResource.html#e-source-resource-get-identity" title="e_source_resource_get_identity ()"><code class="function">e_source_resource_get_identity()</code></a>.
 
161
Use this function when accessing <em class="parameter"><code>extension</code></em> from multiple threads.
 
162
</p>
 
163
<p>
 
164
The returned string should be freed with <code class="function">g_free()</code> when no longer needed.
 
165
</p>
 
166
<div class="variablelist"><table border="0">
 
167
<col align="left" valign="top">
 
168
<tbody>
 
169
<tr>
 
170
<td><p><span class="term"><em class="parameter"><code>extension</code></em> :</span></p></td>
 
171
<td>an <a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a>
 
172
</td>
 
173
</tr>
 
174
<tr>
 
175
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
 
176
<td>a newly-allocated copy of <a class="link" href="ESourceResource.html#ESourceResource--identity" title='The "identity" property'><span class="type">"identity"</span></a>
 
177
</td>
 
178
</tr>
 
179
</tbody>
 
180
</table></div>
 
181
<p class="since">Since 3.6</p>
 
182
</div>
 
183
<hr>
 
184
<div class="refsect2">
 
185
<a name="e-source-resource-set-identity"></a><h3>e_source_resource_set_identity ()</h3>
 
186
<pre class="programlisting"><span class="returnvalue">void</span>                e_source_resource_set_identity      (<em class="parameter"><code><a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a> *extension</code></em>,
 
187
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *identity</code></em>);</pre>
 
188
<p>
 
189
Sets the server-assigned identity of the remote resource associated with
 
190
the <a class="link" href="ESource.html" title="ESource"><span class="type">ESource</span></a> to which <em class="parameter"><code>extension</code></em> belongs.
 
191
</p>
 
192
<p>
 
193
The internal copy of <em class="parameter"><code>identity</code></em> is automatically stripped of leading and
 
194
trailing whitespace.  If the resulting string is empty, <code class="literal">NULL</code> is set
 
195
instead.
 
196
</p>
 
197
<div class="variablelist"><table border="0">
 
198
<col align="left" valign="top">
 
199
<tbody>
 
200
<tr>
 
201
<td><p><span class="term"><em class="parameter"><code>extension</code></em> :</span></p></td>
 
202
<td>an <a class="link" href="ESourceResource.html" title="ESourceResource"><span class="type">ESourceResource</span></a>
 
203
</td>
 
204
</tr>
 
205
<tr>
 
206
<td><p><span class="term"><em class="parameter"><code>identity</code></em> :</span></p></td>
 
207
<td>the identity of a remote resource. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
 
208
</td>
 
209
</tr>
 
210
</tbody>
 
211
</table></div>
 
212
<p class="since">Since 3.6</p>
 
213
</div>
 
214
</div>
 
215
<div class="refsect1">
 
216
<a name="ESourceResource.property-details"></a><h2>Property Details</h2>
 
217
<div class="refsect2">
 
218
<a name="ESourceResource--identity"></a><h3>The <code class="literal">"identity"</code> property</h3>
 
219
<pre class="programlisting">  "identity"                 <span class="type">gchar</span>*                : Read / Write / Construct</pre>
 
220
<p>Resource identity.</p>
 
221
<p>Default value: NULL</p>
 
222
</div>
 
223
</div>
 
224
</div>
 
225
<div class="footer">
 
226
<hr>
 
227
          Generated by GTK-Doc V1.18</div>
 
228
</body>
 
229
</html>
 
 
b'\\ No newline at end of file'