summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Ortiz <sameo@linux.intel.com>2010-08-02 18:10:13 (GMT)
committerSamuel Ortiz <sameo@linux.intel.com>2010-08-02 18:10:13 (GMT)
commitcb39febef3587c749e5b818009204b61dd7c970a (patch)
tree2bb018c42353d485804cc72c1ccc90ce2ccc528c
parentf05865b22811d7a7308f71f34a9971034e4f826b (diff)
downloadconnman-cb39febef3587c749e5b818009204b61dd7c970a.zip
connman-cb39febef3587c749e5b818009204b61dd7c970a.tar.gz
connman-cb39febef3587c749e5b818009204b61dd7c970a.tar.bz2
Update the provider related documentation
-rw-r--r--doc/manager-api.txt18
-rw-r--r--doc/service-api.txt10
2 files changed, 28 insertions, 0 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index 20ceb70..0f9429b 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -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.
diff --git a/doc/service-api.txt b/doc/service-api.txt
index 29ef96a..0e06da5 100644
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -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]