X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fvpn-connection-api.txt;h=ec557889aa14900a48c1809d9e8fc2688c46c23f;hb=c647a4b6f1132684c9d8b8ad71ec38d81147b278;hp=a814a3880caef77b2cc1b63d4b90876ded210012;hpb=30602f521a85820a9f6b7ac04876400e00c68b15;p=platform%2Fupstream%2Fconnman.git

diff --git a/doc/vpn-connection-api.txt b/doc/vpn-connection-api.txt
index a814a38..ec55788 100755
--- a/doc/vpn-connection-api.txt
+++ b/doc/vpn-connection-api.txt
@@ -14,13 +14,48 @@ Methods		dict GetProperties()  [experimental]
 
 		void SetProperty(string name, variant value) [experimental]
 
-			Changes the value of the specified property. Only
-			properties that are listed as read-write are
-			changeable. On success a PropertyChanged signal
-			will be emitted.
+			Changes the value of the specified property or the
+			properties defined as a dict passed as variant, where
+			the format is equal to the dict returned by
+			GetProperties(). Only properties that are listed as
+			read-write are changeable. Property name "Properties"
+			indicates a dict of properties. On success a
+			PropertyChanged signal will be emitted for the
+			specified property or for all changed properties
+			individually. If there is no change in property value
+			no PropertyChanged signal is sent. Configuration is
+			written to disk when one or more values are changed.
+			In case a dict of properties are given, configuration
+			write is done after all properties are processed.
+			Specifics in dict use in contrast to setting a single
+			property:
+				- Dict can contain values set as empty strings
+				  or arrays. This causes the values to be
+				  cleared as if using ClearProperty().
+				- If there are errors with the properties,
+				  InvalidProperty or PermissionDenied error is
+				  returned. InvalidProperty is sent when there
+				  is at least one invalid property, in this
+				  case there can be also properties that
+				  cannot be changed (immutable properties).
+				  If there are only immutable properties
+				  PermissionDenied error is returned.
+				- The properties that are invalid or immutable
+				  are reported back at the end of the error
+				  message as a comma separated property name
+				  list.
+				- One invalid/immutable property does not
+				  cause the rest of the properties to be
+				  ignored. If there are valid and invalid
+				  properties, the valid properties emit
+				  PropertyChanged signal and invalid are
+				  reported back with an InvalidProperty
+				  message.
 
 			Possible Errors: [connection].Error.InvalidArguments
 					 [connection].Error.InvalidProperty
+					 [connection].Error.PermissionDenied
+					 [connection].Error.NotSupported
 
 		void ClearProperty(string name) [experimental]
 
@@ -28,6 +63,7 @@ Methods		dict GetProperties()  [experimental]
 
 			Possible Errors: [connection].Error.InvalidArguments
 					 [connection].Error.InvalidProperty
+					 [connection].Error.PermissionDenied
 
 		void Connect() [experimental]
 
@@ -39,6 +75,19 @@ Methods		dict GetProperties()  [experimental]
 			Possible Errors: [connection].Error.InvalidArguments
 					[connection].Error.InProgress
 
+		void Connect2(string dbus_sender) [experimental]
+
+			Connect this VPN connection. The Connect2() is a
+			wrapper for Connect() allowing to pass original D-Bus
+			sender when proxying the connection request. The
+			Connect2() will wait until the connection is created or
+			there is an error. The error description is returned in
+			dbus error.
+
+			Possible Errors: [connection].Error.InvalidArguments
+					[connection].Error.InProgress
+
+
 		void Disconnect() [experimental]
 
 			Disconnect this VPN connection. If the connection is
@@ -136,7 +185,9 @@ Properties	string State [readonly]
 			int ProtocolFamily
 
 				Protocol family of the route. Set to 4
-				if IPv4 and 6 if IPv6 route.
+				if IPv4 and 6 if IPv6 route. Set to 0
+				(PF_UNSPEC) or omit, to have it assigned
+				automatically.
 
 			string Network