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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataAccessHandler</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch03.html" title="Access Control List API">
<link rel="prev" href="ch03.html" title="Access Control List API">
<link rel="next" href="GDataAccessRule.html" title="GDataAccessRule">
<meta name="generator" content="GTK-Doc V1.14 (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="2">
<tr valign="middle">
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch03.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GData Reference Manual</th>
<td><a accesskey="n" href="GDataAccessRule.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GDataAccessHandler.synopsis" class="shortcut">Top</a>
|
<a href="#GDataAccessHandler.description" class="shortcut">Description</a>
|
<a href="#GDataAccessHandler.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GDataAccessHandler.prerequisites" class="shortcut">Prerequisites</a>
|
<a href="#GDataAccessHandler.implementations" class="shortcut">Known Implementations</a>
</td></tr>
</table>
<div class="refentry" title="GDataAccessHandler">
<a name="GDataAccessHandler"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataAccessHandler.top_of_page"></a>GDataAccessHandler</span></h2>
<p>GDataAccessHandler — GData access handler interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="GDataAccessHandler.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GDataAccessHandler.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdata/gdata-access-handler.h>
<a class="link" href="GDataAccessHandler.html#GDataAccessHandler-struct" title="GDataAccessHandler">GDataAccessHandler</a>;
<a class="link" href="GDataAccessHandler.html#GDataAccessHandlerIface" title="GDataAccessHandlerIface">GDataAccessHandlerIface</a>;
<a class="link" href="GDataFeed.html" title="GDataFeed"><span class="returnvalue">GDataFeed</span></a> * <a class="link" href="GDataAccessHandler.html#gdata-access-handler-get-rules" title="gdata_access_handler_get_rules ()">gdata_access_handler_get_rules</a> (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * <a class="link" href="GDataAccessHandler.html#gdata-access-handler-insert-rule" title="gdata_access_handler_insert_rule ()">gdata_access_handler_insert_rule</a> (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * <a class="link" href="GDataAccessHandler.html#gdata-access-handler-update-rule" title="gdata_access_handler_update_rule ()">gdata_access_handler_update_rule</a> (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GDataAccessHandler.html#gdata-access-handler-delete-rule" title="gdata_access_handler_delete_rule ()">gdata_access_handler_delete_rule</a> (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GDataAccessHandler.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
GInterface
+----GDataAccessHandler
</pre>
</div>
<div class="refsect1" title="Prerequisites">
<a name="GDataAccessHandler.prerequisites"></a><h2>Prerequisites</h2>
<p>
GDataAccessHandler requires
<a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>.</p>
</div>
<div class="refsect1" title="Known Implementations">
<a name="GDataAccessHandler.implementations"></a><h2>Known Implementations</h2>
<p>
GDataAccessHandler is implemented by
<a class="link" href="GDataCalendarCalendar.html" title="GDataCalendarCalendar">GDataCalendarCalendar</a>, <a class="link" href="GDataDocumentsEntry.html" title="GDataDocumentsEntry">GDataDocumentsEntry</a>, <a class="link" href="GDataDocumentsFolder.html" title="GDataDocumentsFolder">GDataDocumentsFolder</a>, <a class="link" href="GDataDocumentsPresentation.html" title="GDataDocumentsPresentation">GDataDocumentsPresentation</a>, <a class="link" href="GDataDocumentsSpreadsheet.html" title="GDataDocumentsSpreadsheet">GDataDocumentsSpreadsheet</a> and <a class="link" href="GDataDocumentsText.html" title="GDataDocumentsText">GDataDocumentsText</a>.</p>
</div>
<div class="refsect1" title="Description">
<a name="GDataAccessHandler.description"></a><h2>Description</h2>
<p>
<a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> is an interface which can be implemented by <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a>s which can have their permissions controlled by an
access control list (ACL). It has a set of methods which allow the <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>s for the access handler/entry to be retrieved,
added, modified and deleted, with immediate effect.
</p>
<p>
When implementing the interface, classes must implement an <code class="function">is_owner_rule</code> function.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GDataAccessHandler.details"></a><h2>Details</h2>
<div class="refsect2" title="GDataAccessHandler">
<a name="GDataAccessHandler-struct"></a><h3>GDataAccessHandler</h3>
<pre class="programlisting">typedef struct _GDataAccessHandler GDataAccessHandler;</pre>
<p>
All the fields in the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> structure are private and should never be accessed directly.
</p>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title="GDataAccessHandlerIface">
<a name="GDataAccessHandlerIface"></a><h3>GDataAccessHandlerIface</h3>
<pre class="programlisting">typedef struct {
GTypeInterface parent;
gboolean (*is_owner_rule) (GDataAccessRule *rule);
} GDataAccessHandlerIface;
</pre>
<p>
The class structure for the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> interface.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GDataAccessHandlerIface.parent"></a>parent</code></em>;</span></p></td>
<td>the parent type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="structfield"><code><a name="GDataAccessHandlerIface.is-owner-rule"></a>is_owner_rule</code></em> ()</span></p></td>
<td>a function to return whether the given <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> has the role of an owner (of a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>).
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_access_handler_get_rules ()">
<a name="gdata-access-handler-get-rules"></a><h3>gdata_access_handler_get_rules ()</h3>
<pre class="programlisting"><a class="link" href="GDataFeed.html" title="GDataFeed"><span class="returnvalue">GDataFeed</span></a> * gdata_access_handler_get_rules (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> progress_callback</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Retrieves a <a class="link" href="GDataFeed.html" title="GDataFeed"><span class="type">GDataFeed</span></a> containing all the access rules which apply to the given <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>. Only the owner of a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> may
view its rule feed.
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em> object from another thread.
If the operation was cancelled, the error <a href="/opt/gnome2/build/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
</p>
<p>
A <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> will be returned if the server indicates there is a problem with the query.
</p>
<p>
For each rule in the response feed, <em class="parameter"><code>progress_callback</code></em> will be called in the main thread. If there was an error parsing the XML response,
a <a class="link" href="GDataService.html#GDataParserError" title="enum GDataParserError"><span class="type">GDataParserError</span></a> will be returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_callback</code></em> :</span></p></td>
<td>a <a class="link" href="GDataService.html#GDataQueryProgressCallback" title="GDataQueryProgressCallback ()"><span class="type">GDataQueryProgressCallback</span></a> to call when a rule is loaded, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>progress_user_data</code></em> :</span></p></td>
<td>data to pass to the <em class="parameter"><code>progress_callback</code></em> function
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> a <a class="link" href="GDataFeed.html" title="GDataFeed"><span class="type">GDataFeed</span></a> of access control rules, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_access_handler_insert_rule ()">
<a name="gdata-access-handler-insert-rule"></a><h3>gdata_access_handler_insert_rule ()</h3>
<pre class="programlisting"><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * gdata_access_handler_insert_rule (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Inserts <em class="parameter"><code>rule</code></em> in the access control list of the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>.
</p>
<p>
The service will return an updated version of the rule, which is the return value of this function on success.
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em> object from another thread.
If the operation was cancelled, the error <a href="/opt/gnome2/build/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
</p>
<p>
If the rule is marked as already having been inserted a <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-ENTRY-ALREADY-INSERTED:CAPS"><code class="literal">GDATA_SERVICE_ERROR_ENTRY_ALREADY_INSERTED</code></a> error will be returned immediately
(there will be no network requests).
</p>
<p>
If there is an error inserting the rule, a <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> error will be returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>the <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> to insert
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an updated <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_access_handler_update_rule ()">
<a name="gdata-access-handler-update-rule"></a><h3>gdata_access_handler_update_rule ()</h3>
<pre class="programlisting"><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * gdata_access_handler_update_rule (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Updates <em class="parameter"><code>rule</code></em> in the access control list of the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>.
</p>
<p>
The service will return an updated version of the rule, which is the return value of this function on success.
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em> object from another thread.
If the operation was cancelled, the error <a href="/opt/gnome2/build/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
</p>
<p>
If there is an error updating the rule, a <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> error will be returned.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>the <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> to update
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> an updated <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title="gdata_access_handler_delete_rule ()">
<a name="gdata-access-handler-delete-rule"></a><h3>gdata_access_handler_delete_rule ()</h3>
<pre class="programlisting"><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gdata_access_handler_delete_rule (<em class="parameter"><code><a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> *self</code></em>,
<em class="parameter"><code><a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a> *service</code></em>,
<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *rule</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> *cancellable</code></em>,
<em class="parameter"><code><a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Deletes <em class="parameter"><code>rule</code></em> from the access control list of the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>.
</p>
<p>
If <em class="parameter"><code>cancellable</code></em> is not <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then the operation can be cancelled by triggering the <em class="parameter"><code>cancellable</code></em> object from another thread.
If the operation was cancelled, the error <a href="/opt/gnome2/build/share/gtk-doc/html/gio/gio-GIOError.html#G-IO-ERROR-CANCELLED:CAPS"><code class="literal">G_IO_ERROR_CANCELLED</code></a> will be returned.
</p>
<p>
If there is an error deleting the rule, a <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-PROTOCOL-ERROR:CAPS"><code class="literal">GDATA_SERVICE_ERROR_PROTOCOL_ERROR</code></a> error will be returned, unless the <em class="parameter"><code>rule</code></em> was the owner's
rule; in which case, <a class="link" href="GDataService.html#GDATA-SERVICE-ERROR-FORBIDDEN:CAPS"><code class="literal">GDATA_SERVICE_ERROR_FORBIDDEN</code></a> will be returned without any network activity.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>service</code></em> :</span></p></td>
<td>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>rule</code></em> :</span></p></td>
<td>the <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> to delete
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cancellable</code></em> :</span></p></td>
<td>optional <a href="/opt/gnome2/build/share/gtk-doc/html/gio/GCancellable.html"><span class="type">GCancellable</span></a> object, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> on success, <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> otherwise
</td>
</tr>
</tbody>
</table></div>
<p class="since">Since 0.3.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
