/usr/share/gtk-doc/html/liboobs/OobsSession.html is in liboobs-1-dev 3.0.0-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 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 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Liboobs (System configuration management) Reference Manual: OobsSession</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
<link rel="up" href="ch01.html" title="Common API">
<link rel="prev" href="ch01.html" title="Common API">
<link rel="next" href="OobsObject.html" title="OobsObject">
<meta name="generator" content="GTK-Doc V1.21 (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="#OobsSession.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
<a href="#OobsSession.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#OobsSession.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="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ch01.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="OobsObject.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
</tr></table>
<div class="refentry">
<a name="OobsSession"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="OobsSession.top_of_page"></a>OobsSession</span></h2>
<p>OobsSession — Manager of the connection to the backends</p>
</td>
<td class="gallery_image" valign="top" align="right"></td>
</tr></table></div>
<div class="refsect1">
<a name="OobsSession.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="OobsSession.html" title="OobsSession"><span class="returnvalue">OobsSession</span></a> *
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-get" title="oobs_session_get ()">oobs_session_get</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">OobsResult</span>
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-commit" title="oobs_session_commit ()">oobs_session_commit</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-get-connected" title="oobs_session_get_connected ()">oobs_session_get_connected</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">OobsResult</span>
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-get-supported-platforms" title="oobs_session_get_supported_platforms ()">oobs_session_get_supported_platforms</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">OobsResult</span>
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-get-platform" title="oobs_session_get_platform ()">oobs_session_get_platform</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">
<span class="returnvalue">OobsResult</span>
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()">oobs_session_set_platform</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="OobsSession.html#oobs-session-process-requests" title="oobs_session_process_requests ()">oobs_session_process_requests</a> <span class="c_punctuation">()</span>
</td>
</tr>
<tr>
<td class="function_type">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
</td>
<td class="function_name">
<a class="link" href="OobsSession.html#oobs-session-get-authentication-action" title="oobs_session_get_authentication_action ()">oobs_session_get_authentication_action</a> <span class="c_punctuation">()</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OobsSession.properties"></a><h2>Properties</h2>
<div class="informaltable"><table 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="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td>
<td class="property_name"><a class="link" href="OobsSession.html#OobsSession--platform" title="The “platform” property">platform</a></td>
<td class="property_flags">Read / Write</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OobsSession.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="datatype_keyword">struct</td>
<td class="function_name"><a class="link" href="OobsSession.html#OobsPlatform" title="struct OobsPlatform">OobsPlatform</a></td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="OobsSession.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="screen"> <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
<span class="lineart">╰──</span> OobsSession
</pre>
</div>
<div class="refsect1">
<a name="OobsSession.description"></a><h2>Description</h2>
</div>
<div class="refsect1">
<a name="OobsSession.functions_details"></a><h2>Functions</h2>
<div class="refsect2">
<a name="oobs-session-get"></a><h3>oobs_session_get ()</h3>
<pre class="programlisting"><a class="link" href="OobsSession.html" title="OobsSession"><span class="returnvalue">OobsSession</span></a> *
oobs_session_get (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
<p>Returns the <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> singleton, which represents
the session with the system tools backends.</p>
<div class="refsect3">
<a name="id-1.2.2.8.2.5"></a><h4>Returns</h4>
<p> the singleton <span class="type">OobSession</span> object.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-commit"></a><h3>oobs_session_commit ()</h3>
<pre class="programlisting"><span class="returnvalue">OobsResult</span>
oobs_session_commit (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>);</pre>
<p>Commits inmediately all the changes to the configuration
objects that have been requested through this <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.
Note that it will stop if it finds any error.</p>
<div class="refsect3">
<a name="id-1.2.2.8.3.5"></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>session</p></td>
<td class="parameter_description"><p>an <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.3.6"></a><h4>Returns</h4>
<p> An <span class="type">OobsResult</span> representing the error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-get-connected"></a><h3>oobs_session_get_connected ()</h3>
<pre class="programlisting"><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
oobs_session_get_connected (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>);</pre>
<p>Returns whether the connection with the backends is established.</p>
<div class="refsect3">
<a name="id-1.2.2.8.4.5"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.4.6"></a><h4>Returns</h4>
<p> <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><span class="type">TRUE</span></a> if there's connection with the backends.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-get-supported-platforms"></a><h3>oobs_session_get_supported_platforms ()</h3>
<pre class="programlisting"><span class="returnvalue">OobsResult</span>
oobs_session_get_supported_platforms (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> **platforms</code></em>);</pre>
<p>Retrieves the list of supported platforms, this is only necessary when</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p>oobs_session_get_platform() has returned <span class="type">OOBS_RESULT_NO_PLATFORM</span>. To
specify a platform, you must use <a class="link" href="OobsSession.html#oobs-session-set-platform" title="oobs_session_set_platform ()"><code class="function">oobs_session_set_platform()</code></a>, being
the platform string in that function the platform->id value inside
the <a class="link" href="OobsSession.html#OobsPlatform" title="struct OobsPlatform"><span class="type">OobsPlatform</span></a> struct.</p></li></ul></div>
<div class="refsect3">
<a name="id-1.2.2.8.5.6"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>platforms</p></td>
<td class="parameter_description"><p>return location for the list of platforms. It's a
<a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#GList"><span class="type">GList</span></a> of <a class="link" href="OobsSession.html#OobsPlatform" title="struct OobsPlatform"><span class="type">OobsPlatform</span></a> structs. You must free
this list with <a href="/usr/share/gtk-doc/html/glib/glib-Doubly-Linked-Lists.html#g-list-free"><code class="function">g_list_free()</code></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.5.7"></a><h4>Returns</h4>
<p> An <span class="type">OobsResult</span> representing the error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-get-platform"></a><h3>oobs_session_get_platform ()</h3>
<pre class="programlisting"><span class="returnvalue">OobsResult</span>
oobs_session_get_platform (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>,
<em class="parameter"><code><a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **platform</code></em>);</pre>
<p>Retrieves the platform your system has been identified with, or
<a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a> in case your platform is not recognized or other error happens.</p>
<div class="refsect3">
<a name="id-1.2.2.8.6.5"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>platform</p></td>
<td class="parameter_description"><p>location to store the current platform, or <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#NULL:CAPS"><span class="type">NULL</span></a>. This
string is of internal use, and must not be freed or modified.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.6.6"></a><h4>Returns</h4>
<p> An <span class="type">OobsResult</span> representing the error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-set-platform"></a><h3>oobs_session_set_platform ()</h3>
<pre class="programlisting"><span class="returnvalue">OobsResult</span>
oobs_session_set_platform (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>,
<em class="parameter"><code>const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *platform</code></em>);</pre>
<p>Identifies your platform as the one set in <em class="parameter"><code>platform</code></em>
. This is only necessary if
your platform could not be guessed (and thus <a class="link" href="OobsSession.html#oobs-session-get-platform" title="oobs_session_get_platform ()"><code class="function">oobs_session_get_platform()</code></a> would
return <span class="type">OOBS_RESULT_NO_PLATFORM</span> in this case).</p>
<div class="refsect3">
<a name="id-1.2.2.8.7.5"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a>.</p></td>
<td class="parameter_annotations"> </td>
</tr>
<tr>
<td class="parameter_name"><p>platform</p></td>
<td class="parameter_description"><p>A string defining the platform. see
<code class="function">oobs_session_get_platforms_list()</code> to know where to get this string.</p></td>
<td class="parameter_annotations"> </td>
</tr>
</tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.7.6"></a><h4>Returns</h4>
<p> An <span class="type">OobsResult</span> representing the error.</p>
<p></p>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-process-requests"></a><h3>oobs_session_process_requests ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>
oobs_session_process_requests (<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>);</pre>
<p>Blocks until all pending asynchronous requests have been processed.</p>
<div class="refsect3">
<a name="id-1.2.2.8.8.5"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
</div>
<hr>
<div class="refsect2">
<a name="oobs-session-get-authentication-action"></a><h3>oobs_session_get_authentication_action ()</h3>
<pre class="programlisting">const <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
oobs_session_get_authentication_action
(<em class="parameter"><code><a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a> *session</code></em>);</pre>
<p>Returns the PolicyKit action the user has to be authenticated to in order to
commit changes to configuration objects in this session. If the user has not
the required permissions, any attempt to commit will return <span class="type">OOBS_RESULT_ACCESS_DENIED</span>.</p>
<div class="refsect3">
<a name="id-1.2.2.8.9.5"></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>session</p></td>
<td class="parameter_description"><p>An <a class="link" href="OobsSession.html" title="OobsSession"><span class="type">OobsSession</span></a></p></td>
<td class="parameter_annotations"> </td>
</tr></tbody>
</table></div>
</div>
<div class="refsect3">
<a name="id-1.2.2.8.9.6"></a><h4>Returns</h4>
<p> string defining the PolicyKit action
required to modify objects in the session.</p>
<p></p>
</div>
</div>
</div>
<div class="refsect1">
<a name="OobsSession.other_details"></a><h2>Types and Values</h2>
<div class="refsect2">
<a name="OobsPlatform"></a><h3>struct OobsPlatform</h3>
<pre class="programlisting">struct OobsPlatform {
const gchar *id;
const gchar *name;
const gchar *version;
const gchar *codename;
};
</pre>
<p>
</p>
</div>
</div>
<div class="refsect1">
<a name="OobsSession.property-details"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="OobsSession--platform"></a><h3>The <code class="literal">“platform”</code> property</h3>
<pre class="programlisting"> “platform” <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre>
<p>Name of the platform the session is running on.</p>
<p>Flags: Read / Write</p>
<p>Default value: NULL</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.21</div>
</body>
</html>
|