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
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataAccessRule</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="GDataAccessHandler.html" title="GDataAccessHandler">
<link rel="next" href="pt03.html" title="Part III. Namespace API">
<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="GDataAccessHandler.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="pt03.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GDataAccessRule.synopsis" class="shortcut">Top</a>
|
<a href="#GDataAccessRule.description" class="shortcut">Description</a>
|
<a href="#GDataAccessRule.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GDataAccessRule.properties" class="shortcut">Properties</a>
</td></tr>
</table>
<div class="refentry" title="GDataAccessRule">
<a name="GDataAccessRule"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataAccessRule.top_of_page"></a>GDataAccessRule</span></h2>
<p>GDataAccessRule — GData access rule object</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1" title="Stability Level">
<a name="GDataAccessRule.stability-level"></a><h2>Stability Level</h2>
Unstable, unless otherwise indicated
</div>
<div class="refsynopsisdiv" title="Synopsis">
<a name="GDataAccessRule.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <gdata/gdata-access-rule.h>
<a class="link" href="GDataAccessRule.html#GDataAccessRule-struct" title="GDataAccessRule">GDataAccessRule</a>;
<a class="link" href="GDataAccessRule.html#GDataAccessRuleClass" title="GDataAccessRuleClass">GDataAccessRuleClass</a>;
<a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * <a class="link" href="GDataAccessRule.html#gdata-access-rule-new" title="gdata_access_rule_new ()">gdata_access_rule_new</a> (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);
const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * <a class="link" href="GDataAccessRule.html#gdata-access-rule-get-role" title="gdata_access_rule_get_role ()">gdata_access_rule_get_role</a> (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GDataAccessRule.html#gdata-access-rule-set-role" title="gdata_access_rule_set_role ()">gdata_access_rule_set_role</a> (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GDataAccessRule.html#gdata-access-rule-get-scope" title="gdata_access_rule_get_scope ()">gdata_access_rule_get_scope</a> (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **type</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GDataAccessRule.html#gdata-access-rule-set-scope" title="gdata_access_rule_set_scope ()">gdata_access_rule_set_scope</a> (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);
</pre>
</div>
<div class="refsect1" title="Object Hierarchy">
<a name="GDataAccessRule.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="/opt/gnome2/build/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GDataParsable.html" title="GDataParsable">GDataParsable</a>
+----<a class="link" href="GDataEntry.html" title="GDataEntry">GDataEntry</a>
+----GDataAccessRule
</pre>
</div>
<div class="refsect1" title="Properties">
<a name="GDataAccessRule.properties"></a><h2>Properties</h2>
<pre class="synopsis">
"<a class="link" href="GDataAccessRule.html#GDataAccessRule--role" title='The "role" property'>role</a>" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-type" title='The "scope-type" property'>scope-type</a>" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
"<a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-value" title='The "scope-value" property'>scope-value</a>" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write
</pre>
</div>
<div class="refsect1" title="Description">
<a name="GDataAccessRule.description"></a><h2>Description</h2>
<p>
<a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> is a subclass of <a class="link" href="GDataEntry.html" title="GDataEntry"><span class="type">GDataEntry</span></a> to represent a generic access rule from an access control list (ACL).
It is returned by the ACL methods implemented in the <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a> interface.
</p>
</div>
<div class="refsect1" title="Details">
<a name="GDataAccessRule.details"></a><h2>Details</h2>
<div class="refsect2" title="GDataAccessRule">
<a name="GDataAccessRule-struct"></a><h3>GDataAccessRule</h3>
<pre class="programlisting">typedef struct _GDataAccessRule GDataAccessRule;</pre>
<p>
All the fields in the <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</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="GDataAccessRuleClass">
<a name="GDataAccessRuleClass"></a><h3>GDataAccessRuleClass</h3>
<pre class="programlisting">typedef struct {
} GDataAccessRuleClass;
</pre>
<p>
All the fields in the <a class="link" href="GDataAccessRule.html#GDataAccessRuleClass" title="GDataAccessRuleClass"><span class="type">GDataAccessRuleClass</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="gdata_access_rule_new ()">
<a name="gdata-access-rule-new"></a><h3>gdata_access_rule_new ()</h3>
<pre class="programlisting"><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="returnvalue">GDataAccessRule</span></a> * gdata_access_rule_new (<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *id</code></em>);</pre>
<p>
Creates a new <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> with the given ID and default properties.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>id</code></em> :</span></p></td>
<td>the access rule's ID, 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 new <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></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_rule_get_role ()">
<a name="gdata-access-rule-get-role"></a><h3>gdata_access_rule_get_role ()</h3>
<pre class="programlisting">const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> * gdata_access_rule_get_role (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataAccessRule.html#GDataAccessRule--role" title='The "role" property'><span class="type">"role"</span></a> property.
</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="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td> the access rule's role, 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_rule_set_role ()">
<a name="gdata-access-rule-set-role"></a><h3>gdata_access_rule_set_role ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdata_access_rule_set_role (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *role</code></em>);</pre>
<p>
Sets the <a class="link" href="GDataAccessRule.html#GDataAccessRule--role" title='The "role" property'><span class="type">"role"</span></a> property to <em class="parameter"><code>role</code></em>.
</p>
<p>
Set <em class="parameter"><code>role</code></em> to <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the property in the access rule.
</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="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>role</code></em> :</span></p></td>
<td>a new role, 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_rule_get_scope ()">
<a name="gdata-access-rule-get-scope"></a><h3>gdata_access_rule_get_scope ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdata_access_rule_get_scope (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **type</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **value</code></em>);</pre>
<p>
Gets the <a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-type" title='The "scope-type" property'><span class="type">"scope-type"</span></a> and <a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-value" title='The "scope-value" property'><span class="type">"scope-value"</span></a> properties.
</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="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>return location for the scope type, 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>value</code></em> :</span></p></td>
<td>return location for the scope value, 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_rule_set_scope ()">
<a name="gdata-access-rule-set-scope"></a><h3>gdata_access_rule_set_scope ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gdata_access_rule_set_scope (<em class="parameter"><code><a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a> *self</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *type</code></em>,
<em class="parameter"><code>const <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *value</code></em>);</pre>
<p>
Sets the <a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-type" title='The "scope-type" property'><span class="type">"scope-type"</span></a> property to <em class="parameter"><code>type</code></em> and the <a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-value" title='The "scope-value" property'><span class="type">"scope-value"</span></a> property to <em class="parameter"><code>value</code></em>.
</p>
<p>
Set <em class="parameter"><code>scope_value</code></em> to <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> to unset the <a class="link" href="GDataAccessRule.html#GDataAccessRule--scope-value" title='The "scope-value" property'><span class="type">"scope-value"</span></a> property in the access rule. <em class="parameter"><code>type</code></em> cannot
be <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <em class="parameter"><code>scope_value</code></em> must be <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if <em class="parameter"><code>type</code></em> is <code class="literal">default</code>, and non-<a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> otherwise.
</p>
<p>
See the <a class="ulink" href="http://code.google.com/apis/calendar/docs/2.0/reference.html#gacl_reference" target="_top">online documentation</a>
for more information.
</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="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>a new scope type
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>value</code></em> :</span></p></td>
<td>a new scope value, 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>
</div>
<div class="refsect1" title="Property Details">
<a name="GDataAccessRule.property-details"></a><h2>Property Details</h2>
<div class="refsect2" title='The "role" property'>
<a name="GDataAccessRule--role"></a><h3>The <code class="literal">"role"</code> property</h3>
<pre class="programlisting"> "role" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
The role of the person concerned by this ACL.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title='The "scope-type" property'>
<a name="GDataAccessRule--scope-type"></a><h3>The <code class="literal">"scope-type"</code> property</h3>
<pre class="programlisting"> "scope-type" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
Specifies to whom this access rule applies.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.3.0</p>
</div>
<hr>
<div class="refsect2" title='The "scope-value" property'>
<a name="GDataAccessRule--scope-value"></a><h3>The <code class="literal">"scope-value"</code> property</h3>
<pre class="programlisting"> "scope-value" <a href="/opt/gnome2/build/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Read / Write</pre>
<p>
A value representing the user who is represented by the access rule, such as an
e-mail address for users, or a domain name for domains.
</p>
<p>Default value: NULL</p>
<p class="since">Since 0.3.0</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.14</div>
</body>
</html>
|
