minios/dbus_adaptors/org.chromium.MiniOsInterface.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!--
  Copyright 2021 The Chromium Authors. All rights reserved.
  Use of this source code is governed by a BSD-style license that can be
  found in the LICENSE file.
-->
<node name="/org/chromium/MiniOs"
  xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.chromium.MiniOsInterface">
  <method name="GetState">
    <tp:docstring>
      Get the current state of MiniOs.
    </tp:docstring>
    <arg name="state" type="ay" direction="out">
      <tp:docstring>
        A serialized protobuf (State,
        platform2/system_api/dbus/minios/minios.proto) indicating
        the state of MiniOs.
      </tp:docstring>
      <annotation name="org.chromium.DBus.Argument.ProtobufClass"
                  value="minios::State"/>
    </arg>
  </method>
  <method name="Connect">
    <tp:docstring>
      Connect to given wireless network.
    </tp:docstring>
    <arg name="ssid" type="s" direction="in">
      <tp:docstring>
        The SSID of the wireless network to connect to.
      </tp:docstring>
    </arg>
    <arg name="passphrase" type="s" direction="in">
      <tp:docstring>
        The passphrase for the SSID.
        Pass an empty string if there is no passphrase.
      </tp:docstring>
    </arg>
    <annotation name="org.chromium.DBus.Method.Kind" value="async" />
  </method>
  <method name="GetNetworks">
    <tp:docstring>
      Get the list of network SSIDs.
    </tp:docstring>
    <arg name="networks" type="as" direction="out">
      <tp:docstring>
        The list of networks.
      </tp:docstring>
    </arg>
    <annotation name="org.chromium.DBus.Method.Kind" value="async" />
  </method>
  <method name="NextScreen">
    <tp:docstring>
      Advance to the next screen in the flow if possible.
    </tp:docstring>
  </method>
  <method name="PrevScreen">
    <tp:docstring>
      Advance to the previous screen in the flow if possible.
    </tp:docstring>
  </method>
  <method name="ResetState">
    <tp:docstring>
      Reset MiniOs to the initialized state.
    </tp:docstring>
  </method>
  <method name="SetNetworkCredentials">
    <tp:docstring>
      Set the network credentials.
    </tp:docstring>
    <arg name="ssid" type="s" direction="in">
      <tp:docstring>
        The SSID of the wireless network to connect to.
      </tp:docstring>
    </arg>
    <arg name="passphrase" type="s" direction="in">
      <tp:docstring>
        The passphrase for the SSID.
        Pass an empty string if there is no passphrase.
      </tp:docstring>
    </arg>
  </method>
  <method name="PressKey">
    <tp:docstring>
      Send a KeyCode.
    </tp:docstring>
    <arg name="keycode" type="u" direction="in">
      <tp:docstring>
        The keyboard keycode.
      </tp:docstring>
    </arg>
  </method>
  <method name="StartRecovery">
    <tp:docstring>
      Start a network based recovery using the given credentials.
    </tp:docstring>
    <arg name="ssid" type="s" direction="in">
      <tp:docstring>
        The name of the network to connect to.
      </tp:docstring>
    </arg>
    <arg name="passphrase" type="s" direction="in">
      <tp:docstring>
        The passphrase for the network.
        Pass an empty string if there is no passphrase.
      </tp:docstring>
    </arg>
  </method>
  <signal name="MiniOsStateChanged">
    <arg name="state" type="ay" >
      <tp:docstring>
        A serialized protobuf (State,
        platform2/system_api/dbus/minios/minios.proto) indicating
        the state of MiniOs.
      </tp:docstring>
      <annotation name="org.chromium.DBus.Argument.ProtobufClass"
                  value="minios::State"/>
    </arg>
  </signal>
</interface>
</node>