Updated connman to version 1.35
[platform/upstream/connman.git] / doc / vpn-connection-api.txt
old mode 100644 (file)
new mode 100755 (executable)
index 9faed8a..a814a38
@@ -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
@@ -68,6 +75,14 @@ Properties   string State [readonly]
 
                       The VPN host (server) address.
 
+               boolean Immutable [readonly]
+
+                       This value will be set to true if the connection is
+                       configured externally via a configuration file.
+
+                       The only valid operation are Connect(), Disconnect()
+                        and GetProperties()
+
                int Index [readonly]
 
                        The index of the VPN network tunneling interface.
@@ -129,7 +144,8 @@ Properties  string State [readonly]
 
                        string Netmask
 
-                               The netmask of the route.
+                               The netmask of the route. For IPv6 routes,
+                               this is the prefix length.
 
                        string Gateway
 
@@ -151,7 +167,8 @@ Properties  string State [readonly]
 
                        string Netmask
 
-                               The netmask of the route.
+                               The netmask of the route. For IPv6 routes,
+                               this is the prefix length.
 
                        string Gateway