/usr/share/gtk-doc/html/UPower/UPower.html is in upower-doc 0.9.17-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 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 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>org.freedesktop.UPower</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="UPower Reference Manual">
<link rel="up" href="ref-dbus.html" title="D-Bus API Reference">
<link rel="prev" href="ref-dbus.html" title="D-Bus API Reference">
<link rel="next" href="Device.html" title="org.freedesktop.UPower.Device">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ref-dbus.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">UPower Reference Manual</th>
<td><a accesskey="n" href="Device.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#UPower.synopsis" class="shortcut">Top</a>
|
<a href="#UPower.description" class="shortcut">Description</a>
|
<a href="#UPower.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
|
<a href="#UPower.properties" class="shortcut">Properties</a>
|
<a href="#UPower.signals" class="shortcut">Signals</a>
</td></tr>
</table>
<div class="refentry">
<a name="UPower"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle">org.freedesktop.UPower</span></h2>
<p>org.freedesktop.UPower — UPower interface</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<h2>Methods</h2>
<pre class="synopsis"><a class="link" href="UPower.html#UPower.EnumerateDevices">EnumerateDevices</a> (out 'ao' devices)
<a class="link" href="UPower.html#UPower.AboutToSleep">AboutToSleep</a> (in 's' action)
<a class="link" href="UPower.html#UPower.Suspend">Suspend</a> ()
<a class="link" href="UPower.html#UPower.SuspendAllowed">SuspendAllowed</a> (out 'b' allowed)
<a class="link" href="UPower.html#UPower.Hibernate">Hibernate</a> ()
<a class="link" href="UPower.html#UPower.HibernateAllowed">HibernateAllowed</a> (out 'b' allowed)
</pre>
</div>
<div class="refsect1">
<a name="idp8262544"></a><h2>Signals</h2>
<pre class="synopsis"><a class="link" href="UPower.html#UPower::DeviceAdded">DeviceAdded</a> ('o' device)
<a class="link" href="UPower.html#UPower::DeviceRemoved">DeviceRemoved</a> ('o' device)
<a class="link" href="UPower.html#UPower::DeviceChanged">DeviceChanged</a> ('o' device)
<a class="link" href="UPower.html#UPower::Changed">Changed</a> ()
<a class="link" href="UPower.html#UPower::Sleeping">Sleeping</a> ()
<a class="link" href="UPower.html#UPower::NotifySleep">NotifySleep</a> ('s' action)
<a class="link" href="UPower.html#UPower::Resuming">Resuming</a> ()
<a class="link" href="UPower.html#UPower::NotifyResume">NotifyResume</a> ('s' action)
</pre>
</div>
<div class="refsect1">
<a name="idp99424"></a><h2>Implemented Interfaces</h2>
<p>
Objects implementing org.freedesktop.UPower also implements
org.freedesktop.DBus.Introspectable,
org.freedesktop.DBus.Properties
</p>
</div>
<div class="refsect1">
<a name="idp101440"></a><h2>Properties</h2>
<pre class="synopsis"><a class="link" href="UPower.html#UPower:DaemonVersion">'DaemonVersion'</a> read 's'
<a class="link" href="UPower.html#UPower:CanSuspend">'CanSuspend'</a> read 'b'
<a class="link" href="UPower.html#UPower:CanHibernate">'CanHibernate'</a> read 'b'
<a class="link" href="UPower.html#UPower:OnBattery">'OnBattery'</a> read 'b'
<a class="link" href="UPower.html#UPower:OnLowBattery">'OnLowBattery'</a> read 'b'
<a class="link" href="UPower.html#UPower:LidIsClosed">'LidIsClosed'</a> read 'b'
<a class="link" href="UPower.html#UPower:LidIsPresent">'LidIsPresent'</a> read 'b'
<a class="link" href="UPower.html#UPower:LidForceSleep">'LidForceSleep'</a> read 'b'
<a class="link" href="UPower.html#UPower:IsDocked">'IsDocked'</a> read 'b'
</pre>
</div>
<div class="refsect1">
<a name="idp115456"></a><h2>Description</h2>
<p>
</p>
<p>
The UPower service is available via the system message
bus. To access the service, use
the <code class="literal">org.freedesktop.UPower</code> interface on
the <code class="literal">/org/freedesktop/UPower</code> object on
the D-Bus system bus service with the well-known
name <code class="literal">org.freedesktop.UPower</code>.
</p>
<p>
</p>
<p>
</p>
<div class="informalexample">
<table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td class="listing_lines" align="right"><pre>1
2
3
4
5
6
7
8
9
10
11</pre></td>
<td class="listing_code"><pre class="programlisting">$ dbus<span class="gtkdoc opt">-</span>send <span class="gtkdoc opt">--</span>print<span class="gtkdoc opt">-</span>reply \
<span class="gtkdoc opt">--</span>system \
<span class="gtkdoc opt">--</span>dest<span class="gtkdoc opt">=</span>org<span class="gtkdoc opt">.</span>freedesktop<span class="gtkdoc opt">.</span>UPower \
<span class="gtkdoc opt">/</span>org<span class="gtkdoc opt">/</span>freedesktop<span class="gtkdoc opt">/</span>UPower \
org<span class="gtkdoc opt">.</span>freedesktop<span class="gtkdoc opt">.</span>UPower<span class="gtkdoc opt">.</span>EnumerateDevices
method <span class="keyword">return</span> sender<span class="gtkdoc opt">=:</span><span class="number">1.386</span> <span class="gtkdoc opt">-></span> dest<span class="gtkdoc opt">=:</span><span class="number">1.451</span> reply_serial<span class="gtkdoc opt">=</span><span class="number">2</span>
array <span class="gtkdoc opt">[</span>
object path <span class="string">"/org/freedesktop/UPower/devices/line_power_AC"</span>
object path <span class="string">"/org/freedesktop/UPower/devices/battery_BAT0"</span>
<span class="gtkdoc opt">]</span></pre></td>
</tr>
</tbody>
</table>
</div>
<p>
</p>
<p>
</p>
</div>
<div class="refsect1">
<a name="idp122000"></a><h2>Details</h2>
<div class="refsect2">
<a name="idp122960"></a><h3>
<a name="UPower.EnumerateDevices"></a>EnumerateDevices ()</h3>
<pre class="programlisting">EnumerateDevices (out 'ao' devices)</pre>
</div>
<p>
Enumerate all power objects on the system.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>devices</code></em>:</span></p></td>
<td>An array of object paths for devices.</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp11216"></a><h3>
<a name="UPower.AboutToSleep"></a>AboutToSleep ()</h3>
<pre class="programlisting">AboutToSleep (in 's' action)</pre>
</div>
<p>
This method tells UPower that the Suspend() or Hibernate() method
is about to be called.
This allows UPower to emit the Suspending signal whilst
session activities are happening that have to be done before the
suspend process is started.
</p>
<p>
This method would typically be called by the session power
management daemon, before it locks the screen and waits for the
screen to fade to black.
The session power management component would then call Suspend() or
Hibernate() when these syncronous tasks have completed.
</p>
<p>
If this method is not called than nothing bad will happen and
Suspend() or Hibernate() will block for the required second.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em>:</span></p></td>
<td>
The sleep action type, e.g. <code class="literal">suspend</code> or
<code class="literal">hibernate</code>.
</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp19344"></a><h3>
<a name="UPower.Suspend"></a>Suspend ()</h3>
<pre class="programlisting">Suspend ()</pre>
</div>
<p>
Suspends the computer into a low power state.
System state is not preserved if the power is lost.
</p>
<p>
If AboutToRequestSleep() has not been called then UPower will send
the Sleeping() signal and block for one second.
</p>
<p>
If AboutToRequestSleep() has been called less than one second
before this method is called then UPower will block for the
remaining time to complete one second of delay.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp24352"></a><h3>
<a name="UPower.SuspendAllowed"></a>SuspendAllowed ()</h3>
<pre class="programlisting">SuspendAllowed (out 'b' allowed)</pre>
</div>
<p>
Check if the caller has (or can get) the PolicyKit privilege to call
<code class="function">Suspend</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>allowed</code></em>:</span></p></td>
<td>TRUE if allowed, otherwise FALSE</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7537232"></a><h3>
<a name="UPower.Hibernate"></a>Hibernate ()</h3>
<pre class="programlisting">Hibernate ()</pre>
</div>
<p>
Hibernates the computer into a low power state.
System state is preserved if the power is lost.
</p>
<p>
If AboutToRequestSleep() has not been called then UPower will send
the Sleeping() signal and block for one second.
</p>
<p>
If AboutToRequestSleep() has been called less than one second
before this method is called then UPower will block for the
remaining time to complete one second of delay.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7542240"></a><h3>
<a name="UPower.HibernateAllowed"></a>HibernateAllowed ()</h3>
<pre class="programlisting">HibernateAllowed (out 'b' allowed)</pre>
</div>
<p>
Check if the caller has (or can get) the PolicyKit privilege to call
<code class="function">Hibernate</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>allowed</code></em>:</span></p></td>
<td>TRUE if allowed, otherwise FALSE</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="idp7548688"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="idp7549648"></a><h3>
<a name="UPower::DeviceAdded"></a>The DeviceAdded signal</h3>
<pre class="programlisting">DeviceAdded ('o' device)</pre>
</div>
<p>
Emitted when a device is added.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em>:</span></p></td>
<td>Object path of device that was added.</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7554704"></a><h3>
<a name="UPower::DeviceRemoved"></a>The DeviceRemoved signal</h3>
<pre class="programlisting">DeviceRemoved ('o' device)</pre>
</div>
<p>
Emitted when a device is removed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em>:</span></p></td>
<td>Object path of device that was removed.</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7559776"></a><h3>
<a name="UPower::DeviceChanged"></a>The DeviceChanged signal</h3>
<pre class="programlisting">DeviceChanged ('o' device)</pre>
</div>
<p>
Emitted when a device changed.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em>:</span></p></td>
<td>Object path of device that was changed.</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7564848"></a><h3>
<a name="UPower::Changed"></a>The Changed signal</h3>
<pre class="programlisting">Changed ()</pre>
</div>
<p>
Emitted when one or more properties on the object changes.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7568480"></a><h3>
<a name="UPower::Sleeping"></a>The Sleeping signal</h3>
<pre class="programlisting">Sleeping ()</pre>
</div>
<p>
This signal is sent when the session is about to be suspended or
hibernated.
</p>
<p>
This signal is DEPRECATED. Use NotifySleep() instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7572656"></a><h3>
<a name="UPower::NotifySleep"></a>The NotifySleep signal</h3>
<pre class="programlisting">NotifySleep ('s' action)</pre>
</div>
<p>
This signal is sent when the session is about to be suspended or
hibernated.
Session and system programs have one second to do anything required
before the sleep action is taken (such as sending out Avahi or
Jabber messages).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em>:</span></p></td>
<td>
The sleep action type, e.g. suspend,
hibernate or hybrid.
</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7578096"></a><h3>
<a name="UPower::Resuming"></a>The Resuming signal</h3>
<pre class="programlisting">Resuming ()</pre>
</div>
<p>
This signal is sent when the session has just returned from
Suspend() or Hibernate().
</p>
<p>
This signal is DEPRECATED. Use NotifyResume() instead.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7582288"></a><h3>
<a name="UPower::NotifyResume"></a>The NotifyResume signal</h3>
<pre class="programlisting">NotifyResume ('s' action)</pre>
</div>
<p>
This signal is sent when the session has just returned from
Suspend() or Hibernate().
Session and system programs can then do anything required (such as
sending out Avahi or Jabber messages).
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em>:</span></p></td>
<td>
The sleep action type, e.g. suspend,
hibernate or hybrid.
</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="idp7587840"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="idp7588800"></a><h3>
<a name="UPower:DaemonVersion"></a>The "DaemonVersion" property</h3>
<pre class="programlisting">'DaemonVersion' read 's'
</pre>
</div>
<p>
Version of the running daemon, e.g. <code class="literal">002</code>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7592864"></a><h3>
<a name="UPower:CanSuspend"></a>The "CanSuspend" property</h3>
<pre class="programlisting">'CanSuspend' read 'b'
</pre>
</div>
<p>
Whether the system is able to suspend.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7596208"></a><h3>
<a name="UPower:CanHibernate"></a>The "CanHibernate" property</h3>
<pre class="programlisting">'CanHibernate' read 'b'
</pre>
</div>
<p>
Whether the system is able to hibernate.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7599552"></a><h3>
<a name="UPower:OnBattery"></a>The "OnBattery" property</h3>
<pre class="programlisting">'OnBattery' read 'b'
</pre>
</div>
<p>
Indicates whether the system is running on battery power.
This property is provided for convenience.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7603040"></a><h3>
<a name="UPower:OnLowBattery"></a>The "OnLowBattery" property</h3>
<pre class="programlisting">'OnLowBattery' read 'b'
</pre>
</div>
<p>
Indicates whether the system is running on battery power and if the battery is critically low.
This property is provided for convenience.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7606576"></a><h3>
<a name="UPower:LidIsClosed"></a>The "LidIsClosed" property</h3>
<pre class="programlisting">'LidIsClosed' read 'b'
</pre>
</div>
<p>
Indicates if the laptop lid is closed where the display cannot be seen.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7610352"></a><h3>
<a name="UPower:LidIsPresent"></a>The "LidIsPresent" property</h3>
<pre class="programlisting">'LidIsPresent' read 'b'
</pre>
</div>
<p>
If the system has a lid device.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7614016"></a><h3>
<a name="UPower:LidForceSleep"></a>The "LidForceSleep" property</h3>
<pre class="programlisting">'LidForceSleep' read 'b'
</pre>
</div>
<p>
If the system really has to sleep when the lid is closed.
Some laptops actually melt (!) if the lid is closed and the
computer keeps running. We blacklist those, and do something
sane for the other machines.
</p>
<p>
This allows us to set the default session policy to not
suspend on lid close if the laptop is docked, and be sure
the machine is not going to melt.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="idp7618592"></a><h3>
<a name="UPower:IsDocked"></a>The "IsDocked" property</h3>
<pre class="programlisting">'IsDocked' read 'b'
</pre>
</div>
<p>
If the system is currently docked.
Note: the "is-docked" value is the result of a heuristic,
which may involve testing the display output.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody></tbody>
</table></div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|