Warning, /plasma/plasma-workspace/applets/batterymonitor/dbus/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 <method name="GetDisplayDevice"> 0055 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0056 <arg name="device" direction="out" type="o"> 0057 <doc:doc><doc:summary>An object path for the "display device.</doc:summary></doc:doc> 0058 </arg> 0059 0060 <doc:doc> 0061 <doc:description> 0062 <doc:para> 0063 Get the object to the "display device", a composite device that represents the 0064 status icon to show in desktop environments. You can also access the object directly 0065 as its path is guaranteed to be /org/freedesktop/UPower/devices/DisplayDevice. 0066 The following standard org.freedesktop.UPower.Device 0067 properties will be defined (only <doc:ref type="property" to="Source:IsPresent">IsPresent</doc:ref> takes a special meaning): 0068 <doc:list> 0069 <doc:item> 0070 <doc:term>Type</doc:term><doc:definition>the type of the display device, UPS or Battery. Note that this value can change, as opposed to real devices.</doc:definition> 0071 </doc:item> 0072 <doc:item> 0073 <doc:term>State</doc:term><doc:definition>the power state of the display device, such as Charging or Discharging.</doc:definition> 0074 </doc:item> 0075 <doc:item> 0076 <doc:term>Percentage</doc:term><doc:definition>the amount of energy left on the device.</doc:definition> 0077 </doc:item> 0078 <doc:item> 0079 <doc:term>Energy</doc:term><doc:definition>Amount of energy (measured in Wh) currently available in the power source.</doc:definition> 0080 </doc:item> 0081 <doc:item> 0082 <doc:term>EnergyFull</doc:term><doc:definition>Amount of energy (measured in Wh) in the power source when it's considered full.</doc:definition> 0083 </doc:item> 0084 <doc:item> 0085 <doc:term>EnergyRate</doc:term><doc:definition>Amount of energy being drained from the source, measured in W. If positive, the source is being discharged, if negative it's being charged.</doc:definition> 0086 </doc:item> 0087 <doc:item> 0088 <doc:term>TimeToEmpty</doc:term><doc:definition>Number of seconds until the power source is considered empty.</doc:definition> 0089 </doc:item> 0090 <doc:item> 0091 <doc:term>TimeToFull</doc:term><doc:definition>Number of seconds until the power source is considered full.</doc:definition> 0092 </doc:item> 0093 <doc:item> 0094 <doc:term>IsPresent</doc:term><doc:definition>Whether a status icon using this information should be presented.</doc:definition> 0095 </doc:item> 0096 <doc:item> 0097 <doc:term>IconName</doc:term><doc:definition>An icon name representing the device state.</doc:definition> 0098 </doc:item> 0099 <doc:item> 0100 <doc:term>WarningLevel</doc:term><doc:definition>The same as the overall <doc:ref type="property" to="Source:WarningLevel">WarningLevel</doc:ref></doc:definition> 0101 </doc:item> 0102 </doc:list> 0103 </doc:para> 0104 </doc:description> 0105 </doc:doc> 0106 </method> 0107 0108 <method name="GetCriticalAction"> 0109 <annotation name="org.freedesktop.DBus.GLib.Async" value=""/> 0110 <arg name="action" direction="out" type="s"> 0111 <doc:doc><doc:summary>A string representing the critical action configured and available.</doc:summary></doc:doc> 0112 </arg> 0113 0114 <doc:doc> 0115 <doc:description> 0116 <doc:para> 0117 When the system's power supply is critical (critically low batteries or UPS), 0118 the system will take this action. Possible values are: 0119 <doc:list> 0120 <doc:item> 0121 <doc:term>HybridSleep</doc:term> 0122 </doc:item> 0123 <doc:item> 0124 <doc:term>Hibernate</doc:term> 0125 </doc:item> 0126 <doc:item> 0127 <doc:term>PowerOff</doc:term> 0128 </doc:item> 0129 </doc:list> 0130 </doc:para> 0131 </doc:description> 0132 </doc:doc> 0133 </method> 0134 0135 <!-- ************************************************************ --> 0136 0137 <signal name="DeviceAdded"> 0138 <arg name="device" type="o"> 0139 <doc:doc><doc:summary>Object path of device that was added.</doc:summary></doc:doc> 0140 </arg> 0141 0142 <doc:doc> 0143 <doc:description> 0144 <doc:para> 0145 Emitted when a device is added. 0146 </doc:para> 0147 </doc:description> 0148 </doc:doc> 0149 </signal> 0150 0151 <!-- ************************************************************ --> 0152 0153 <signal name="DeviceRemoved"> 0154 <arg name="device" type="o"> 0155 <doc:doc><doc:summary>Object path of device that was removed.</doc:summary></doc:doc> 0156 </arg> 0157 0158 <doc:doc> 0159 <doc:description> 0160 <doc:para> 0161 Emitted when a device is removed. 0162 </doc:para> 0163 </doc:description> 0164 </doc:doc> 0165 </signal> 0166 0167 <!-- ************************************************************ --> 0168 0169 <property name="DaemonVersion" type="s" access="read"> 0170 <doc:doc><doc:description><doc:para> 0171 Version of the running daemon, e.g. <doc:tt>002</doc:tt>. 0172 </doc:para></doc:description></doc:doc> 0173 </property> 0174 0175 <property name="OnBattery" type="b" access="read"> 0176 <doc:doc><doc:description><doc:para> 0177 Indicates whether the system is running on battery power. 0178 This property is provided for convenience. 0179 </doc:para></doc:description></doc:doc> 0180 </property> 0181 0182 </interface> 0183 0184 </node>