dbus/introspection/org.freedesktop.NetworkManager.VPN.Plugin.xml

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <node name="/">
0003
0004   <!--
0005       org.freedesktop.NetworkManager.VPN.Plugin:
0006
0007       This interface is provided by plugins providing VPN services to the
0008       NetworkManager daemon.
0009   -->
0010   <interface name="org.freedesktop.NetworkManager.VPN.Plugin">
0011     <annotation name="org.gtk.GDBus.C.Name" value="VpnPlugin"/>
0012
0013     <!--
0014         Connect:
0015         @connection: Describes the connection to be established.
0016
0017         Tells the plugin to connect. Interactive secrets requests (eg, emitting
0018         the SecretsRequired signal) are not allowed.
0019     -->
0020     <method name="Connect">
0021       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/>
0022       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0023       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0024     </method>
0025
0026     <!--
0027         ConnectInteractive:
0028         @connection: Describes the connection to be established.
0029         @details: Additional details about the Connect process.
0030
0031         Tells the plugin to connect, allowing interactive secrets requests (eg the
0032         plugin is allowed to emit the SecretsRequired signal if the VPN service
0033         indicates that it needs additional secrets during the connect process).
0034     -->
0035     <method name="ConnectInteractive">
0036       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect_interactive"/>
0037       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0038       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0039       <annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="NMVariantMap"/>
0040       <arg name="details" type="a{sv}" direction="in"/>
0041     </method>
0042
0043     <!--
0044         NeedSecrets:
0045         @settings: Describes the connection that may need secrets.
0046         @setting_name: The setting name within the provided connection that requires secrets, if any.
0047
0048         Asks the plugin whether the provided connection will require secrets to
0049         connect successfully.
0050     -->
0051     <method name="NeedSecrets">
0052       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/>
0053       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0054       <arg name="settings" type="a{sa{sv}}" direction="in"/>
0055       <arg name="setting_name" type="s" direction="out"/>
0056     </method>
0057
0058     <!--
0059         Disconnect:
0060
0061         Disconnect the plugin.
0062     -->
0063     <method name="Disconnect">
0064       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/>
0065     </method>
0066
0067     <!--
0068         SetConfig:
0069         @config: Generic configuration details for the connection.
0070
0071         Set generic connection details on the connection.
0072     -->
0073     <method name="SetConfig">
0074       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_config"/>
0075       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0076       <arg name="config" type="a{sv}" direction="in"/>
0077     </method>
0078
0079     <!--
0080         SetIp4Config:
0081         @config: Ip4Config details for the connection. You must call SetConfig() before calling this.
0082
0083         Set IPv4 details on the connection.
0084     -->
0085     <method name="SetIp4Config">
0086       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/>
0087       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0088       <arg name="config" type="a{sv}" direction="in"/>
0089     </method>
0090
0091     <!--
0092         SetIp6Config:
0093         @config: Ip6Config details for the connection. You must call SetConfig() before calling this.
0094
0095         Set IPv6 details on the connection.
0096     -->
0097     <method name="SetIp6Config">
0098       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip6_config"/>
0099       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0100       <arg name="config" type="a{sv}" direction="in"/>
0101     </method>
0102
0103     <!--
0104         SetFailure:
0105         @reason: The reason for the failure.
0106
0107         Indicate a failure to the plugin.
0108     -->
0109     <method name="SetFailure">
0110       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/>
0111       <arg name="reason" type="s" direction="in"/>
0112     </method>
0113
0114     <!--
0115         State:
0116
0117         The state of the plugin.
0118
0119         Returns: <link linkend="NMVpnServiceState">NMVpnServiceState</link>
0120     -->
0121     <property name="State" type="u" access="read"/>
0122
0123     <!--
0124         StateChanged:
0125         @state: (<link linkend="NMVpnServiceState">NMVpnServiceState</link>) The new state of the plugin.
0126
0127         Emitted when the plugin state changes.
0128     -->
0129     <signal name="StateChanged">
0130       <arg name="state" type="u"/>
0131     </signal>
0132
0133     <!--
0134         SecretsRequired:
0135         @message: 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.
0136         @secrets: 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.
0137
0138         Emitted during an ongoing ConnectInteractive() request when the plugin has
0139         determined that new secrets are required. NetworkManager will then call
0140         the NewSecrets() method with a connection hash including the new secrets.
0141     -->
0142     <signal name="SecretsRequired">
0143       <arg name="message" type="s" direction="out"/>
0144       <arg name="secrets" type="as" direction="out"/>
0145     </signal>
0146
0147     <!--
0148         NewSecrets:
0149         @connection: Describes the connection including the new secrets.
0150
0151         Called in response to a SecretsRequired signal to deliver updated secrets
0152         or other information to the plugin.
0153     -->
0154     <method name="NewSecrets">
0155       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_new_secrets"/>
0156       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0157       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0158     </method>
0159
0160     <!--
0161         Config:
0162         @config: The configuration information.
0163
0164         The plugin obtained generic configuration information.
0165     -->
0166     <signal name="Config">
0167       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0168       <arg name="config" type="a{sv}"/>
0169     </signal>
0170
0171     <!--
0172         Ip4Config:
0173         @ip4config: The IPv4 configuration.
0174
0175         The plugin obtained an IPv4 configuration.
0176     -->
0177     <signal name="Ip4Config">
0178       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0179       <arg name="ip4config" type="a{sv}"/>
0180     </signal>
0181
0182     <!--
0183         Ip6Config:
0184         @ip6config: The IPv6 configuration.
0185
0186         The plugin obtained an IPv6 configuration.
0187     -->
0188     <signal name="Ip6Config">
0189       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMap"/>
0190       <arg name="ip6config" type="a{sv}"/>
0191     </signal>
0192
0193     <!--
0194         LoginBanner:
0195         @banner: The login banner string.
0196
0197         Emitted when the plugin receives a login banner from the VPN service.
0198     -->
0199     <signal name="LoginBanner">
0200       <arg name="banner" type="s"/>
0201     </signal>
0202
0203     <!--
0204         Failure:
0205         @reason: (<link linkend="NMVpnPluginFailure">NMVpnPluginFailure</link>) Reason code for the failure.
0206
0207         Emitted when a failure in the VPN plugin occurs.
0208     -->
0209     <signal name="Failure">
0210       <arg name="reason" type="u"/>
0211     </signal>
0212   </interface>
0213 </node>