/usr/share/dbus-1/interfaces/org.freedesktop.UPower.xml is in upower 0.9.23-2ubuntu1.
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 | <!DOCTYPE node PUBLIC
"-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
<interface name="org.freedesktop.UPower">
<doc:doc>
<doc:description>
<doc:para>
The UPower service is available via the system message
bus. To access the service, use
the <doc:tt>org.freedesktop.UPower</doc:tt> interface on
the <doc:tt>/org/freedesktop/UPower</doc:tt> object on
the D-Bus system bus service with the well-known
name <doc:tt>org.freedesktop.UPower</doc:tt>.
</doc:para>
<doc:para>
<doc:example language="shell" title="simple example">
<doc:code>
$ 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"
]
</doc:code>
</doc:example>
</doc:para>
</doc:description>
</doc:doc>
<!-- ************************************************************ -->
<method name="EnumerateDevices">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="devices" direction="out" type="ao">
<doc:doc><doc:summary>An array of object paths for devices.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Enumerate all power objects on the system.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<signal name="DeviceAdded">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was added.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is added.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceRemoved">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was removed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device is removed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="DeviceChanged">
<arg name="device" type="o">
<doc:doc><doc:summary>Object path of device that was changed.</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Emitted when a device changed.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="Changed">
<doc:doc>
<doc:description>
<doc:para>
Emitted when one or more properties on the object changes.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="Sleeping">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when the session is about to be suspended or
hibernated.
</doc:para>
<doc:para>
This signal is DEPRECATED. Use NotifySleep() instead.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="NotifySleep">
<doc:doc>
<doc:description>
<doc:para>
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).
</doc:para>
</doc:description>
</doc:doc>
<arg name="action" direction="out" type="s">
<doc:doc>
<doc:summary>
The sleep action type, e.g. <doc:tt>suspend</doc:tt>,
<doc:tt>hibernate</doc:tt> or <doc:tt>hybrid</doc:tt>.
</doc:summary>
</doc:doc>
</arg>
</signal>
<!-- ************************************************************ -->
<signal name="Resuming">
<doc:doc>
<doc:description>
<doc:para>
This signal is sent when the session has just returned from
Suspend() or Hibernate().
</doc:para>
<doc:para>
This signal is DEPRECATED. Use NotifyResume() instead.
</doc:para>
</doc:description>
</doc:doc>
</signal>
<!-- ************************************************************ -->
<signal name="NotifyResume">
<doc:doc>
<doc:description>
<doc:para>
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).
</doc:para>
</doc:description>
</doc:doc>
<arg name="action" direction="out" type="s">
<doc:doc>
<doc:summary>
The sleep action type, e.g. <doc:tt>suspend</doc:tt>,
<doc:tt>hibernate</doc:tt> or <doc:tt>hybrid</doc:tt>.
</doc:summary>
</doc:doc>
</arg>
</signal>
<!-- ************************************************************ -->
<method name="AboutToSleep">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
<doc:para>
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.
</doc:para>
<doc:para>
If this method is not called than nothing bad will happen and
Suspend() or Hibernate() will block for the required second.
</doc:para>
</doc:description>
</doc:doc>
<arg name="action" direction="in" type="s">
<doc:doc>
<doc:summary>
The sleep action type, e.g. <doc:tt>suspend</doc:tt> or
<doc:tt>hibernate</doc:tt>.
</doc:summary>
</doc:doc>
</arg>
</method>
<!-- ************************************************************ -->
<method name="Suspend">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Suspends the computer into a low power state.
System state is not preserved if the power is lost.
</doc:para>
<doc:para>
If AboutToSleep() has not been called then UPower will send
the Sleeping() signal and block for one second.
</doc:para>
<doc:para>
If AboutToSleep() 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.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="SuspendAllowed">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="allowed" direction="out" type="b">
<doc:doc><doc:summary>TRUE if allowed, otherwise FALSE</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Check if the caller has (or can get) the PolicyKit privilege to call
<doc:ref type="method" to="Power.Suspend">Suspend</doc:ref>.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="Hibernate">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<doc:doc>
<doc:description>
<doc:para>
Hibernates the computer into a low power state.
System state is preserved if the power is lost.
</doc:para>
<doc:para>
If AboutToSleep() has not been called then UPower will send
the Sleeping() signal and block for one second.
</doc:para>
<doc:para>
If AboutToSleep() 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.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<method name="HibernateAllowed">
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="allowed" direction="out" type="b">
<doc:doc><doc:summary>TRUE if allowed, otherwise FALSE</doc:summary></doc:doc>
</arg>
<doc:doc>
<doc:description>
<doc:para>
Check if the caller has (or can get) the PolicyKit privilege to call
<doc:ref type="method" to="Power.Hibernate">Hibernate</doc:ref>.
</doc:para>
</doc:description>
</doc:doc>
</method>
<!-- ************************************************************ -->
<property name="DaemonVersion" type="s" access="read">
<doc:doc><doc:description><doc:para>
Version of the running daemon, e.g. <doc:tt>002</doc:tt>.
</doc:para></doc:description></doc:doc>
</property>
<property name="CanSuspend" type="b" access="read">
<doc:doc><doc:description><doc:para>
Whether the system is able to suspend.
</doc:para></doc:description></doc:doc>
</property>
<property name="CanHibernate" type="b" access="read">
<doc:doc><doc:description><doc:para>
Whether the system is able to hibernate.
</doc:para></doc:description></doc:doc>
</property>
<property name="OnBattery" type="b" access="read">
<doc:doc><doc:description><doc:para>
Indicates whether the system is running on battery power.
This property is provided for convenience.
</doc:para></doc:description></doc:doc>
</property>
<property name="OnLowBattery" type="b" access="read">
<doc:doc><doc:description><doc:para>
Indicates whether the system is running on battery power and if the battery is critically low.
This property is provided for convenience.
</doc:para></doc:description></doc:doc>
</property>
<property name="LidIsClosed" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
Indicates if the laptop lid is closed where the display cannot be seen.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="LidIsPresent" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If the system has a lid device.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="LidForceSleep" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
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.
</doc:para>
<doc:para>
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.
</doc:para>
</doc:description>
</doc:doc>
</property>
<property name="IsDocked" type="b" access="read">
<doc:doc>
<doc:description>
<doc:para>
If the system is currently docked.
Note: the "is-docked" value is the result of a heuristic,
which may involve testing the display output.
</doc:para>
</doc:description>
</doc:doc>
</property>
</interface>
</node>
|