Warning, /plasma/plasma-workspace/libkworkspace/org.freedesktop.UPower.xml is written in an unsupported language. File is not indexed.
0001 <!DOCTYPE node PUBLIC 0002 "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" 0003 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd"> 0004 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> 0005 0006 <interface name="org.freedesktop.UPower"> 0007 <doc:doc> 0008 <doc:description> 0009 <doc:para> 0010 The UPower service is available via the system message 0011 bus. To access the service, use 0012 the <doc:tt>org.freedesktop.UPower</doc:tt> interface on 0013 the <doc:tt>/org/freedesktop/UPower</doc:tt> object on 0014 the D-Bus system bus service with the well-known 0015 name <doc:tt>org.freedesktop.UPower</doc:tt>. 0016 </doc:para> 0017 <doc:para> 0018 <doc:example language="shell" title="simple example"> 0019 <doc:code> 0020 $ dbus-send --print-reply \ 0021 --system \ 0022 --dest=org.freedesktop.UPower \ 0023 /org/freedesktop/UPower \ 0024 org.freedesktop.UPower.EnumerateDevices 0025 0026 method return sender=:1.386 -> dest=:1.451 reply_serial=2 0027 array [ 0028 object path "/org/freedesktop/UPower/devices/line_power_AC" 0029 object path "/org/freedesktop/UPower/devices/battery_BAT0" 0030 ] 0031 </doc:code> 0032 </doc:example> 0033 </doc:para> 0034 </doc:description> 0035 </doc:doc> 0036 0037 <!-- ************************************************************ --> 0038 0039 <method name="EnumerateDevices"> 0040 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0041 <arg name="devices" direction="out" type="ao"> 0042 <doc:doc><doc:summary>An array of object paths for devices.</doc:summary></doc:doc> 0043 </arg> 0044 0045 <doc:doc> 0046 <doc:description> 0047 <doc:para> 0048 Enumerate all power objects on the system. 0049 </doc:para> 0050 </doc:description> 0051 </doc:doc> 0052 </method> 0053 0054 <!-- ************************************************************ --> 0055 0056 <signal name="DeviceAdded"> 0057 <arg name="device" type="s"> 0058 <doc:doc><doc:summary>Object path of device that was added.</doc:summary></doc:doc> 0059 </arg> 0060 0061 <doc:doc> 0062 <doc:description> 0063 <doc:para> 0064 Emitted when a device is added. 0065 </doc:para> 0066 </doc:description> 0067 </doc:doc> 0068 </signal> 0069 0070 <!-- ************************************************************ --> 0071 0072 <signal name="DeviceRemoved"> 0073 <arg name="device" type="s"> 0074 <doc:doc><doc:summary>Object path of device that was removed.</doc:summary></doc:doc> 0075 </arg> 0076 0077 <doc:doc> 0078 <doc:description> 0079 <doc:para> 0080 Emitted when a device is removed. 0081 </doc:para> 0082 </doc:description> 0083 </doc:doc> 0084 </signal> 0085 0086 <!-- ************************************************************ --> 0087 0088 <signal name="DeviceChanged"> 0089 <arg name="device" type="s"> 0090 <doc:doc><doc:summary>Object path of device that was changed.</doc:summary></doc:doc> 0091 </arg> 0092 0093 <doc:doc> 0094 <doc:description> 0095 <doc:para> 0096 Emitted when a device changed. 0097 </doc:para> 0098 </doc:description> 0099 </doc:doc> 0100 </signal> 0101 0102 <!-- ************************************************************ --> 0103 0104 <signal name="Changed"> 0105 <doc:doc> 0106 <doc:description> 0107 <doc:para> 0108 Emitted when one or more properties on the object changes. 0109 </doc:para> 0110 </doc:description> 0111 </doc:doc> 0112 </signal> 0113 0114 <!-- ************************************************************ --> 0115 0116 <signal name="Sleeping"> 0117 <doc:doc> 0118 <doc:description> 0119 <doc:para> 0120 This signal is sent when the session is about to be suspended or 0121 hibernated. 0122 </doc:para> 0123 <doc:para> 0124 This signal is DEPRECATED. Use NotifySleep() instead. 0125 </doc:para> 0126 </doc:description> 0127 </doc:doc> 0128 </signal> 0129 0130 <!-- ************************************************************ --> 0131 0132 <signal name="NotifySleep"> 0133 <doc:doc> 0134 <doc:description> 0135 <doc:para> 0136 This signal is sent when the session is about to be suspended or 0137 hibernated. 0138 Session and system programs have one second to do anything required 0139 before the sleep action is taken (such as sending out Avahi or 0140 Jabber messages). 0141 </doc:para> 0142 </doc:description> 0143 </doc:doc> 0144 <arg name="action" direction="out" type="s"> 0145 <doc:doc> 0146 <doc:summary> 0147 The sleep action type, e.g. <doc:tt>suspend</doc:tt>, 0148 <doc:tt>hibernate</doc:tt> or <doc:tt>hybrid</doc:tt>. 0149 </doc:summary> 0150 </doc:doc> 0151 </arg> 0152 </signal> 0153 0154 <!-- ************************************************************ --> 0155 0156 <signal name="Resuming"> 0157 <doc:doc> 0158 <doc:description> 0159 <doc:para> 0160 This signal is sent when the session has just returned from 0161 Suspend() or Hibernate(). 0162 </doc:para> 0163 <doc:para> 0164 This signal is DEPRECATED. Use NotifyResume() instead. 0165 </doc:para> 0166 </doc:description> 0167 </doc:doc> 0168 </signal> 0169 0170 <!-- ************************************************************ --> 0171 0172 <signal name="NotifyResume"> 0173 <doc:doc> 0174 <doc:description> 0175 <doc:para> 0176 This signal is sent when the session has just returned from 0177 Suspend() or Hibernate(). 0178 Session and system programs can then do anything required (such as 0179 sending out Avahi or Jabber messages). 0180 </doc:para> 0181 </doc:description> 0182 </doc:doc> 0183 <arg name="action" direction="out" type="s"> 0184 <doc:doc> 0185 <doc:summary> 0186 The sleep action type, e.g. <doc:tt>suspend</doc:tt>, 0187 <doc:tt>hibernate</doc:tt> or <doc:tt>hybrid</doc:tt>. 0188 </doc:summary> 0189 </doc:doc> 0190 </arg> 0191 </signal> 0192 0193 <!-- ************************************************************ --> 0194 0195 <method name="AboutToSleep"> 0196 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0197 <doc:doc> 0198 <doc:description> 0199 <doc:para> 0200 This method tells UPower that the Suspend() or Hibernate() method 0201 is about to be called. 0202 This allows UPower to Q_EMIT the Suspending signal whilst 0203 session activities are happening that have to be done before the 0204 suspend process is started. 0205 </doc:para> 0206 <doc:para> 0207 This method would typically be called by the session power 0208 management daemon, before it locks the screen and waits for the 0209 screen to fade to black. 0210 The session power management component would then call Suspend() or 0211 Hibernate() when these syncronous tasks have completed. 0212 </doc:para> 0213 <doc:para> 0214 If this method is not called than nothing bad will happen and 0215 Suspend() or Hibernate() will block for the required second. 0216 </doc:para> 0217 </doc:description> 0218 </doc:doc> 0219 <arg name="action" direction="in" type="s"> 0220 <doc:doc> 0221 <doc:summary> 0222 The sleep action type, e.g. <doc:tt>suspend</doc:tt> or 0223 <doc:tt>hibernate</doc:tt>. 0224 </doc:summary> 0225 </doc:doc> 0226 </arg> 0227 </method> 0228 0229 <!-- ************************************************************ --> 0230 0231 <method name="Suspend"> 0232 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0233 <doc:doc> 0234 <doc:description> 0235 <doc:para> 0236 Suspends the computer into a low power state. 0237 System state is not preserved if the power is lost. 0238 </doc:para> 0239 <doc:para> 0240 If AboutToRequestSleep() has not been called then UPower will send 0241 the Sleeping() signal and block for one second. 0242 </doc:para> 0243 <doc:para> 0244 If AboutToRequestSleep() has been called less than one second 0245 before this method is called then UPower will block for the 0246 remaining time to complete one second of delay. 0247 </doc:para> 0248 </doc:description> 0249 </doc:doc> 0250 </method> 0251 0252 <!-- ************************************************************ --> 0253 0254 <method name="SuspendAllowed"> 0255 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0256 <arg name="allowed" direction="out" type="b"> 0257 <doc:doc><doc:summary>TRUE if allowed, otherwise FALSE</doc:summary></doc:doc> 0258 </arg> 0259 <doc:doc> 0260 <doc:description> 0261 <doc:para> 0262 Check if the caller has (or can get) the PolicyKit privilege to call 0263 <doc:ref type="method" to="Power.Suspend">Suspend</doc:ref>. 0264 </doc:para> 0265 </doc:description> 0266 </doc:doc> 0267 </method> 0268 0269 <!-- ************************************************************ --> 0270 0271 <method name="Hibernate"> 0272 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0273 <doc:doc> 0274 <doc:description> 0275 <doc:para> 0276 Hibernates the computer into a low power state. 0277 System state is preserved if the power is lost. 0278 </doc:para> 0279 <doc:para> 0280 If AboutToRequestSleep() has not been called then UPower will send 0281 the Sleeping() signal and block for one second. 0282 </doc:para> 0283 <doc:para> 0284 If AboutToRequestSleep() has been called less than one second 0285 before this method is called then UPower will block for the 0286 remaining time to complete one second of delay. 0287 </doc:para> 0288 </doc:description> 0289 </doc:doc> 0290 </method> 0291 0292 <!-- ************************************************************ --> 0293 0294 <method name="HibernateAllowed"> 0295 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0296 <arg name="allowed" direction="out" type="b"> 0297 <doc:doc><doc:summary>TRUE if allowed, otherwise FALSE</doc:summary></doc:doc> 0298 </arg> 0299 <doc:doc> 0300 <doc:description> 0301 <doc:para> 0302 Check if the caller has (or can get) the PolicyKit privilege to call 0303 <doc:ref type="method" to="Power.Hibernate">Hibernate</doc:ref>. 0304 </doc:para> 0305 </doc:description> 0306 </doc:doc> 0307 </method> 0308 0309 <!-- ************************************************************ --> 0310 0311 <property name="DaemonVersion" type="s" access="read"> 0312 <doc:doc><doc:description><doc:para> 0313 Version of the running daemon, e.g. <doc:tt>002</doc:tt>. 0314 </doc:para></doc:description></doc:doc> 0315 </property> 0316 0317 <property name="CanSuspend" type="b" access="read"> 0318 <doc:doc><doc:description><doc:para> 0319 Whether the system is able to suspend. 0320 </doc:para></doc:description></doc:doc> 0321 </property> 0322 0323 <property name="CanHibernate" type="b" access="read"> 0324 <doc:doc><doc:description><doc:para> 0325 Whether the system is able to hibernate. 0326 </doc:para></doc:description></doc:doc> 0327 </property> 0328 0329 <property name="OnBattery" type="b" access="read"> 0330 <doc:doc><doc:description><doc:para> 0331 Indicates whether the system is running on battery power. 0332 This property is provided for convenience. 0333 </doc:para></doc:description></doc:doc> 0334 </property> 0335 0336 <property name="OnLowBattery" type="b" access="read"> 0337 <doc:doc><doc:description><doc:para> 0338 Indicates whether the system is running on battery power and if the battery is critically low. 0339 This property is provided for convenience. 0340 </doc:para></doc:description></doc:doc> 0341 </property> 0342 0343 <property name="LidIsClosed" type="b" access="read"> 0344 <doc:doc> 0345 <doc:description> 0346 <doc:para> 0347 Indicates if the laptop lid is closed where the display cannot be seen. 0348 </doc:para> 0349 </doc:description> 0350 </doc:doc> 0351 </property> 0352 0353 <property name="LidIsPresent" type="b" access="read"> 0354 <doc:doc> 0355 <doc:description> 0356 <doc:para> 0357 If the system has a lid device. 0358 </doc:para> 0359 </doc:description> 0360 </doc:doc> 0361 </property> 0362 0363 <property name="LidForceSleep" type="b" access="read"> 0364 <doc:doc> 0365 <doc:description> 0366 <doc:para> 0367 If the system really has to sleep when the lid is closed. 0368 Some laptops actually melt (!) if the lid is closed and the 0369 computer keeps running. We blacklist those, and do something 0370 sane for the other machines. 0371 </doc:para> 0372 <doc:para> 0373 This allows us to set the default session policy to not 0374 suspend on lid close if the laptop is docked, and be sure 0375 the machine is not going to melt. 0376 </doc:para> 0377 </doc:description> 0378 </doc:doc> 0379 </property> 0380 0381 <property name="IsDocked" type="b" access="read"> 0382 <doc:doc> 0383 <doc:description> 0384 <doc:para> 0385 If the system is currently docked. 0386 Note: the "is-docked" value is the result of a heuristic, 0387 which may involve testing the display output. 0388 </doc:para> 0389 </doc:description> 0390 </doc:doc> 0391 </property> 0392 0393 </interface> 0394 0395 </node>