From cb39febef3587c749e5b818009204b61dd7c970a Mon Sep 17 00:00:00 2001 From: Samuel Ortiz Date: Mon, 2 Aug 2010 20:10:13 +0200 Subject: [PATCH] Update the provider related documentation --- doc/manager-api.txt | 18 ++++++++++++++++++ doc/service-api.txt | 10 ++++++++++ 2 files changed, 28 insertions(+) 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] -- 2.7.4