Imported Upstream version 1.24

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

diff --git a/doc/service-api.txt b/doc/service-api.txt
index 54b77a4..c9dd7e2 100644 (file)
--- a/doc/service-api.txt
+++ b/doc/service-api.txt
@@ -22,6 +22,9 @@ Methods               dict GetProperties()  [deprecated]
                        changeable. On success a PropertyChanged signal
                        will be emitted.
 
+                       Properties cannot be set for hidden WiFi service
+                       entries or provisioned services.
+
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.InvalidProperty
 
@@ -29,6 +32,9 @@ Methods               dict GetProperties()  [deprecated]
 
                        Clears the value of the specified property.
 
+                       Properties cannot be cleared for hidden WiFi service
+                       entries or provisioned services.
+
                        Possible Errors: [service].Error.InvalidArguments
                                         [service].Error.InvalidProperty
 
@@ -48,6 +54,11 @@ Methods              dict GetProperties()  [deprecated]
                        setting a longer D-Bus timeout might be a really
                        good idea.
 
+                       Calling Connect() on a hidden WiFi service entry will
+                       query the missing SSID via the Agent API causing a
+                       WiFi service with the given SSID to be scanned,
+                       created and connected.
+
                        Possible Errors: [service].Error.InvalidArguments
 
                void Disconnect()
@@ -63,6 +74,9 @@ Methods               dict GetProperties()  [deprecated]
                        This method can also be used to abort a previous
                        connection attempt via the Connect method.
 
+                       Hidden WiFi service entries cannot be disconnected
+                       as they always stay in idle state.
+
                        Possible Errors: [service].Error.InvalidArguments
 
                void Remove()
@@ -81,9 +95,10 @@ Methods              dict GetProperties()  [deprecated]
                        service is in the State=failure, this method can
                        also be used to reset the service.
 
-                       Calling this method on Ethernet devices will cause
-                       an error message. It is not possible to remove these
-                       kind of devices.
+                       Calling this method on Ethernet devices, hidden WiFi
+                       services or provisioned services will cause an error
+                       message. It is not possible to remove these kind of
+                       services.
 
                        Possible Errors: [service].Error.InvalidArguments