<interface name="org.freedesktop.NetworkManager.VPN.Plugin">
<annotation name="org.gtk.GDBus.C.Name" value="VpnPlugin"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
This interface is provided by plugins providing VPN services to the NetworkManager daemon.
- </tp:docstring>
+ " />
<method name="Connect">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tells the plugin to connect. Interactive secrets requests (eg, emitting
the SecretsRequired signal) are not allowed.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection to be established.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
</method>
<method name="ConnectInteractive">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tells the plugin to connect, allowing interactive secrets requests (eg
the plugin is allowed to emit the SecretsRequired signal if the VPN
service indicates that it needs additional secrets during the connect
process).
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect_interactive"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection to be established.
- </tp:docstring>
+ " />
</arg>
<arg name="details" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Additional details about the Connect process.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
</method>
<method name="NeedSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Asks the plugin whether the provided connection will require secrets to connect successfully.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/>
<arg name="settings" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection that may need secrets.
- </tp:docstring>
+ " />
</arg>
<arg name="setting_name" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The setting name within the provided connection that requires secrets, if any.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/>
</method>
<method name="Disconnect">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Disconnect the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
</method>
<method name="SetConfig">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set generic connection details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Generic configuration details for the connection.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetIp4Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set IPv4 details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Ip4Config details for the connection. You must call
SetConfig() before calling this.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetIp6Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set IPv6 details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip6_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Ip6Config details for the connection. You must call
SetConfig() before calling this.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetFailure">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicate a failure to the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/>
<arg name="reason" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The reason for the failure.
- </tp:docstring>
+ " />
</arg>
</method>
<property name="State" type="u" access="read" tp:type="NM_VPN_SERVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of the plugin.
- </tp:docstring>
+ " />
</property>
<signal name="StateChanged">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the plugin state changes.
- </tp:docstring>
+ " />
<arg name="state" type="u" tp:type="NM_VPN_SERVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The new state of the plugin.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="SecretsRequired">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted during an ongoing ConnectInteractive() request when the plugin
has determined that new secrets are required. NetworkManager will then
call the NewSecrets() method with a connection hash including the new
secrets.
- </tp:docstring>
+ " />
<arg name="message" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Informational message, if any, about the request. For example, if
a second PIN is required, could indicate to the user to wait for
the token code to change until entering the next PIN.
- </tp:docstring>
+ " />
</arg>
<arg name="secrets" type="as" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of strings of VPN secret names which the plugin thinks
secrets may be required for, or other VPN-specific data to be
processed by the VPN's front-end.
- </tp:docstring>
+ " />
</arg>
</signal>
<method name="NewSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Called in response to a SecretsRequired signal to deliver updated secrets
or other information to the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_new_secrets"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection including the new secrets.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/>
</method>
<signal name="Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained generic configuration information.
- </tp:docstring>
+ " />
<arg name="config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The configuration information.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Ip4Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained an IPv4 configuration.
- </tp:docstring>
+ " />
<arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IPv4 configuration.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Ip6Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained an IPv6 configuration.
- </tp:docstring>
+ " />
<arg name="ip6config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IPv6 configuration.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="LoginBanner">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the plugin receives a login banner from the VPN service.
- </tp:docstring>
+ " />
<arg name="banner" type="s">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The login banner string.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Failure">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a failure in the VPN plugin occurs.
- </tp:docstring>
+ " />
<arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Reason code for the failure.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_VPN_SERVICE_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of the VPN plugin is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="INIT" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN plugin is initialized.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SHUTDOWN" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
(Not used.)
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STARTING" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is attempting to connect to a VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STARTED" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin has connected to a VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STOPPING" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is disconnecting from the VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STOPPED" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin has disconnected from the VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u">
<tp:enumvalue suffix="LOGIN_FAILED" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Login failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT_FAILED" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connect failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BAD_IP_CONFIG" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Invalid IP configuration returned from the VPN plugin.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
projects / NetworkManager.git / blobdiff