summary refs log tree commit diff
path: root/introspection/nm-vpn-connection.xml
diff options
context:
space:
mode:
Diffstat (limited to 'introspection/nm-vpn-connection.xml')
-rw-r--r--introspection/nm-vpn-connection.xml168
1 files changed, 168 insertions, 0 deletions
diff --git a/introspection/nm-vpn-connection.xml b/introspection/nm-vpn-connection.xml
new file mode 100644
index 00000000..3a47cdf1
--- /dev/null
+++ b/introspection/nm-vpn-connection.xml
@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+
+<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
+  <interface name="org.freedesktop.NetworkManager.Connection.Active">
+    <property name="ServiceName" type="s" access="read">
+      <tp:docstring>The D-Bus service name providing this connection.</tp:docstring>
+    </property>
+    <property name="Connection" type="o" access="read">
+      <tp:docstring>The path of the connection.</tp:docstring>
+    </property>
+    <property name="SpecificObject" type="o" access="read">
+      <tp:docstring>A specific object associated with the active connection.</tp:docstring>
+    </property>
+    <property name="Devices" type="ao" access="read">
+      <tp:docstring>Array of object paths representing devices which are part of this active connection.</tp:docstring>
+    </property>
+    <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
+      <tp:docstring>The state of this active connection.</tp:docstring>
+    </property>
+    <property name="Default" type="b" access="read">
+      <tp:docstring>Whether this active connection is the default connection, i.e. whether it currently owns the default route.</tp:docstring>
+    </property>
+    <property name="Vpn" type="b" access="read">
+      <tp:docstring>Whether this active connection is also a VPN connection.</tp:docstring>
+    </property>
+
+    <signal name="PropertiesChanged">
+        <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
+            <tp:docstring>
+                A dictionary mapping property names to variant boxed values
+            </tp:docstring>
+        </arg>
+    </signal>
+  </interface>
+
+  <interface name="org.freedesktop.NetworkManager.VPN.Connection">
+    <tp:docstring>
+      Represents an active connection to a Virtual Private Network.
+    </tp:docstring>
+
+    <signal name="PropertiesChanged">
+        <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
+            <tp:docstring>
+                A dictionary mapping property names to variant boxed values
+            </tp:docstring>
+        </arg>
+    </signal>
+
+    <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
+      <tp:docstring>The VPN-specific state of the connection.</tp:docstring>
+    </property>
+    <property name="Banner" type="s" access="read">
+      <tp:docstring>The banner string of the VPN connection.</tp:docstring>
+    </property>
+
+    <signal name="VpnStateChanged">
+      <tp:docstring>
+        Emitted when the state of the VPN connection has changed.
+      </tp:docstring>
+      <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
+        <tp:docstring>
+          The new state of the VPN connection.
+        </tp:docstring>
+      </arg>
+      <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
+        <tp:docstring>
+          Reason code describing the change to the new state.
+        </tp:docstring>
+      </arg>
+    </signal>
+
+    <tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
+      <tp:enumvalue suffix="UNKNOWN" value="0">
+        <tp:docstring>
+          The state of the VPN connection is unknown.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="PREPARE" value="1">
+        <tp:docstring>
+          The VPN connection is preparing to connect.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="NEED_AUTH" value="2">
+        <tp:docstring>
+          The VPN connection needs authorization credentials.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="CONNECT" value="3">
+        <tp:docstring>
+          The VPN connection is being established.  FIXME: Should be CONNECTING or CONNECTED.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="IP_CONFIG_GET" value="4">
+        <tp:docstring>
+          The VPN connection is getting an IP address.  FIXME: Should be an -ING 
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="ACTIVATED" value="5">
+        <tp:docstring>
+          The VPN connection is active.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="FAILED" value="6">
+        <tp:docstring>
+          The VPN connection failed.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="DISCONNECTED" value="7">
+        <tp:docstring>
+          The VPN connection is disconnected.
+        </tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+    <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
+      <tp:enumvalue suffix="UNKNOWN" value="0">
+        <tp:docstring>
+          The reason for the VPN connection state change is unknown.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="NONE" value="1">
+        <tp:docstring>
+          No reason was given for the VPN connection state change.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="USER_DISCONNECTED" value="2">
+        <tp:docstring>
+          The VPN connection changed state because the user disconnected it.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
+        <tp:docstring>
+          The VPN connection changed state because the device it was using was disconnected.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="SERVICE_STOPPED" value="4">
+        <tp:docstring>
+          The service providing the VPN connection was stopped.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
+        <tp:docstring>
+          The IP config of the VPN connection was invalid.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
+        <tp:docstring>
+          The connection attempt to the VPN service timed out.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
+        <tp:docstring>
+          A timeout occurred while starting the service providing the VPN connection.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
+        <tp:docstring>
+          Starting the service starting the service providing the VPN connection failed.
+        </tp:docstring>
+      </tp:enumvalue>
+      <tp:enumvalue suffix="NO_SECRETS" value="9">
+        <tp:docstring>
+          Necessary secrets for the VPN connection were not provided.
+        </tp:docstring>
+      </tp:enumvalue>
+    </tp:enum>
+  </interface>
+</node>
+