de.sleepmap.Caterpillar.xml

<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
<node>
  <interface name="de.sleepmap.Caterpillar">
    <!--
     Trigger the search for an update

     It is advised to subscribe to the `UpdateFound` signal before calling this method.
     -->
    <method name="SearchForUpdate">
    </method>
    <!--
     Trigger the installation of an update

     The parameters to this method provide information on whether to update (b) and whether to reboot afterwards (b)
     -->
    <method name="InstallUpdate">
      <arg name="update" type="b" direction="in"/>
      <arg name="reboot" type="b" direction="in"/>
    </method>
    <!--
     A signal, broadcasting information on found updates

     The update is returned in an array of length one.
     The update information consists of the absolute filename (s),
     the current version of the system (s),
     the new version (s)
     and whether the update is an override (b)
     -->
    <signal name="UpdateFound">
      <arg name="update" type="a(sssb)"/>
    </signal>
    <!--
     Whether the system has been marked for reboot when requesting the installation of an update
     -->
    <property name="MarkedForReboot" type="b" access="read"/>
    <!--
     The internal state of Caterpillar

     One of
     - "done"
     - "idle"
     - "init"
     - "mounted"
     - "mounting"
     - "noupdatefound"
     - "searching"
     - "skip"
     - "unmounted"
     - "unmounting"
     - "updated"
     - "updatefound"
     - "updating"
     -->
    <property name="State" type="s" access="read"/>
    <!--
     Whether the system has been successfully updated
     -->
    <property name="Updated" type="b" access="read"/>
  </interface>
  <interface name="org.freedesktop.DBus.Peer">
    <method name="Ping">
    </method>
    <method name="GetMachineId">
      <arg type="s" direction="out"/>
    </method>
  </interface>
  <interface name="org.freedesktop.DBus.Introspectable">
    <method name="Introspect">
      <arg type="s" direction="out"/>
    </method>
  </interface>
  <interface name="org.freedesktop.DBus.Properties">
    <method name="Get">
      <arg name="interface_name" type="s" direction="in"/>
      <arg name="property_name" type="s" direction="in"/>
      <arg type="v" direction="out"/>
    </method>
    <method name="Set">
      <arg name="interface_name" type="s" direction="in"/>
      <arg name="property_name" type="s" direction="in"/>
      <arg name="value" type="v" direction="in"/>
    </method>
    <method name="GetAll">
      <arg name="interface_name" type="s" direction="in"/>
      <arg type="a{sv}" direction="out"/>
    </method>
    <!--
     Emits the `org.freedesktop.DBus.Properties.PropertiesChanged` signal.
     -->
    <signal name="PropertiesChanged">
      <arg name="interface_name" type="s"/>
      <arg name="changed_properties" type="a{sv}"/>
      <arg name="invalidated_properties" type="as"/>
    </signal>
  </interface>
</node>