summaryrefslogtreecommitdiff
path: root/doc/manager-api.txt
diff options
context:
space:
mode:
authorMarcel Holtmann <marcel@holtmann.org>2009-07-16 12:02:28 +0200
committerMarcel Holtmann <marcel@holtmann.org>2009-07-16 12:02:28 +0200
commitfa1d7b70dfa10b7af44909573e9c59f9c538850b (patch)
treefa52a84445247e830ade7f75a2e65a8e376a6b62 /doc/manager-api.txt
parenteb95dabb34e70d91d2e0197b7670c366075191e0 (diff)
downloadconnman-fa1d7b70dfa10b7af44909573e9c59f9c538850b.tar.gz
connman-fa1d7b70dfa10b7af44909573e9c59f9c538850b.tar.bz2
connman-fa1d7b70dfa10b7af44909573e9c59f9c538850b.zip
Add documentation for the ConnectService method call
Diffstat (limited to 'doc/manager-api.txt')
-rw-r--r--doc/manager-api.txt19
1 files changed, 19 insertions, 0 deletions
diff --git a/doc/manager-api.txt b/doc/manager-api.txt
index bd42f9cc..f6f2f9f2 100644
--- a/doc/manager-api.txt
+++ b/doc/manager-api.txt
@@ -53,6 +53,25 @@ Methods dict GetProperties()
Possible Errors: [service].Error.InvalidArguments
+ object ConnectService(dict network)
+
+ Connect to a network specified by the given
+ properties.
+
+ For connecting to a hidden WiFi network for example
+ it is required that Type = "wifi" and the SSID
+ properties are provided.
+
+ When successful this method will return object
+ path of the service object.
+
+ This method can also be used to connect to an
+ already existing service. It works exactly the
+ same as executing the Connect method from the
+ service interface.
+
+ Possible Errors: [service].Error.InvalidArguments
+
void RegisterAgent(object path)
Register new agent for handling user requests.