doc: Make session methods as experimental for now

[platform/upstream/connman.git] / doc / agent-api.txt

diff --git a/doc/agent-api.txt b/doc/agent-api.txt
index c9a0b0f..7ba3d56 100644 (file)
--- a/doc/agent-api.txt
+++ b/doc/agent-api.txt
@@ -23,6 +23,17 @@ Methods              void Release()
 
                        Possible Errors: net.connman.Agent.Error.Retry
 
+               void RequestBrowser(object service, string url)
+
+                       This method gets called when it is required
+                       to ask the user to open a website to procceed
+                       with login handling.
+
+                       This can happen if connected to a hotspot portal
+                       page without WISPr support.
+
+                       Possible Errors: net.connman.Agent.Error.Retry
+
                dict RequestInput(object service, dict fields)
 
                        This method gets called when trying to connect to
@@ -80,6 +91,16 @@ Fields               string Name
                        method, or a pin code if user wants to use the pin
                        method.
 
+               string Username
+
+                       Username for WISPr authentication. This field will be
+                       requested when connecting to a WISPr-enabled hotspot.
+
+               string Password
+
+                       Password for WISPr authentication. This field will be
+                       requested when connecting to a WISPr-enabled hotspot.
+
 Arguments      string Type
 
                        Contains the type of a field. For example "psk", "wep"
@@ -164,3 +185,16 @@ Examples   Requesting a passphrase for WPA2 network
                                }
 
                        ==> { "Identity" : "bob", "Passphrase": "secret123" }
+
+               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" }