upower/src/org.freedesktop.DeviceKit.Power.xml

<!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.DeviceKit.Power">

    <!-- ************************************************************ -->

    <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="OnBatteryChanged">
      <arg name="on_battery" type="b">
        <doc:doc><doc:summary>If we are on battery power.</doc:summary></doc:doc>
      </arg>

      <doc:doc>
        <doc:description>
          <doc:para>
            Emitted when the main power source of the system has changed.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <!-- ************************************************************ -->
    <signal name="LowBatteryChanged">
      <arg name="low_battery" type="b">
        <doc:doc><doc:summary>If we are critically low on battery power.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Emitted when the main power source of the system is critically low in power.
          </doc:para>
        </doc:description>
      </doc:doc>
    </signal>

    <!-- ************************************************************ -->
    <method name="GetOnBattery">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="on_battery" direction="out" type="b">
        <doc:doc><doc:summary>If we are on battery power.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Finds out if we are using battery so we can make policy decisions,
            for instance not running the indexer when we are on battery power.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->
    <method name="GetLowBattery">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="low_battery" direction="out" type="b">
        <doc:doc><doc:summary>If we are critically low on battery power.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Finds out if we are critically low on battery so we can make policy
            decisions, for instance saving documents or turning off network
            connections.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->

    <method name="CanSuspend">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="interactive" direction="in" type="b">
        <doc:doc>
          <doc:summary>
            If we are allowed to be interactive, and ask the user to authorise
            the action.
          </doc:summary>
        </doc:doc>
      </arg>
      <arg name="can_suspend" direction="out" type="b">
        <doc:doc><doc:summary>If we can suspend.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Returns if the computer is able to suspend.
            This function should be used to decide whether to show the
            Supend menu item or button in GUI programs.
          </doc:para>
        </doc:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->

    <method name="CanHibernate">
      <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
      <arg name="interactive" direction="in" type="b">
        <doc:doc>
          <doc:summary>
            If we are allowed to be interactive, and ask the user to authorise
            the action.
          </doc:summary>
        </doc:doc>
      </arg>
      <arg name="can_hibernate" direction="out" type="b">
        <doc:doc><doc:summary>If we can hibernate.</doc:summary></doc:doc>
      </arg>
      <doc:doc>
        <doc:description>
          <doc:para>
            Returns if the computer is able to hibernate.
            This function should be used to decide whether to show the
            Hibernate menu item or button in GUI programs.
          </doc:para>
        </doc:description>
      </doc:doc>
    </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: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:description>
      </doc:doc>
    </method>

    <!-- ************************************************************ -->

  </interface>

</node>