Update the provider related documentation
authorSamuel Ortiz <sameo@linux.intel.com>
Mon, 2 Aug 2010 18:10:13 +0000 (20:10 +0200)
committerSamuel Ortiz <sameo@linux.intel.com>
Mon, 2 Aug 2010 18:10:13 +0000 (20:10 +0200)
doc/manager-api.txt
doc/service-api.txt

index 20ceb70..0f9429b 100644 (file)
@@ -117,6 +117,24 @@ Methods            dict GetProperties()
 
                        Possible Errors: [service].Error.InvalidArguments
 
+               object ConnectProvider(dict provider)
+
+                       Connect to a VPN specified by the given provider
+                       properties.
+
+                       When successful this method will return the object
+                       path of the VPN service object.
+
+                       This method can also be used to connect to an
+                       already existing VPN.
+
+                       This method call will only return in case of an
+                       error or when the service is fully connected. So
+                       setting a longer D-Bus timeout might be a really
+                       good idea.
+
+                       Possible Errors: [service].Error.InvalidArguments
+
                void RegisterAgent(object path)
 
                        Register new agent for handling user requests.
index 29ef96a..0e06da5 100644 (file)
@@ -417,6 +417,16 @@ Properties string State [readonly]
 
                                Automatic proxy configuration URL.
 
+               dict Provider [readonly]
+
+                       string Name [readonly]
+
+                              VPN provider Name.
+
+                       string Type [readonly]
+
+                              VPN provider type.
+
                dict Ethernet [readonly]
 
                        string Method [readonly]