/usr/share/gtk-doc/html/gdata/GDataAuthorizationDomain.html is in libgdata-doc 0.17.9-2.
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 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GDataAuthorizationDomain: GData Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
<link rel="home" href="index.html" title="GData Reference Manual">
<link rel="up" href="ch05.html" title="Authentication/Authorization API">
<link rel="prev" href="GDataAuthorizer.html" title="GDataAuthorizer">
<link rel="next" href="GDataClientLoginAuthorizer.html" title="GDataClientLoginAuthorizer">
<meta name="generator" content="GTK-Doc V1.26.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="#GDataAuthorizationDomain.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#GDataAuthorizationDomain.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#GDataAuthorizationDomain.properties" class="shortcut">Properties</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="ch05.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="GDataAuthorizer.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="GDataClientLoginAuthorizer.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="GDataAuthorizationDomain"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GDataAuthorizationDomain.top_of_page"></a>GDataAuthorizationDomain</span></h2>
<p>GDataAuthorizationDomain — GData authorization domain</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.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="GDataAuthorizationDomain.functions"></a><h2>Functions</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="functions_return">
<col class="functions_name">
</colgroup>
<tbody>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataAuthorizationDomain.html#gdata-authorization-domain-get-service-name" title="gdata_authorization_domain_get_service_name ()">gdata_authorization_domain_get_service_name</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="GDataAuthorizationDomain.html#gdata-authorization-domain-get-scope" title="gdata_authorization_domain_get_scope ()">gdata_authorization_domain_get_scope</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.properties"></a><h2>Properties</h2>
<div class="informaltable"><table class="informaltable" border="0">
<colgroup>
<col width="150px" class="properties_type">
<col width="300px" class="properties_name">
<col width="200px" class="properties_flags">
</colgroup>
<tbody>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomain--scope" title="The “scope” property">scope</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
<tr>
<td class="property_type">
<a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomain--service-name" title="The “service-name” property">service-name</a></td>
<td class="property_flags">Read / Write / Construct Only</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.other"></a><h2>Types and Values</h2>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="name">
<col class="description">
</colgroup>
<tbody>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomain-struct" title="GDataAuthorizationDomain">GDataAuthorizationDomain</a></td>
</tr>
<tr>
<td class="datatype_keyword"> </td>
<td class="function_name"><a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomainClass" title="GDataAuthorizationDomainClass">GDataAuthorizationDomainClass</a></td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="../gobject/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a>
<span class="lineart">╰──</span> GDataAuthorizationDomain
</pre>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.includes"></a><h2>Includes</h2>
<pre class="synopsis">#include <gdata/gdata-authorization-domain.h>
</pre>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.description"></a><h2>Description</h2>
<p>A <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> represents a single data domain which a user can authorize libgdata to access. This might be a domain covering the
whole of the user's Google Contacts account, for example. Typically, <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>s map to <a href="GDataAuthorizationDomain.html#GDataAuthorizationDomain-struct"><span class="type">GDataAuthorizationDomains</span></a> in a one-to-one
fashion, though some services (such as <a class="link" href="GDataDocumentsService.html" title="GDataDocumentsService"><span class="type">GDataDocumentsService</span></a>) use multiple authorization domains.</p>
<p>The <a href="GDataAuthorizationDomain.html#GDataAuthorizationDomain-struct"><span class="type">GDataAuthorizationDomains</span></a>s used by a service can be retrieved using <a class="link" href="GDataService.html#gdata-service-get-authorization-domains" title="gdata_service_get_authorization_domains ()"><code class="function">gdata_service_get_authorization_domains()</code></a>. The set of domains
used by a given service is static and will never change at runtime.</p>
<p><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s are used by a <a class="link" href="GDataAuthorizer.html" title="GDataAuthorizer"><span class="type">GDataAuthorizer</span></a> instance to request authorization to interact with data in those domains when
first authenticating and authorizing with the online service. Typically, a given <a class="link" href="GDataAuthorizer.html" title="GDataAuthorizer"><span class="type">GDataAuthorizer</span></a> will be passed a set of domains (or a service
type, from which it can retrieve the service's set of domains) at construction time, and will use those domains when initially asking the user for
authorization and whenever the authorization is refreshed afterwards. It's not expected that the set of domains used by a <a class="link" href="GDataAuthorizer.html" title="GDataAuthorizer"><span class="type">GDataAuthorizer</span></a> will
change after construction time.</p>
<p>Note that it's not expected that <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a>s will have to be constructed manually. All <a class="link" href="GDataService.html" title="GDataService"><span class="type">GDataService</span></a>s should provide
accessor functions to return instances of all the authorization domains they support.</p>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="gdata-authorization-domain-get-service-name"></a><h3>gdata_authorization_domain_get_service_name ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_authorization_domain_get_service_name
(<em class="parameter"><code><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *self</code></em>);</pre>
<p>Returns the name of the service containing the authorization domain. See <a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomain--service-name" title="The “service-name” property"><span class="type">“service-name”</span></a> for more details.</p>
<div class="refsect3">
<a name="gdata-authorization-domain-get-service-name.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-authorization-domain-get-service-name.returns"></a><h4>Returns</h4>
<p> name of the service containing the authorization domain</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="gdata-authorization-domain-get-scope"></a><h3>gdata_authorization_domain_get_scope ()</h3>
<pre class="programlisting">const <a href="../glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
gdata_authorization_domain_get_scope (<em class="parameter"><code><a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> *self</code></em>);</pre>
<p>Returns a URI detailing the scope of the authorization domain. See <a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomain--scope" title="The “scope” property"><span class="type">“scope”</span></a> for more details.</p>
<div class="refsect3">
<a name="gdata-authorization-domain-get-scope.parameters"></a><h4>Parameters</h4>
<div class="informaltable"><table class="informaltable" width="100%" border="0">
<colgroup>
<col width="150px" class="parameters_name">
<col class="parameters_description">
<col width="200px" class="parameters_annotations">
</colgroup>
<tbody><tr>
<td class="parameter_name"><p>self</p></td>
<td class="parameter_description"><p>a <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="gdata-authorization-domain-get-scope.returns"></a><h4>Returns</h4>
<p> URI detailing the scope of the authorization domain</p>
</div>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="GDataAuthorizationDomain-struct"></a><h3>GDataAuthorizationDomain</h3>
<pre class="programlisting">typedef struct _GDataAuthorizationDomain GDataAuthorizationDomain;</pre>
<p>All the fields in the <a class="link" href="GDataAuthorizationDomain.html" title="GDataAuthorizationDomain"><span class="type">GDataAuthorizationDomain</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataAuthorizationDomainClass"></a><h3>GDataAuthorizationDomainClass</h3>
<pre class="programlisting">typedef struct {
} GDataAuthorizationDomainClass;
</pre>
<p>All the fields in the <a class="link" href="GDataAuthorizationDomain.html#GDataAuthorizationDomainClass" title="GDataAuthorizationDomainClass"><span class="type">GDataAuthorizationDomainClass</span></a> structure are private and should never be accessed directly.</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
</div>
<div class="refsect1">
<a name="GDataAuthorizationDomain.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="GDataAuthorizationDomain--scope"></a><h3>The <code class="literal">“scope”</code> property</h3>
<pre class="programlisting"> “scope” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>A URI detailing the scope of the authorization domain, as enumerated in the</p>
<a class="ulink" href="http://code.google.com/apis/documents/faq_gdata.html#AuthScopes" target="_top">online documentation</a>.
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<p class="since">Since: <a class="link" href="ix11.html#api-index-0.9.0">0.9.0</a></p>
</div>
<hr>
<div class="refsect2">
<a name="GDataAuthorizationDomain--service-name"></a><h3>The <code class="literal">“service-name”</code> property</h3>
<pre class="programlisting"> “service-name” <a href="../glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>The name of the service which contains the authorization domain, as enumerated in the</p>
<a class="ulink" href="http://code.google.com/apis/documents/faq_gdata.html#clientlogin" target="_top">online documentation</a>.
<p>Flags: Read / Write / Construct Only</p>
<p>Default value: NULL</p>
<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.26.1</div>
</body>
</html>
|