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