NetworkManager/introspection/nm-vpn-connection.xml
Lubomir Rintel 618373a14f dbus: use the annotations for documentation
gdbus only understands those (and gtk docstrings, which we should eventually
use) when generating the documentation.
2016-03-26 11:28:19 +01:00

149 lines
6 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.VPN.Connection">
<annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/>
<annotation name="org.gtk.GDBus.DocString" value="
Represents an active connection to a Virtual Private Network.
" />
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
</signal>
<property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
<annotation name="org.gtk.GDBus.DocString" value="The VPN-specific state of the connection." />
</property>
<property name="Banner" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="The banner string of the VPN connection." />
</property>
<signal name="VpnStateChanged">
<annotation name="org.gtk.GDBus.DocString" value="
Emitted when the state of the VPN connection has changed.
" />
<arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
<annotation name="org.gtk.GDBus.DocString" value="
The new state of the VPN connection.
" />
</arg>
<arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
<annotation name="org.gtk.GDBus.DocString" value="
Reason code describing the change to the new state.
" />
</arg>
</signal>
<tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
<annotation name="org.gtk.GDBus.DocString" value="
The state of the VPN connection is unknown.
" />
</tp:enumvalue>
<tp:enumvalue suffix="PREPARE" value="1">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is preparing to connect.
" />
</tp:enumvalue>
<tp:enumvalue suffix="NEED_AUTH" value="2">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection needs authorization credentials.
" />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT" value="3">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED.
" />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CONFIG_GET" value="4">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is getting an IP address. FIXME: Should be an -ING
" />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="5">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is active.
" />
</tp:enumvalue>
<tp:enumvalue suffix="FAILED" value="6">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection failed.
" />
</tp:enumvalue>
<tp:enumvalue suffix="DISCONNECTED" value="7">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is disconnected.
" />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
<annotation name="org.gtk.GDBus.DocString" value="
The reason for the VPN connection state change is unknown.
" />
</tp:enumvalue>
<tp:enumvalue suffix="NONE" value="1">
<annotation name="org.gtk.GDBus.DocString" value="
No reason was given for the VPN connection state change.
" />
</tp:enumvalue>
<tp:enumvalue suffix="USER_DISCONNECTED" value="2">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection changed state because the user disconnected it.
" />
</tp:enumvalue>
<tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
<annotation name="org.gtk.GDBus.DocString" value="
The VPN connection changed state because the device it was using was disconnected.
" />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_STOPPED" value="4">
<annotation name="org.gtk.GDBus.DocString" value="
The service providing the VPN connection was stopped.
" />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
<annotation name="org.gtk.GDBus.DocString" value="
The IP config of the VPN connection was invalid.
" />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
<annotation name="org.gtk.GDBus.DocString" value="
The connection attempt to the VPN service timed out.
" />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
<annotation name="org.gtk.GDBus.DocString" value="
A timeout occurred while starting the service providing the VPN connection.
" />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
<annotation name="org.gtk.GDBus.DocString" value="
Starting the service starting the service providing the VPN connection failed.
" />
</tp:enumvalue>
<tp:enumvalue suffix="NO_SECRETS" value="9">
<annotation name="org.gtk.GDBus.DocString" value="
Necessary secrets for the VPN connection were not provided.
" />
</tp:enumvalue>
<tp:enumvalue suffix="LOGIN_FAILED" value="10">
<annotation name="org.gtk.GDBus.DocString" value="
Authentication to the VPN server failed.
" />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTION_REMOVED" value="11">
<annotation name="org.gtk.GDBus.DocString" value="
The connection was deleted from settings.
" />
</tp:enumvalue>
</tp:enum>
</interface>
</node>