Debian Codegraph @

doc/reference/html/OobsObject.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>OobsObject</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
7 <link rel="home" href="index.html" title="Liboobs (System configuration management) Reference Manual">
8 <link rel="up" href="ch01.html" title="Common API">
9 <link rel="prev" href="OobsSession.html" title="OobsSession">
10 <link rel="next" href="OobsList.html" title="OobsList">
11 <meta name="generator" content="GTK-Doc V1.15 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16 <tr valign="middle">
17 <td><a accesskey="p" href="OobsSession.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="ch01.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">Liboobs (System configuration management) Reference Manual</th>
21 <td><a accesskey="n" href="OobsList.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22 </tr>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#OobsObject.synopsis" class="shortcut">Top</a>
25  | 
26 <a href="#OobsObject.description" class="shortcut">Description</a>
27  | 
28 <a href="#OobsObject.object-hierarchy" class="shortcut">Object Hierarchy</a>
29  | 
30 <a href="#OobsObject.properties" class="shortcut">Properties</a>
31  | 
32 <a href="#OobsObject.signals" class="shortcut">Signals</a>
33 </td></tr>
34 </table>
35 <div class="refentry" title="OobsObject">
36 <a name="OobsObject"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
38 <td valign="top">
39 <h2><span class="refentrytitle"><a name="OobsObject.top_of_page"></a>OobsObject</span></h2>
40 <p>OobsObject — Base object for all configuration objects</p>
41 </td>
42 <td valign="top" align="right"></td>
43 </tr></table></div>
44 <div class="refsynopsisdiv" title="Synopsis">
45 <a name="OobsObject.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis"> <a class="link" href="OobsObject.html#OobsObject-struct" title="OobsObject">OobsObject</a>;
47 <a class="link" href="OobsObject.html#OobsObjectClass" title="OobsObjectClass">OobsObjectClass</a>;
48 <span class="returnvalue">void</span> (<a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()">*OobsObjectAsyncFunc</a>) (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
49 <em class="parameter"><code><span class="type">OobsResult</span> result</code></em>,
50 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
51 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-commit" title="oobs_object_commit ()">oobs_object_commit</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
52 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-commit-async" title="oobs_object_commit_async ()">oobs_object_commit_async</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
53 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
54 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
55 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-add" title="oobs_object_add ()">oobs_object_add</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
56 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-add-async" title="oobs_object_add_async ()">oobs_object_add_async</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
57 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
58 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
59 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-delete" title="oobs_object_delete ()">oobs_object_delete</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
60 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-delete-async" title="oobs_object_delete_async ()">oobs_object_delete_async</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
61 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
62 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
63 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-update" title="oobs_object_update ()">oobs_object_update</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
64 <span class="returnvalue">OobsResult</span> <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()">oobs_object_update_async</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
65 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
66 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);
67 <span class="returnvalue">void</span> <a class="link" href="OobsObject.html#oobs-object-process-requests" title="oobs_object_process_requests ()">oobs_object_process_requests</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
68 <span class="returnvalue">gboolean</span> <a class="link" href="OobsObject.html#oobs-object-has-updated" title="oobs_object_has_updated ()">oobs_object_has_updated</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
69 <span class="returnvalue">void</span> <a class="link" href="OobsObject.html#oobs-object-ensure-update" title="oobs_object_ensure_update ()">oobs_object_ensure_update</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);
70 <span class="returnvalue">gboolean</span> <a class="link" href="OobsObject.html#oobs-object-authenticate" title="oobs_object_authenticate ()">oobs_object_authenticate</a> (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
71 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);
72 </pre>
73 </div>
74 <div class="refsect1" title="Object Hierarchy">
75 <a name="OobsObject.object-hierarchy"></a><h2>Object Hierarchy</h2>
76 <pre class="synopsis">
77 GObject
78 +----OobsObject
79 +----<a class="link" href="OobsGroup.html" title="OobsGroup">OobsGroup</a>
80 +----<a class="link" href="OobsGroupsConfig.html" title="OobsGroupsConfig">OobsGroupsConfig</a>
81 +----<a class="link" href="OobsHostsConfig.html" title="OobsHostsConfig">OobsHostsConfig</a>
82 +----<a class="link" href="OobsIfacesConfig.html" title="OobsIfacesConfig">OobsIfacesConfig</a>
83 +----<a class="link" href="OobsNFSConfig.html" title="OobsNFSConfig">OobsNFSConfig</a>
84 +----<a class="link" href="OobsNTPConfig.html" title="OobsNTPConfig">OobsNTPConfig</a>
85 +----<a class="link" href="OobsSelfConfig.html" title="OobsSelfConfig">OobsSelfConfig</a>
86 +----<a class="link" href="OobsService.html" title="OobsService">OobsService</a>
87 +----<a class="link" href="OobsServicesConfig.html" title="OobsServicesConfig">OobsServicesConfig</a>
88 +----<a class="link" href="OobsSMBConfig.html" title="OobsSMBConfig">OobsSMBConfig</a>
89 +----<a class="link" href="OobsTimeConfig.html" title="OobsTimeConfig">OobsTimeConfig</a>
90 +----<a class="link" href="OobsUser.html" title="OobsUser">OobsUser</a>
91 +----<a class="link" href="OobsUsersConfig.html" title="OobsUsersConfig">OobsUsersConfig</a>
92 </pre>
93 </div>
94 <div class="refsect1" title="Properties">
95 <a name="OobsObject.properties"></a><h2>Properties</h2>
96 <pre class="synopsis">
97 "<a class="link" href="OobsObject.html#OobsObject--remote-object" title='The "remote-object" property'>remote-object</a>" <span class="type">gchar</span>* : Write / Construct Only
98 </pre>
99 </div>
100 <div class="refsect1" title="Signals">
101 <a name="OobsObject.signals"></a><h2>Signals</h2>
102 <pre class="synopsis">
103 "<a class="link" href="OobsObject.html#OobsObject-changed" title='The "changed" signal'>changed</a>" : Run Last
104 "<a class="link" href="OobsObject.html#OobsObject-committed" title='The "committed" signal'>committed</a>" : Run Last
105 "<a class="link" href="OobsObject.html#OobsObject-updated" title='The "updated" signal'>updated</a>" : Run Last
106 </pre>
107 </div>
108 <div class="refsect1" title="Description">
109 <a name="OobsObject.description"></a><h2>Description</h2>
110 </div>
111 <div class="refsect1" title="Details">
112 <a name="OobsObject.details"></a><h2>Details</h2>
113 <div class="refsect2" title="OobsObject">
114 <a name="OobsObject-struct"></a><h3>OobsObject</h3>
115 <pre class="programlisting">typedef struct _OobsObject OobsObject;</pre>
116 <p>
117 </p>
118 </div>
119 <hr>
120 <div class="refsect2" title="OobsObjectClass">
121 <a name="OobsObjectClass"></a><h3>OobsObjectClass</h3>
122 <pre class="programlisting">typedef struct {
123 GObjectClass parent_class;
124
125 /* virtual methods */
126 void (*commit) (OobsObject *object);
127 void (*get_update_message) (OobsObject *object);
128 void (*update) (OobsObject *object);
129
130 /* signals */
131 void (*updated) (OobsObject *object);
132 void (*committed) (OobsObject *object);
133 void (*changed) (OobsObject *object);
134
135 void (*_oobs_padding1) (void);
136 void (*_oobs_padding2) (void);
137 } OobsObjectClass;
138 </pre>
139 <p>
140 </p>
141 </div>
142 <hr>
143 <div class="refsect2" title="OobsObjectAsyncFunc ()">
144 <a name="OobsObjectAsyncFunc"></a><h3>OobsObjectAsyncFunc ()</h3>
145 <pre class="programlisting"><span class="returnvalue">void</span> (*OobsObjectAsyncFunc) (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
146 <em class="parameter"><code><span class="type">OobsResult</span> result</code></em>,
147 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
148 <p>
149 </p>
150 <div class="variablelist"><table border="0">
151 <col align="left" valign="top">
152 <tbody>
153 <tr>
154 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
155 <td>
156 </td>
157 </tr>
158 <tr>
159 <td><p><span class="term"><em class="parameter"><code>result</code></em> :</span></p></td>
160 <td>
161 </td>
162 </tr>
163 <tr>
164 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
165 <td>
166 </td>
167 </tr>
168 </tbody>
169 </table></div>
170 </div>
171 <hr>
172 <div class="refsect2" title="oobs_object_commit ()">
173 <a name="oobs-object-commit"></a><h3>oobs_object_commit ()</h3>
174 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_commit (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
175 <p>
176 Commits to the system all the changes done
177 to the configuration held by an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
178 </p>
179 <div class="variablelist"><table border="0">
180 <col align="left" valign="top">
181 <tbody>
182 <tr>
183 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
184 <td>an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
185 </td>
186 </tr>
187 <tr>
188 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
189 <td> an <span class="type">OobsResult</span> enum with the error code.
190 </td>
191 </tr>
192 </tbody>
193 </table></div>
194 </div>
195 <hr>
196 <div class="refsect2" title="oobs_object_commit_async ()">
197 <a name="oobs-object-commit-async"></a><h3>oobs_object_commit_async ()</h3>
198 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_commit_async (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
199 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
200 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
201 <p>
202 Commits to the system all the changes done to the configuration held by an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
203 This change will be asynchronous, being run the function <em class="parameter"><code>func</code></em> when the change has been done.
204 </p>
205 <div class="variablelist"><table border="0">
206 <col align="left" valign="top">
207 <tbody>
208 <tr>
209 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
210 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
211 </td>
212 </tr>
213 <tr>
214 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
215 <td>An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
216 </td>
217 </tr>
218 <tr>
219 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
220 <td>Additional data to pass to <em class="parameter"><code>func</code></em>.
221 </td>
222 </tr>
223 <tr>
224 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
225 <td> an <span class="type">OobsResult</span> enum with the error code. Due to the asynchronous nature
226 of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
227 </td>
228 </tr>
229 </tbody>
230 </table></div>
231 </div>
232 <hr>
233 <div class="refsect2" title="oobs_object_add ()">
234 <a name="oobs-object-add"></a><h3>oobs_object_add ()</h3>
235 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_add (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
236 <p>
237 Add an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> to the system's configuration. This is only
238 supported by certain individual objects, others are added by committing
239 a modified objects list.
240 </p>
241 <div class="variablelist"><table border="0">
242 <col align="left" valign="top">
243 <tbody>
244 <tr>
245 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
246 <td>an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
247 </td>
248 </tr>
249 <tr>
250 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
251 <td> an <span class="type">OobsResult</span> enum with the error code.
252 </td>
253 </tr>
254 </tbody>
255 </table></div>
256 </div>
257 <hr>
258 <div class="refsect2" title="oobs_object_add_async ()">
259 <a name="oobs-object-add-async"></a><h3>oobs_object_add_async ()</h3>
260 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_add_async (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
261 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
262 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
263 <p>
264 Add an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> to the system's configuration.
265 This change will be asynchronous, being run the function <em class="parameter"><code>func</code></em> when the change has been done.
266 </p>
267 <div class="variablelist"><table border="0">
268 <col align="left" valign="top">
269 <tbody>
270 <tr>
271 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
272 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
273 </td>
274 </tr>
275 <tr>
276 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
277 <td>An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
278 </td>
279 </tr>
280 <tr>
281 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
282 <td>Additional data to pass to <em class="parameter"><code>func</code></em>.
283 </td>
284 </tr>
285 <tr>
286 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
287 <td> an <span class="type">OobsResult</span> enum with the error code. Due to the asynchronous nature
288 of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
289 </td>
290 </tr>
291 </tbody>
292 </table></div>
293 </div>
294 <hr>
295 <div class="refsect2" title="oobs_object_delete ()">
296 <a name="oobs-object-delete"></a><h3>oobs_object_delete ()</h3>
297 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_delete (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
298 <p>
299 Delete an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> from the system's configuration. This is only
300 supported by certain individual objects, others are added by committing
301 a modified objects list.
302 </p>
303 <div class="variablelist"><table border="0">
304 <col align="left" valign="top">
305 <tbody>
306 <tr>
307 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
308 <td>an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
309 </td>
310 </tr>
311 <tr>
312 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
313 <td> an <span class="type">OobsResult</span> enum with the error code.
314 </td>
315 </tr>
316 </tbody>
317 </table></div>
318 </div>
319 <hr>
320 <div class="refsect2" title="oobs_object_delete_async ()">
321 <a name="oobs-object-delete-async"></a><h3>oobs_object_delete_async ()</h3>
322 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_delete_async (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
323 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
324 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
325 <p>
326 Delete an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> from the system's configuration.
327 This change will be asynchronous, being run the function <em class="parameter"><code>func</code></em> when the change has been done.
328 </p>
329 <div class="variablelist"><table border="0">
330 <col align="left" valign="top">
331 <tbody>
332 <tr>
333 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
334 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
335 </td>
336 </tr>
337 <tr>
338 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
339 <td>An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
340 </td>
341 </tr>
342 <tr>
343 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
344 <td>Additional data to pass to <em class="parameter"><code>func</code></em>.
345 </td>
346 </tr>
347 <tr>
348 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
349 <td> an <span class="type">OobsResult</span> enum with the error code. Due to the asynchronous nature
350 of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
351 </td>
352 </tr>
353 </tbody>
354 </table></div>
355 </div>
356 <hr>
357 <div class="refsect2" title="oobs_object_update ()">
358 <a name="oobs-object-update"></a><h3>oobs_object_update ()</h3>
359 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_update (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
360 <p>
361 Synchronizes the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
362 with the actual system configuration. All the changes done
363 to the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> will be forgotten.
364 </p>
365 <div class="variablelist"><table border="0">
366 <col align="left" valign="top">
367 <tbody>
368 <tr>
369 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
370 <td>an <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
371 </td>
372 </tr>
373 <tr>
374 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
375 <td> an <span class="type">OobsResult</span> enum with the error code.
376 </td>
377 </tr>
378 </tbody>
379 </table></div>
380 </div>
381 <hr>
382 <div class="refsect2" title="oobs_object_update_async ()">
383 <a name="oobs-object-update-async"></a><h3>oobs_object_update_async ()</h3>
384 <pre class="programlisting"><span class="returnvalue">OobsResult</span> oobs_object_update_async (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
385 <em class="parameter"><code><a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> func</code></em>,
386 <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre>
387 <p>
388 Synchronizes the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
389 with the actual system configuration. All the changes done
390 to the configuration held by the <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> will be forgotten.
391 The update operation will be asynchronous, being run the
392 function <em class="parameter"><code>func</code></em> when the update has been done.
393 </p>
394 <div class="variablelist"><table border="0">
395 <col align="left" valign="top">
396 <tbody>
397 <tr>
398 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
399 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
400 </td>
401 </tr>
402 <tr>
403 <td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
404 <td>An <a class="link" href="OobsObject.html#OobsObjectAsyncFunc" title="OobsObjectAsyncFunc ()"><span class="type">OobsObjectAsyncFunc</span></a> that will be called when the asynchronous operation has ended.
405 </td>
406 </tr>
407 <tr>
408 <td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
409 <td>Aditional data to pass to <em class="parameter"><code>func</code></em>.
410 </td>
411 </tr>
412 <tr>
413 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
414 <td> an <span class="type">OobsResult</span> enum with the error code. Due to the asynchronous nature
415 of the function, only OOBS_RESULT_MALFORMED and OOBS_RESULT_OK can be returned.
416 </td>
417 </tr>
418 </tbody>
419 </table></div>
420 </div>
421 <hr>
422 <div class="refsect2" title="oobs_object_process_requests ()">
423 <a name="oobs-object-process-requests"></a><h3>oobs_object_process_requests ()</h3>
424 <pre class="programlisting"><span class="returnvalue">void</span> oobs_object_process_requests (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
425 <p>
426 Blocks until all pending asynchronous requests to this object have been processed.
427 </p>
428 <div class="variablelist"><table border="0">
429 <col align="left" valign="top">
430 <tbody><tr>
431 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
432 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
433 </td>
434 </tr></tbody>
435 </table></div>
436 </div>
437 <hr>
438 <div class="refsect2" title="oobs_object_has_updated ()">
439 <a name="oobs-object-has-updated"></a><h3>oobs_object_has_updated ()</h3>
440 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_object_has_updated (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
441 <p>
442 Returns whether the object has been updated since its creation.
443 see <a class="link" href="OobsObject.html#oobs-object-update" title="oobs_object_update ()"><code class="function">oobs_object_update()</code></a> and <a class="link" href="OobsObject.html#oobs-object-update-async" title="oobs_object_update_async ()"><code class="function">oobs_object_update_async()</code></a>.
444 </p>
445 <div class="variablelist"><table border="0">
446 <col align="left" valign="top">
447 <tbody>
448 <tr>
449 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
450 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
451 </td>
452 </tr>
453 <tr>
454 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
455 <td> <span class="type">TRUE</span> if the object has been updated.
456 </td>
457 </tr>
458 </tbody>
459 </table></div>
460 </div>
461 <hr>
462 <div class="refsect2" title="oobs_object_ensure_update ()">
463 <a name="oobs-object-ensure-update"></a><h3>oobs_object_ensure_update ()</h3>
464 <pre class="programlisting"><span class="returnvalue">void</span> oobs_object_ensure_update (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>);</pre>
465 <p>
466 Ensures that the given object has been updated. If not
467 it either blocks until any update request sent is
468 dispatched or updates synchronously.
469 </p>
470 <div class="variablelist"><table border="0">
471 <col align="left" valign="top">
472 <tbody><tr>
473 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
474 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>
475 </td>
476 </tr></tbody>
477 </table></div>
478 </div>
479 <hr>
480 <div class="refsect2" title="oobs_object_authenticate ()">
481 <a name="oobs-object-authenticate"></a><h3>oobs_object_authenticate ()</h3>
482 <pre class="programlisting"><span class="returnvalue">gboolean</span> oobs_object_authenticate (<em class="parameter"><code><a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *object</code></em>,
483 <em class="parameter"><code><span class="type">GError</span> **error</code></em>);</pre>
484 <p>
485 Performs a PolicyKit authentication via the backends for the action
486 required by the given object. User interaction will occur synchronously
487 if needed.
488 </p>
489 <p>
490 You may want to check the returned error for <a class="link" href="liboobs-OobsError.html#OOBS-ERROR-AUTHENTICATION-CANCELLED:CAPS"><code class="literal">OOBS_ERROR_AUTHENTICATION_CANCELLED</code></a>,
491 in which case you should avoid showing an error dialog to the user.
492 </p>
493 <div class="variablelist"><table border="0">
494 <col align="left" valign="top">
495 <tbody>
496 <tr>
497 <td><p><span class="term"><em class="parameter"><code>object</code></em> :</span></p></td>
498 <td>An <a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a>.
499 </td>
500 </tr>
501 <tr>
502 <td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
503 <td>Return location for error or NULL.
504 </td>
505 </tr>
506 <tr>
507 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
508 <td> <code class="literal">TRUE</code> if allowed to commit <em class="parameter"><code>object</code></em>, <code class="literal">FALSE</code> otherwise.
509 </td>
510 </tr>
511 </tbody>
512 </table></div>
513 </div>
514 </div>
515 <div class="refsect1" title="Property Details">
516 <a name="OobsObject.property-details"></a><h2>Property Details</h2>
517 <div class="refsect2" title='The "remote-object" property'>
518 <a name="OobsObject--remote-object"></a><h3>The <code class="literal">"remote-object"</code> property</h3>
519 <pre class="programlisting"> "remote-object" <span class="type">gchar</span>* : Write / Construct Only</pre>
520 <p>Name of the remote object at the other side of the connection.</p>
521 <p>Default value: NULL</p>
522 </div>
523 </div>
524 <div class="refsect1" title="Signal Details">
525 <a name="OobsObject.signal-details"></a><h2>Signal Details</h2>
526 <div class="refsect2" title='The "changed" signal'>
527 <a name="OobsObject-changed"></a><h3>The <code class="literal">"changed"</code> signal</h3>
528 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *oobsobject,
529 <span class="type">gpointer</span> user_data) : Run Last</pre>
530 <p>
531 </p>
532 <div class="variablelist"><table border="0">
533 <col align="left" valign="top">
534 <tbody>
535 <tr>
536 <td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
537 <td>the object which received the signal.
538 </td>
539 </tr>
540 <tr>
541 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
542 <td>user data set when the signal handler was connected.</td>
543 </tr>
544 </tbody>
545 </table></div>
546 </div>
547 <hr>
548 <div class="refsect2" title='The "committed" signal'>
549 <a name="OobsObject-committed"></a><h3>The <code class="literal">"committed"</code> signal</h3>
550 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *oobsobject,
551 <span class="type">gpointer</span> user_data) : Run Last</pre>
552 <p>
553 </p>
554 <div class="variablelist"><table border="0">
555 <col align="left" valign="top">
556 <tbody>
557 <tr>
558 <td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
559 <td>the object which received the signal.
560 </td>
561 </tr>
562 <tr>
563 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
564 <td>user data set when the signal handler was connected.</td>
565 </tr>
566 </tbody>
567 </table></div>
568 </div>
569 <hr>
570 <div class="refsect2" title='The "updated" signal'>
571 <a name="OobsObject-updated"></a><h3>The <code class="literal">"updated"</code> signal</h3>
572 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="OobsObject.html" title="OobsObject"><span class="type">OobsObject</span></a> *oobsobject,
573 <span class="type">gpointer</span> user_data) : Run Last</pre>
574 <p>
575 </p>
576 <div class="variablelist"><table border="0">
577 <col align="left" valign="top">
578 <tbody>
579 <tr>
580 <td><p><span class="term"><em class="parameter"><code>oobsobject</code></em> :</span></p></td>
581 <td>the object which received the signal.
582 </td>
583 </tr>
584 <tr>
585 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
586 <td>user data set when the signal handler was connected.</td>
587 </tr>
588 </tbody>
589 </table></div>
590 </div>
591 </div>
592 <div class="refsect1" title="See Also">
593 <a name="OobsObject.see-also"></a><h2>See Also</h2>
594 <a class="link" href="OobsList.html" title="OobsList"><span class="type">OobsList</span></a>
595 </div>
596 </div>
597 <div class="footer">
598 <hr>
599 Generated by GTK-Doc V1.15</div>
600 </body>
601 </html>