introspection/nm-vpn-connection.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.Connection">
   5     <annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/>
   6
   7     <tp:docstring>
   8       Represents an active connection to a Virtual Private Network.
   9     </tp:docstring>
  10
  11     <signal name="PropertiesChanged">
  12         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
  13             <tp:docstring>
  14                 A dictionary mapping property names to variant boxed values
  15             </tp:docstring>
  16         </arg>
  17     </signal>
  18
  19     <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
  20       <tp:docstring>The VPN-specific state of the connection.</tp:docstring>
  21     </property>
  22     <property name="Banner" type="s" access="read">
  23       <tp:docstring>The banner string of the VPN connection.</tp:docstring>
  24     </property>
  25
  26     <signal name="VpnStateChanged">
  27       <tp:docstring>
  28         Emitted when the state of the VPN connection has changed.
  29       </tp:docstring>
  30       <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
  31         <tp:docstring>
  32           The new state of the VPN connection.
  33         </tp:docstring>
  34       </arg>
  35       <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
  36         <tp:docstring>
  37           Reason code describing the change to the new state.
  38         </tp:docstring>
  39       </arg>
  40     </signal>
  41
  42     <tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
  43       <tp:enumvalue suffix="UNKNOWN" value="0">
  44         <tp:docstring>
  45           The state of the VPN connection is unknown.
  46         </tp:docstring>
  47       </tp:enumvalue>
  48       <tp:enumvalue suffix="PREPARE" value="1">
  49         <tp:docstring>
  50           The VPN connection is preparing to connect.
  51         </tp:docstring>
  52       </tp:enumvalue>
  53       <tp:enumvalue suffix="NEED_AUTH" value="2">
  54         <tp:docstring>
  55           The VPN connection needs authorization credentials.
  56         </tp:docstring>
  57       </tp:enumvalue>
  58       <tp:enumvalue suffix="CONNECT" value="3">
  59         <tp:docstring>
  60           The VPN connection is being established.  FIXME: Should be CONNECTING or CONNECTED.
  61         </tp:docstring>
  62       </tp:enumvalue>
  63       <tp:enumvalue suffix="IP_CONFIG_GET" value="4">
  64         <tp:docstring>
  65           The VPN connection is getting an IP address.  FIXME: Should be an -ING
  66         </tp:docstring>
  67       </tp:enumvalue>
  68       <tp:enumvalue suffix="ACTIVATED" value="5">
  69         <tp:docstring>
  70           The VPN connection is active.
  71         </tp:docstring>
  72       </tp:enumvalue>
  73       <tp:enumvalue suffix="FAILED" value="6">
  74         <tp:docstring>
  75           The VPN connection failed.
  76         </tp:docstring>
  77       </tp:enumvalue>
  78       <tp:enumvalue suffix="DISCONNECTED" value="7">
  79         <tp:docstring>
  80           The VPN connection is disconnected.
  81         </tp:docstring>
  82       </tp:enumvalue>
  83     </tp:enum>
  84     <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
  85       <tp:enumvalue suffix="UNKNOWN" value="0">
  86         <tp:docstring>
  87           The reason for the VPN connection state change is unknown.
  88         </tp:docstring>
  89       </tp:enumvalue>
  90       <tp:enumvalue suffix="NONE" value="1">
  91         <tp:docstring>
  92           No reason was given for the VPN connection state change.
  93         </tp:docstring>
  94       </tp:enumvalue>
  95       <tp:enumvalue suffix="USER_DISCONNECTED" value="2">
  96         <tp:docstring>
  97           The VPN connection changed state because the user disconnected it.
  98         </tp:docstring>
  99       </tp:enumvalue>
 100       <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
 101         <tp:docstring>
 102           The VPN connection changed state because the device it was using was disconnected.
 103         </tp:docstring>
 104       </tp:enumvalue>
 105       <tp:enumvalue suffix="SERVICE_STOPPED" value="4">
 106         <tp:docstring>
 107           The service providing the VPN connection was stopped.
 108         </tp:docstring>
 109       </tp:enumvalue>
 110       <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
 111         <tp:docstring>
 112           The IP config of the VPN connection was invalid.
 113         </tp:docstring>
 114       </tp:enumvalue>
 115       <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
 116         <tp:docstring>
 117           The connection attempt to the VPN service timed out.
 118         </tp:docstring>
 119       </tp:enumvalue>
 120       <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
 121         <tp:docstring>
 122           A timeout occurred while starting the service providing the VPN connection.
 123         </tp:docstring>
 124       </tp:enumvalue>
 125       <tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
 126         <tp:docstring>
 127           Starting the service starting the service providing the VPN connection failed.
 128         </tp:docstring>
 129       </tp:enumvalue>
 130       <tp:enumvalue suffix="NO_SECRETS" value="9">
 131         <tp:docstring>
 132           Necessary secrets for the VPN connection were not provided.
 133         </tp:docstring>
 134       </tp:enumvalue>
 135       <tp:enumvalue suffix="LOGIN_FAILED" value="10">
 136         <tp:docstring>
 137           Authentication to the VPN server failed.
 138         </tp:docstring>
 139       </tp:enumvalue>
 140       <tp:enumvalue suffix="CONNECTION_REMOVED" value="11">
 141         <tp:docstring>
 142           The connection was deleted from settings.
 143         </tp:docstring>
 144       </tp:enumvalue>
 145     </tp:enum>
 146   </interface>
 147 </node>
 148