Change service name from org.moblin.connman to net.connman

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

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 2e85b93..d309736 100644 (file)
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -1,8 +1,8 @@
 Service hierarchy
 =================
 
-Service                org.moblin.connman
-Interface      org.moblin.connman.Service
+Service                net.connman
+Interface      net.connman.Service
 Object path    [variable prefix]/{service0,service1,...}
 
 Methods                dict GetProperties()
@@ -120,11 +120,12 @@ Properties        string State [readonly]
                        The service state information.
 
                        Valid states are "idle", "failure", "association",
-                       "configuration" and "ready".
+                       "configuration", "ready" and "online".
 
-                       Also "login" and "online" states are used. The
-                       state "online" signals that an Internet connection
-                       is available and has been verified.
+                       The "ready" state signals a successfully
+                       connected device. "online" signals that an
+                       Internet connection is available and has been
+                       verified.
 
                string Error [readonly]
 
@@ -189,8 +190,8 @@ Properties  string State [readonly]
                boolean LoginRequired [readonly]
 
                        This property indicates that an additional login
-                       step is needed before the connection establishment
-                       can proceed.
+                       step, like web based authentication, is needed
+                       before the connection establishment can proceed.
 
                string Passphrase [readwrite]
 
@@ -399,22 +400,23 @@ Properties        string State [readonly]
 
                        string Method [readonly]
 
-                               Possible values are "direct", "auto",
-                               "manual" and "auto-config".
+                               Possible values are "direct", "auto" and
+                               "manual".
 
-                               If the DHCP server, or WPAD protocol, provides
-                               an automatic configuration URL, then this value
-                               is set to "auto-config". The PAC file will be
-                               referenced by the URL value.
+                               In case of "auto" method, the URL file can be
+                               provided unless you want to let DHCP/WPAD
+                               auto-discover to be tried. In such case if DHCP
+                               and WPAD auto-discover methods fails then
+                               method will be "direct".
 
-                               If no automatic configuration is available,
-                               then "direct" is set, unless "manual" or "auto"
-                               method was set.
+                               In case of "direct" no additional information
+                               are provided. For the "manual" method the
+                               Servers have to be set, Excludes is optional.
 
                        string URL [readonly]
 
                                Automatic proxy configuration URL. Used by
-                               "auto" and "auto-config" methods.
+                               "auto" method.
 
                        array{string} Servers [readonly]
 
@@ -425,6 +427,9 @@ Properties  string State [readonly]
                                All others will target a specific protocol and
                                only once.
 
+                               Example for generic proxy server entry would
+                               be like this: "server.example.com:911".
+
                        array{string} Excludes [readonly]
 
                                Used when "manual" method is set.
@@ -438,9 +443,8 @@ Properties  string State [readonly]
                        user configuration.
 
                        If "auto" method is set with an empty URL, then
-                       WPAD protocol will be ran.
-
-                       All methods are supported but "auto-config".
+                       DHCP/WPAD auto-discover will be tried. Otherwise the
+                       specified URL will be used.
 
                dict Provider [readonly]