/usr/share/gtk-doc/html/gdata/GDataAccessHandler.html is in libgdata-doc 0.17.4-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 | <!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: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<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.24.1 (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="#GDataAccessHandler.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GDataAccessHandler.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_prerequisites"> <span class="dim">|</span>
<a href="#GDataAccessHandler.prerequisites" class="shortcut">Prerequisites</a></span><span id="nav_implementations"> <span class="dim">|</span>
<a href="#GDataAccessHandler.implementations" class="shortcut">Known Implementations</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="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch03.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataAccessRule.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<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 class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataAccessHandler.stability-level"></a><h2>Stability Level</h2>
<acronym title="The intention of a Stable interface is to enable arbitrary third parties to
develop applications to these interfaces, release them, and have confidence that
they will run on all minor releases of the product (after the one in which the
interface was introduced, and within the same major release). Even at a major
release, incompatible changes are expected to be rare, and to have strong
justifications.
"><span class="acronym">Stable</span></acronym>, unless otherwise indicated
</div>
<div class="refsect1">
<a name="GDataAccessHandler.functions"></a><h2>Functions</h2>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">
<a class="link" href="GDataFeed.html" title="GDataFeed"><span class="returnvalue">GDataFeed</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataAccessHandler.html#gdata-access-handler-get-rules" title="gdata_access_handler_get_rules ()">gdata_access_handler_get_rules</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="GDataAccessHandler.html#gdata-access-handler-get-rules-async" title="gdata_access_handler_get_rules_async ()">gdata_access_handler_get_rules_async</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataAccessHandler.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table 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="GDataAccessHandler.html#GDATA-LINK-ACCESS-CONTROL-LIST:CAPS" title="GDATA_LINK_ACCESS_CONTROL_LIST">GDATA_LINK_ACCESS_CONTROL_LIST</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataAccessHandler.html#GDataAccessHandler-struct" title="GDataAccessHandler">GDataAccessHandler</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataAccessHandler.html#GDataAccessHandlerIface" title="GDataAccessHandlerIface">GDataAccessHandlerIface</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataAccessHandler.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/GTypeModule.html">GInterface</a>
<span class="lineart">╰──</span> GDataAccessHandler
</pre>
</div>
<div class="refsect1">
<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">
<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="GDataDocumentsDocument.html" title="GDataDocumentsDocument">GDataDocumentsDocument</a>, <a class="link" href="GDataDocumentsDrawing.html" title="GDataDocumentsDrawing">GDataDocumentsDrawing</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="GDataDocumentsPdf.html" title="GDataDocumentsPdf">GDataDocumentsPdf</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">
<a name="GDataAccessHandler.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gdata/gdata-access-handler.h>
</pre>
</div>
<div class="refsect1">
<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>For an example of inserting an access rule into an ACL, see the documentation for <a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>.</p>
<p>When implementing the interface, classes must implement an <code class="function">is_owner_rule</code> function. It's optional to implement a
<code class="function">get_authorization_domain</code> function, but if it's not implemented, any operations on the access handler's
<a class="link" href="GDataAccessRule.html" title="GDataAccessRule"><span class="type">GDataAccessRule</span></a>s will be performed unauthorized (i.e. as if by a non-logged-in user). This will not usually work.</p>
</div>
<div class="refsect1">
<a name="GDataAccessHandler.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<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="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/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="https://developer.gnome.org/glib/unstable/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="https://developer.gnome.org/gio/unstable/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="refsect3">
<a name="gdata-access-handler-get-rules.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="https://developer.gnome.org/glib/unstable/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>progress_callback</p></td>
<td class="parameter_description"><p> 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="https://developer.gnome.org/glib/unstable/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>][<acronym title="The callback is valid only during the call to the method."><span class="acronym">scope call</span></acronym>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> progress_user_data]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>progress_user_data</p></td>
<td class="parameter_description"><p> data to pass to the <em class="parameter"><code>progress_callback</code></em>
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>
<tr>
<td class="parameter_name"><p>error</p></td>
<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-access-handler-get-rules.returns"></a><h4>Returns</h4>
<p> a <a class="link" href="GDataFeed.html" title="GDataFeed"><span class="type">GDataFeed</span></a> of access control rules, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>; unref with <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-unref"><code class="function">g_object_unref()</code></a>. </p>
<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
</div>
<p class="since">Since: <a class="link" href="ix05.html#api-index-0.3.0">0.3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-access-handler-get-rules-async"></a><h3>gdata_access_handler_get_rules_async ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
gdata_access_handler_get_rules_async (<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="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><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="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> progress_user_data</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Datasets.html#GDestroyNotify"><span class="type">GDestroyNotify</span></a> destroy_progress_user_data</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>,
<em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</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. <em class="parameter"><code>self</code></em>
and <em class="parameter"><code>service</code></em>
are both reffed when this function is called, so can safely be unreffed after this function returns.</p>
<p>For more details, see <a class="link" href="GDataAccessHandler.html#gdata-access-handler-get-rules" title="gdata_access_handler_get_rules ()"><code class="function">gdata_access_handler_get_rules()</code></a>, which is the synchronous version of this function, and <a class="link" href="GDataService.html#gdata-service-query-async" title="gdata_service_query_async ()"><code class="function">gdata_service_query_async()</code></a>, which
is the base asynchronous query function.</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="GDataService.html#gdata-service-query-finish" title="gdata_service_query_finish ()"><code class="function">gdata_service_query_finish()</code></a>
to get the results of the operation.</p>
<div class="refsect3">
<a name="gdata-access-handler-get-rules-async.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table 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>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataAccessHandler.html" title="GDataAccessHandler"><span class="type">GDataAccessHandler</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>service</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>cancellable</p></td>
<td class="parameter_description"><p> optional <a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> object, or <a href="https://developer.gnome.org/glib/unstable/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>progress_callback</p></td>
<td class="parameter_description"><p> 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="https://developer.gnome.org/glib/unstable/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>][<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym> progress_user_data]</span></td>
</tr>
<tr>
<td class="parameter_name"><p>progress_user_data</p></td>
<td class="parameter_description"><p> data to pass to the <em class="parameter"><code>progress_callback</code></em>
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>
<tr>
<td class="parameter_name"><p>destroy_progress_user_data</p></td>
<td class="parameter_description"><p> the function to call when <em class="parameter"><code>progress_callback</code></em>
will not be called any more, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. This function will be
called with <em class="parameter"><code>progress_user_data</code></em>
as a parameter and can be used to free any memory allocated for it. </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="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> to call when the query is finished</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>user_data</p></td>
<td class="parameter_description"><p> data to pass to the <em class="parameter"><code>callback</code></em>
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="ix12.html#api-index-0.9.1">0.9.1</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataAccessHandler.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDATA-LINK-ACCESS-CONTROL-LIST:CAPS"></a><h3>GDATA_LINK_ACCESS_CONTROL_LIST</h3>
<pre class="programlisting">#define GDATA_LINK_ACCESS_CONTROL_LIST "http://schemas.google.com/acl/2007#accessControlList"
</pre>
<p>The relation type URI of the access control list location for this resource.</p>
<p>For more information, see the</p>
<a class="ulink" href="http://code.google.com/apis/calendar/data/2.0/developers_guide_protocol.html#SharingACalendar" target="_top">ACL specification</a>.
<p class="since">Since: <a class="link" href="ix09.html#api-index-0.7.0">0.7.0</a></p>
</div>
<hr>
<div class="refsect2">
<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: <a class="link" href="ix05.html#api-index-0.3.0">0.3.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataAccessHandlerIface"></a><h3>GDataAccessHandlerIface</h3>
<pre class="programlisting">typedef struct {
GTypeInterface parent;
gboolean (*is_owner_rule) (GDataAccessRule *rule);
GDataAuthorizationDomain *(*get_authorization_domain) (GDataAccessHandler *self);
GDataFeed *(*get_rules) (GDataAccessHandler *self,
GDataService *service,
GCancellable *cancellable,
GDataQueryProgressCallback progress_callback,
gpointer progress_user_data,
GError **error);
} 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="refsect3">
<a name="GDataAccessHandlerIface.members"></a><h4>Members</h4>
<div class="informaltable"><table width="100%" border="0">
<colgroup>
<col width="300px" class="struct_members_name">
<col class="struct_members_description">
<col width="200px" class="struct_members_annotations">
</colgroup>
<tbody>
<tr>
<td class="struct_member_name"><p><a href="https://developer.gnome.org/gobject/unstable/gobject-Type-Information.html#GTypeInterface"><span class="type">GTypeInterface</span></a> <em class="structfield"><code><a name="GDataAccessHandlerIface.parent"></a>parent</code></em>;</p></td>
<td class="struct_member_description"><p>the parent type</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GDataAccessHandlerIface.is-owner-rule"></a>is_owner_rule</code></em> ()</p></td>
<td class="struct_member_description"><p>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>).</p></td>
<td class="struct_member_annotations"> </td>
</tr>
<tr>
<td class="struct_member_name"><p><em class="structfield"><code><a name="GDataAccessHandlerIface.get-authorization-domain"></a>get_authorization_domain</code></em> ()</p></td>
<td class="struct_member_description"><p> a function to return the <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> to be used for all operations on the access rules
belonging to this access handler; not implementing this function is equivalent to returning <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> from it, which signifies that operations on the
access rules don't require authorization; new in version 0.9.0. </p></td>
<td class="struct_member_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="struct_member_name"><p><em class="structfield"><code><a name="GDataAccessHandlerIface.get-rules"></a>get_rules</code></em> ()</p></td>
<td class="struct_member_description"><p> a function to query, parse and return a <a class="link" href="GDataFeed.html" title="GDataFeed"><span class="type">GDataFeed</span></a> of
<a href="GDataAccessRule.html#GDataAccessRule-struct"><span class="type">GDataAccessRules</span></a> for a given entry — the virtual function for
<a class="link" href="GDataAccessHandler.html#gdata-access-handler-get-rules" title="gdata_access_handler_get_rules ()"><code class="function">gdata_access_handler_get_rules()</code></a>; new in version 0.17.2. </p></td>
<td class="struct_member_annotations"><span class="annotation">[<acronym title="NULL may be passed as the value in, out, in-out; or as a return value."><span class="acronym">nullable</span></acronym>]</span></td>
</tr>
</tbody>
</table></div>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24.1</div>
</body>
</html>
|