doc: Add description of GetProperties method
authorJukka Rissanen <jukka.rissanen@linux.intel.com>
Tue, 19 Feb 2013 08:45:02 +0000 (10:45 +0200)
committerPatrik Flykt <patrik.flykt@linux.intel.com>
Tue, 19 Feb 2013 12:29:35 +0000 (14:29 +0200)
doc/vpn-connection-api.txt

index 9faed8a4d4cdc4c5ac211e72442deb22f12f15e7..722d70820ccffe757ec58ed4e7caaf7e8ec01ed1 100644 (file)
@@ -5,7 +5,14 @@ Service                net.connman.vpn
 Interface      net.connman.vpn.Connection
 Object path    [variable prefix]/{connection0,connection1,...}
 
-Method         void SetProperty(string name, variant value) [experimental]
+Methods                dict GetProperties()  [experimental]
+
+                       Returns properties for the connection object. See
+                       the properties section for available properties.
+
+                       Possible Errors: [connection].Error.InvalidArguments
+
+               void SetProperty(string name, variant value) [experimental]
 
                        Changes the value of the specified property. Only
                        properties that are listed as read-write are