workspace/solid/networkmanager-0.7/dbus/introspection/nm-vpn-plugin.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4   <interface name="org.freedesktop.NetworkManager.VPN.Plugin">
   5     <tp:docstring>
   6       This interface is provided by plugins providing VPN services to the NetworkManager daemon.
   7     </tp:docstring>
   8     <method name="Connect">
   9       <tp:docstring>
  10         Tells the plugin to connect.
  11       </tp:docstring>
  12       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/>
  13       <arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
  14         <tp:docstring>
  15           Describes the connection to be established.
  16         </tp:docstring>
  17       </arg>
  18       <tp:possible-errors>
  19         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
  20         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/>
  21         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
  22         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/>
  23         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/>
  24       </tp:possible-errors>
  25     </method>
  26
  27     <method name="NeedSecrets">
  28       <tp:docstring>
  29         Asks the plugin whether the provided connection will require secrets to connect successfully.
  30       </tp:docstring>
  31       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/>
  32       <arg name="settings" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
  33         <tp:docstring>
  34           Describes the connection that may need secrets.
  35         </tp:docstring>
  36       </arg>
  37       <arg name="setting_name" type="s" direction="out">
  38         <tp:docstring>
  39           The setting name within the provided connection that requires secrets, if any.
  40         </tp:docstring>
  41       </arg>
  42       <tp:possible-errors>
  43         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/>
  44       </tp:possible-errors>
  45     </method>
  46
  47     <method name="Disconnect">
  48       <tp:docstring>
  49         Disconnect the plugin.
  50       </tp:docstring>
  51       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/>
  52       <tp:possible-errors>
  53         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
  54         <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"/>
  55       </tp:possible-errors>
  56     </method>
  57
  58     <method name="SetIp4Config">
  59       <tp:docstring>
  60         Set IPv4 details on the connection.
  61       </tp:docstring>
  62       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/>
  63       <arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
  64         <tp:docstring>
  65           Ip4Config details for the conneciton.
  66         </tp:docstring>
  67       </arg>
  68     </method>
  69
  70     <method name="SetFailure">
  71       <tp:docstring>
  72         Indicate a failure to the plugin.
  73       </tp:docstring>
  74       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/>
  75       <arg name="reason" type="s" direction="in">
  76         <tp:docstring>
  77           The reason for the failure.
  78         </tp:docstring>
  79       </arg>
  80     </method>
  81
  82     <property name="State" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
  83       <tp:docstring>
  84         The state of the plugin.
  85       </tp:docstring>
  86     </property>
  87
  88     <signal name="StateChanged">
  89       <tp:docstring>
  90         Emitted when the plugin state changes.
  91       </tp:docstring>
  92       <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
  93         <tp:docstring>
  94           The new state of the plugin.
  95         </tp:docstring>
  96       </arg>
  97     </signal>
  98
  99     <signal name="Ip4Config">
 100       <tp:docstring>
 101         The plugin obtained an IPv4 configuration.
 102       </tp:docstring>
 103       <arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map">
 104         <tp:docstring>
 105           The IPv4 configuration.
 106         </tp:docstring>
 107       </arg>
 108     </signal>
 109
 110     <signal name="LoginBanner">
 111       <tp:docstring>
 112         Emitted when the plugin receives a login banner from the VPN service.
 113       </tp:docstring>
 114       <arg name="banner" type="s">
 115         <tp:docstring>
 116           The login banner string.
 117         </tp:docstring>
 118       </arg>
 119     </signal>
 120
 121     <signal name="Failure">
 122       <tp:docstring>
 123         Emitted when a failure in the VPN plugin occurs.
 124       </tp:docstring>
 125       <arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE">
 126         <tp:docstring>
 127           Reason code for the failure.
 128         </tp:docstring>
 129       </arg>
 130     </signal>
 131
 132     <tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u">
 133       <tp:enumvalue suffix="LOGIN_FAILED" value="0">
 134         <tp:docstring>
 135           Login failed.
 136         </tp:docstring>
 137       </tp:enumvalue>
 138       <tp:enumvalue suffix="CONNECT_FAILED" value="1">
 139         <tp:docstring>
 140           Connect failed.
 141         </tp:docstring>
 142       </tp:enumvalue>
 143       <tp:enumvalue suffix="BAD_IP_CONFIG" value="2">
 144         <tp:docstring>
 145           Invalid IP configuration returned from the VPN plugin.
 146         </tp:docstring>
 147       </tp:enumvalue>
 148     </tp:enum>
 149
 150   </interface>
 151 </node>