From 6accbd3ec0e42d8633bbde4d47ed7bfe854e7e0b Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 12 Aug 2022 19:21:11 +0200 Subject: New upstream version 1.38.4 --- ...s-org.freedesktop.NetworkManager.VPN.Plugin.xml | 145 ++++++++++++++------- 1 file changed, 100 insertions(+), 45 deletions(-) (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml') diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml index 5604099d..0efccfe7 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.VPN.Plugin.xml @@ -42,8 +42,9 @@ Description - This interface is provided by plugins providing VPN services to the - NetworkManager daemon. + +This interface is provided by plugins providing VPN services to the +NetworkManager daemon. @@ -54,13 +55,16 @@ Connect (IN a{sa{sv}} connection); - Tells the plugin to connect. Interactive secrets requests (eg, emitting - the SecretsRequired signal) are not allowed. + +Tells the plugin to connect. Interactive secrets requests (eg, emitting +the SecretsRequired signal) are not allowed. IN a{sa{sv}} connection: - Describes the connection to be established. + +Describes the connection to be established. + @@ -71,18 +75,23 @@ Connect (IN a{sa{sv}} connection); ConnectInteractive (IN a{sa{sv}} connection, IN a{sv} details); - 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). + +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). IN a{sa{sv}} connection: - Describes the connection to be established. + +Describes the connection to be established. + IN a{sv} details: - Additional details about the Connect process. + +Additional details about the Connect process. + @@ -93,17 +102,22 @@ ConnectInteractive (IN a{sa{sv}} connection, NeedSecrets (IN a{sa{sv}} settings, OUT s setting_name); - Asks the plugin whether the provided connection will require secrets to - connect successfully. + +Asks the plugin whether the provided connection will require secrets to +connect successfully. IN a{sa{sv}} settings: - Describes the connection that may need secrets. + +Describes the connection that may need secrets. + OUT s setting_name: - The setting name within the provided connection that requires secrets, if any. + +The setting name within the provided connection that requires secrets, if any. + @@ -113,7 +127,8 @@ NeedSecrets (IN a{sa{sv}} settings, Disconnect (); - Disconnect the plugin. + +Disconnect the plugin. @@ -122,12 +137,15 @@ Disconnect (); SetConfig (IN a{sv} config); - Set generic connection details on the connection. + +Set generic connection details on the connection. IN a{sv} config: - Generic configuration details for the connection. + +Generic configuration details for the connection. + @@ -137,12 +155,15 @@ SetConfig (IN a{sv} config); SetIp4Config (IN a{sv} config); - Set IPv4 details on the connection. + +Set IPv4 details on the connection. IN a{sv} config: - Ip4Config details for the connection. You must call SetConfig() before calling this. + +Ip4Config details for the connection. You must call SetConfig() before calling this. + @@ -152,12 +173,15 @@ SetIp4Config (IN a{sv} config); SetIp6Config (IN a{sv} config); - Set IPv6 details on the connection. + +Set IPv6 details on the connection. IN a{sv} config: - Ip6Config details for the connection. You must call SetConfig() before calling this. + +Ip6Config details for the connection. You must call SetConfig() before calling this. + @@ -167,12 +191,15 @@ SetIp6Config (IN a{sv} config); SetFailure (IN s reason); - Indicate a failure to the plugin. + +Indicate a failure to the plugin. IN s reason: - The reason for the failure. + +The reason for the failure. + @@ -182,13 +209,16 @@ SetFailure (IN s reason); NewSecrets (IN a{sa{sv}} connection); - Called in response to a SecretsRequired signal to deliver updated secrets - or other information to the plugin. + +Called in response to a SecretsRequired signal to deliver updated secrets +or other information to the plugin. IN a{sa{sv}} connection: - Describes the connection including the new secrets. + +Describes the connection including the new secrets. + @@ -201,12 +231,15 @@ NewSecrets (IN a{sa{sv}} connection); StateChanged (u state); - Emitted when the plugin state changes. + +Emitted when the plugin state changes. u state: - (NMVpnServiceState) The new state of the plugin. + +(NMVpnServiceState) The new state of the plugin. + @@ -217,18 +250,23 @@ StateChanged (u state); SecretsRequired (s message, as secrets); - 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. + +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. s 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. + +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. + as 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. + +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. + @@ -238,12 +276,15 @@ SecretsRequired (s message, Config (a{sv} config); - The plugin obtained generic configuration information. + +The plugin obtained generic configuration information. a{sv} config: - The configuration information. + +The configuration information. + @@ -253,12 +294,15 @@ Config (a{sv} config); Ip4Config (a{sv} ip4config); - The plugin obtained an IPv4 configuration. + +The plugin obtained an IPv4 configuration. a{sv} ip4config: - The IPv4 configuration. + +The IPv4 configuration. + @@ -268,12 +312,15 @@ Ip4Config (a{sv} ip4config); Ip6Config (a{sv} ip6config); - The plugin obtained an IPv6 configuration. + +The plugin obtained an IPv6 configuration. a{sv} ip6config: - The IPv6 configuration. + +The IPv6 configuration. + @@ -283,12 +330,15 @@ Ip6Config (a{sv} ip6config); LoginBanner (s banner); - Emitted when the plugin receives a login banner from the VPN service. + +Emitted when the plugin receives a login banner from the VPN service. s banner: - The login banner string. + +The login banner string. + @@ -298,12 +348,15 @@ LoginBanner (s banner); Failure (u reason); - Emitted when a failure in the VPN plugin occurs. + +Emitted when a failure in the VPN plugin occurs. u reason: - (NMVpnPluginFailure) Reason code for the failure. + +(NMVpnPluginFailure) Reason code for the failure. + @@ -316,8 +369,10 @@ Failure (u reason); State readable u - The state of the plugin. - Returns: NMVpnServiceState + +The state of the plugin. + +Returns: NMVpnServiceState -- cgit 1.3.0-6-gf8a5