X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fagent-api.txt;h=8201ac159d79c224ba739fea99d5948e0162b712;hb=64be8612c32703d48da4c9f68fff888cb4ac1164;hp=7ba3d5635463a2684b5af7643859a0cf8e8bdd7e;hpb=bb1715de71ae992128c99ffad15e15d5168a2e1f;p=framework%2Fconnectivity%2Fconnman.git

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index 7ba3d56..8201ac1 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -32,7 +32,7 @@ Methods		void Release()
 			This can happen if connected to a hotspot portal
 			page without WISPr support.
 
-			Possible Errors: net.connman.Agent.Error.Retry
+			Possible Errors: net.connman.Agent.Error.Canceled
 
 		dict RequestInput(object service, dict fields)
 
@@ -51,7 +51,12 @@ Methods		void Release()
 			The dictionary arguments contains field names with
 			their input parameters.
 
+			In case of WISPr credentials requests and if the user
+			prefers to login through the browser by himself, agent
+			will have to return a LaunchBrowser error (see below).
+
 			Possible Errors: net.connman.Agent.Error.Canceled
+					 net.connman.Agent.Error.LaunchBrowser
 
 		void Cancel()
 
@@ -82,6 +87,15 @@ Fields		string Name
 			key, a PSK passphrase or a passphrase for EAP
 			authentication methods.
 
+		string PreviousPassphrase
+
+			The previous passphrase successfully saved, i.e.
+			which lead to a successfull connection. This field is
+			provided as an informational argument when connecting
+			with it does not work anymore, for instance when it
+			has been changed on the AP. Such argument appears when
+			a RequestInput is raised after a retry.
+
 		string WPS
 
 			This field requests the use of WPS to get associated.
@@ -104,8 +118,9 @@ Fields		string Name
 Arguments	string Type
 
 			Contains the type of a field. For example "psk", "wep"
-			"passphrase", "response", "ssid", "wpspin" or plain
-			"string".
+			"informational", "passphrase", "response", "ssid",
+			"wpspin" or plain "string". "informational" has no
+			"Requirement" but a "Value".
 
 		string Requirement
 
@@ -124,15 +139,32 @@ Arguments	string Type
 			Contains the list of alternate field names this
 			field can be represented by.
 
+		string Value
+
+			Contains data as a string, relatively to an
+			"informational" argument.
+
 Examples	Requesting a passphrase for WPA2 network
 
 			RequestInput("/service1",
-				{ "Passphrase" : { "Type" : "psk",
+				{ "Passphrase" : { "Type"        : "psk",
 						   "Requirement" : "mandatory"
 						 }
 				}
 			==> { "Passphrase" : "secret123" }
 
+		Requesting a passphrase after an error on the previous one:
+
+			RequestInput("/service1",
+				{ "Passphrase" : { "Type"        : "psk",
+						   "Requirement" : "mandatory"
+						 },
+				  "PreviousPassphrase" :
+						{ "Type"  : "informational",
+						  "Value" : "secret123"
+						}
+				}
+
 		Requesting name for hidden network
 
 			RequestInput("/service2",
@@ -140,9 +172,9 @@ Examples	Requesting a passphrase for WPA2 network
 					     "Requirement" : "mandatory",
 					     "Alternates"  : [ "SSID" ]
 					   },
-				  "SSID" : { "Type" : "ssid",
-				             "Requirement" : "alternate"
-				           }
+				  "SSID" : { "Type"        : "ssid",
+					     "Requirement" : "alternate"
+					   }
 				}
 			==> { "Name" : "My hidden network" }
 
@@ -154,7 +186,7 @@ Examples	Requesting a passphrase for WPA2 network
 						   "Alternates"  : [ "WPS" ]
 						 },
 				  "WPS"        : { "Type"        : "wpspin",
-				                   "Requirement" : "alternate"
+						   "Requirement" : "alternate"
 						 }
 				}
 
@@ -166,7 +198,7 @@ Examples	Requesting a passphrase for WPA2 network
 				{ "Identity"   : { "Type"        : "string",
 						   "Requirement" : "mandatory"
 						 },
-				  "Passphrase" : { "Type" : "passphrase",
+				  "Passphrase" : { "Type"        : "passphrase",
 						   "Requirement" : "mandatory"
 						 }
 				}
@@ -179,7 +211,7 @@ Examples	Requesting a passphrase for WPA2 network
 				{ "Identity"   : { "Type"        : "string",
 						   "Requirement" : "mandatory"
 						 },
-				  "Passphrase" : { "Type" : "response",
+				  "Passphrase" : { "Type"        : "response",
 						   "Requirement" : "mandatory"
 						 }
 				}
@@ -189,12 +221,12 @@ Examples	Requesting a passphrase for WPA2 network
 		Requesting username and password for a WISPr-enabled hotspot:
 
 			RequestInput("/service5",
-                                { "Username"   : { "Type"        : "string",
-                                                   "Requirement" : "mandatory"
-                                                 },
-                                  "Password"   : { "Type"        : "passphrase",
-                                                   "Requirement" : "mandatory"
-                                                 }
-                                }
-
-                        ==> { "Username" : "foo", "Password": "secret" }
+				{ "Username"   : { "Type"        : "string",
+						   "Requirement" : "mandatory"
+						 },
+				  "Password"   : { "Type"        : "passphrase",
+						   "Requirement" : "mandatory"
+						 }
+				}
+
+			==> { "Username" : "foo", "Password": "secret" }