Updated connman to version 1.35

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

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 7d9889e..4fe4093 100755 (executable)
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -30,13 +30,12 @@ Methods             dict GetProperties()  [deprecated]
 
                void ClearProperty(string name)
 
-                       Clears the value of the specified property.
+                       Clears the value of the specified property. Only
+                       the readonly Error property can be cleared using
+                       this method call. When cleared the service is reset
+                       to the idle state.
 
-                       Properties cannot be cleared for hidden WiFi service
-                       entries or provisioned services.
-
-                       Possible Errors: [service].Error.InvalidArguments
-                                        [service].Error.InvalidProperty
+                       Possible Errors: [service].Error.InvalidProperty
 
                void Connect()
 
@@ -92,8 +91,9 @@ Methods               dict GetProperties()  [deprecated]
                        to false, but that is currently not supported.
 
                        In the case a connection attempt failed and the
-                       service is in the State=failure, this method can
-                       also be used to reset the service.
+                       service is in the state "failure", "idle" or
+                       "disconnect", this method can also be used
+                       to reset the service.
 
                        Calling this method on Ethernet devices, hidden WiFi
                        services or provisioned services will cause an error
@@ -248,9 +248,9 @@ Properties  string State [readonly]
                        This value will be set to true if the service is
                        configured externally via a configuration file.
 
-                       The only valid operation are Connect() and of
-                       course Disconnect(). The Remove() method will
-                       result in an error.
+                       The only valid operations are Connect(), Disconnect()
+                       and changing the AutoConnect property. The Remove()
+                       method will result in an error.
 
                boolean AutoConnect [readwrite]
 
@@ -341,9 +341,15 @@ Properties string State [readonly]
 
                        string Method [readonly]
 
-                               Possible values are "dhcp", "manual"
+                               Possible values are "dhcp", "manual", "auto"
                                and "off".
 
+                               It could be "auto" in case address was got
+                               through IPv4LL after DHCP failed. In this
+                               case also IPv4.Configuration will become
+                               "auto" to allow user to ask for a DHCP
+                               address at any time.
+
                                The value "fixed" indicates an IP address
                                that can not be modified. For example
                                cellular networks return fixed information.