X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Fagent-api.txt;h=8201ac159d79c224ba739fea99d5948e0162b712;hb=230905c20905f2bc5ccf4b8fab75c1b5df2ac31d;hp=c0196c30921f1fa25a1406fd17ff8c1f692e60a1;hpb=52f2d485bd6ab6b7b2826370fca7bc54b9d81e1f;p=framework%2Fconnectivity%2Fconnman.git diff --git a/doc/agent-api.txt b/doc/agent-api.txt index c0196c3..8201ac1 100644 --- a/doc/agent-api.txt +++ b/doc/agent-api.txt @@ -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,6 +139,11 @@ 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", @@ -133,6 +153,18 @@ Examples Requesting a passphrase for WPA2 network } ==> { "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",