X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fagent-api.txt;h=2ddd19a63d76f53ab4827664d87dde5fabe49f7c;hb=bcae74da8fa2958b3fec9153fc33e41f0e0317bf;hp=a98343fe5eed7c2eef8a879e1f0764d29123308b;hpb=1b9d0a62f59bb48c8deb2f0b98d9acdffdd9abe7;p=platform%2Fupstream%2Fconnman.git

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index a98343f..2ddd19a 100644
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -23,6 +23,16 @@ Methods		void Release()
 
 			Possible Errors: net.connman.Agent.Error.Retry
 
+		void ReportPeerError(object peer, string error)
+
+			This method gets called when an error has to be
+			reported to the user about a peer connection.
+
+			A special return value can be used to trigger a
+			retry of the failed transaction.
+
+			Possible Errors: net.connman.Agent.Error.Retry
+
 		void RequestBrowser(object service, string url)
 
 			This method gets called when it is required
@@ -58,6 +68,25 @@ Methods		void Release()
 			Possible Errors: net.connman.Agent.Error.Canceled
 					 net.connman.Agent.Error.LaunchBrowser
 
+		dict RequestPeerAuthorization(object peer, dict fields) [experimental]
+
+			This method gets called when trying to connect to a
+			peer or when an incoming peer connection is requested,
+			for which some extra input is required. In this case,
+			it will only deal with WPS input as well as accepting
+			or rejecting an incoming connection.
+
+			The return value should be a dictionary where the
+			keys are the field names and the values are the
+			actual fields. Alternatively an error indicating that
+			the request got canceled or rejected can be returned.
+
+			The dictionary arguments contains field names with
+			their input parameters.
+
+			Possible Errors: net.connman.Agent.Error.Canceled
+			                 net.connman.Agent.Error.Rejected
+
 		void Cancel()
 
 			This method gets called to indicate that the agent
@@ -107,6 +136,9 @@ Fields		string Name
 			method, or a pin code if user wants to use the pin
 			method.
 
+			In case of a RequestPeerAuthorization, this field will
+			be set as mandatory.
+
 		string Username
 
 			Username for WISPr authentication. This field will be
@@ -254,3 +286,20 @@ Examples	Requesting a passphrase for WPA2 network
 				}
 
 			==> { "Username" : "foo", "Password": "secret" }
+
+		Requesting a answer about an inconming peer connection:
+
+			RequestPeerAuthorization("/peer3", {})
+
+			==> { }
+
+		Requesting the WPS details when connecting to a peer:
+
+			RequestPeerAuthorization("/peer4",
+				{ "WPS":
+					{ "Type"        : "wpspin",
+					  "Requirement" : "mandatory"
+					}
+				}
+
+			==> { "WPS" : "" }