From 2bfb3eb7d0323e69affca154395f51d8b577414d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 6 Apr 2016 00:46:19 +0200 Subject: Imported Upstream version 1.1.93 --- ...-org.freedesktop.NetworkManager.VPN.Plugin.html | 94 ++++++++++++++-------- 1 file changed, 61 insertions(+), 33 deletions(-) (limited to 'docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html') diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html index 64517b2c..bc21c67c 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.VPN.Plugin.html @@ -70,16 +70,20 @@

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. +

Method Details

-

The Connect() method

+

The Connect() method

 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. +

@@ -93,12 +97,15 @@ Connect (IN a{sa{sv}} connection);
-

The ConnectInteractive() method

+

The ConnectInteractive() method

 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). +

@@ -118,12 +125,14 @@ ConnectInteractive (IN a{sa{sv}} connection,
-

The NeedSecrets() method

+

The NeedSecrets() method

 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. +

@@ -143,19 +152,21 @@ NeedSecrets (IN a{sa{sv}} settings,
-

The Disconnect() method

+

The Disconnect() method

 Disconnect ();
-

Disconnect the plugin.

+

Disconnect the plugin. +

-

The SetConfig() method

+

The SetConfig() method

 SetConfig (IN  a{sv} config);
-

Set generic connection details on the connection.

+

Set generic connection details on the connection. +

@@ -169,11 +180,12 @@ SetConfig (IN a{sv} config);
-

The SetIp4Config() method

+

The SetIp4Config() method

 SetIp4Config (IN  a{sv} config);
-

Set IPv4 details on the connection.

+

Set IPv4 details on the connection. +

@@ -181,17 +193,18 @@ SetIp4Config (IN a{sv} config); - +

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.
-

The SetIp6Config() method

+

The SetIp6Config() method

 SetIp6Config (IN  a{sv} config);
-

Set IPv6 details on the connection.

+

Set IPv6 details on the connection. +

@@ -199,17 +212,18 @@ SetIp6Config (IN a{sv} config); - +

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.
-

The SetFailure() method

+

The SetFailure() method

 SetFailure (IN  s reason);
-

Indicate a failure to the plugin.

+

Indicate a failure to the plugin. +

@@ -223,11 +237,13 @@ SetFailure (IN s reason);
-

The NewSecrets() method

+

The NewSecrets() method

 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. +

@@ -247,7 +263,8 @@ NewSecrets (IN a{sa{sv}} connection); 
 StateChanged (u state);
-

Emitted when the plugin state changes.

+

Emitted when the plugin state changes. +

@@ -255,7 +272,7 @@ StateChanged (u state); - +

u state:

The new state of the plugin.

(NMVpnServiceState) The new state of the plugin.
@@ -266,7 +283,10 @@ 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. +

@@ -275,11 +295,11 @@ SecretsRequired (s message, - + - +

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.
@@ -290,7 +310,8 @@ SecretsRequired (s message, 
 Config (a{sv} config);
-

The plugin obtained generic configuration information.

+

The plugin obtained generic configuration information. +

@@ -308,7 +329,8 @@ Config (a{sv} config); 
 Ip4Config (a{sv} ip4config);
-

The plugin obtained an IPv4 configuration.

+

The plugin obtained an IPv4 configuration. +

@@ -326,7 +348,8 @@ Ip4Config (a{sv} ip4config); 
 Ip6Config (a{sv} ip6config);
-

The plugin obtained an IPv6 configuration.

+

The plugin obtained an IPv6 configuration. +

@@ -344,7 +367,8 @@ 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. +

@@ -362,7 +386,8 @@ LoginBanner (s banner); 
 Failure (u reason);
-

Emitted when a failure in the VPN plugin occurs.

+

Emitted when a failure in the VPN plugin occurs. +

@@ -370,7 +395,7 @@ Failure (u reason); - +

u reason:

Reason code for the failure.

(NMVpnPluginFailure) Reason code for the failure.
@@ -382,7 +407,10 @@ Failure (u reason); 
 State  readable   u
-

The state of the plugin.

+

The state of the plugin. +

+

Returns: NMVpnServiceState +

-- cgit 1.3.0-6-gf8a5