/usr/share/gtk-doc/html/UPower/UPower.html is in upower-doc 0.99.4-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 | <!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: UPower Reference Manual</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.79.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.24 (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="#UPower.description" class="shortcut">Description</a></span><span id="nav_interfaces"> <span class="dim">|</span>
<a href="#UPower.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span>
<a href="#UPower.properties" class="shortcut">Properties</a></span><span id="nav_signals"> <span class="dim">|</span>
<a href="#UPower.signals" class="shortcut">Signals</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="ref-dbus.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
<td><a accesskey="p" href="ref-dbus.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
<td><a accesskey="n" href="Device.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></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 class="gallery_image" 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.GetDisplayDevice">GetDisplayDevice</a>(out'o'device)
<a class="link" href="UPower.html#UPower.GetCriticalAction">GetCriticalAction</a>(out's'action)
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.3.4"></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)
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.3.5"></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="id-1.2.3.6"></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:OnBattery">'OnBattery'</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'
</pre>
</div>
<div class="refsect1">
<a name="id-1.2.3.7"></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"><pre class="programlisting">
$ dbus-send --print-reply \
--system \
--dest=org.freedesktop.UPower \
/org/freedesktop/UPower \
org.freedesktop.UPower.EnumerateDevices
method return sender=:1.386 -> dest=:1.451 reply_serial=2
array [
object path "/org/freedesktop/UPower/devices/line_power_AC"
object path "/org/freedesktop/UPower/devices/battery_BAT0"
]
</pre></div>
<p>
</p>
<p>
</p>
</div>
<div class="refsect1">
<a name="id-1.2.3.8"></a><h2>Details</h2>
<div class="refsect2">
<a name="id-1.2.3.8.2"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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="id-1.2.3.8.5"></a><h3>
<a name="UPower.GetDisplayDevice"></a>GetDisplayDevice ()</h3>
<pre class="programlisting">GetDisplayDevice (out'o'device)</pre>
</div>
<p>
Get the object to the "display device", a composite device that represents the
status icon to show in desktop environments. You can also access the object directly
as its path is guaranteed to be /org/freedesktop/UPower/devices/DisplayDevice.
The following standard org.freedesktop.UPower.Device
properties will be defined (only <code class="literal">IsPresent</code> takes a special meaning):
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem">
<span class="bold"><strong>Type: </strong></span>the type of the display device, UPS or Battery. Note that this value can change, as opposed to real devices.</li>
<li class="listitem">
<span class="bold"><strong>State: </strong></span>the power state of the display device, such as Charging or Discharging.</li>
<li class="listitem">
<span class="bold"><strong>Percentage: </strong></span>the amount of energy left on the device.</li>
<li class="listitem">
<span class="bold"><strong>Energy: </strong></span>Amount of energy (measured in Wh) currently available in the power source.</li>
<li class="listitem">
<span class="bold"><strong>EnergyFull: </strong></span>Amount of energy (measured in Wh) in the power source when it's considered full.</li>
<li class="listitem">
<span class="bold"><strong>EnergyRate: </strong></span>Amount of energy being drained from the source, measured in W. If positive, the source is being discharged, if negative it's being charged.</li>
<li class="listitem">
<span class="bold"><strong>TimeToEmpty: </strong></span>Number of seconds until the power source is considered empty.</li>
<li class="listitem">
<span class="bold"><strong>TimeToFull: </strong></span>Number of seconds until the power source is considered full.</li>
<li class="listitem">
<span class="bold"><strong>IsPresent: </strong></span>Whether a status icon using this information should be presented.</li>
<li class="listitem">
<span class="bold"><strong>IconName: </strong></span>An icon name representing the device state.</li>
<li class="listitem">
<span class="bold"><strong>WarningLevel: </strong></span>The same as the overall <code class="literal">WarningLevel</code>
</li>
</ul></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>device</code></em>:</span></p></td>
<td>An object path for the "display device.</td>
</tr></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="id-1.2.3.8.8"></a><h3>
<a name="UPower.GetCriticalAction"></a>GetCriticalAction ()</h3>
<pre class="programlisting">GetCriticalAction (out's'action)</pre>
</div>
<p>
When the system's power supply is critical (critically low batteries or UPS),
the system will take this action. Possible values are:
</p>
<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
<li class="listitem"><span class="bold"><strong>HybridSleep: </strong></span></li>
<li class="listitem"><span class="bold"><strong>Hibernate: </strong></span></li>
<li class="listitem"><span class="bold"><strong>PowerOff: </strong></span></li>
</ul></div>
<p>
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody><tr>
<td><p><span class="term"><em class="parameter"><code>action</code></em>:</span></p></td>
<td>A string representing the critical action configured and available.</td>
</tr></tbody>
</table></div>
</div>
<div class="refsect1">
<a name="id-1.2.3.9"></a><h2>Signal Details</h2>
<div class="refsect2">
<a name="id-1.2.3.9.2"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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="id-1.2.3.9.5"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<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>
</div>
<div class="refsect1">
<a name="id-1.2.3.10"></a><h2>Property Details</h2>
<div class="refsect2">
<a name="id-1.2.3.10.2"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="id-1.2.3.10.5"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="id-1.2.3.10.8"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody></tbody>
</table></div>
<hr>
<div class="refsect2">
<a name="id-1.2.3.10.11"></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" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody></tbody>
</table></div>
</div>
</div>
<div class="footer">
<hr>Generated by GTK-Doc V1.24</div>
</body>
</html>
|