Tethering: Add hidden access point support in technology

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

diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index f7eb57a..2fbc876 100644 (file)
--- a/doc/technology-api.txt
+++ b/doc/technology-api.txt
@@ -5,11 +5,14 @@ Service               net.connman
 Interface      net.connman.Technology
 Object path    [variable prefix]/{technology0,technology1,...}
 
-Methods                dict GetProperties()
+Methods                dict GetProperties()  [deprecated]
 
                        Returns properties for the technology object. See
                        the properties section for available properties.
 
+                       Usage of this method is highly discouraged. Use
+                       the Manager.GetTechnologies() method instead.
+
                        Possible Errors: [service].Error.InvalidArguments
 
                void SetProperty(string name, variant value)
@@ -26,11 +29,17 @@ Methods             dict GetProperties()
 
                        Trigger a scan for this specific technology. The
                        method call will return when a scan has been
-                       finished and results are available.
+                       finished and results are available. So setting
+                       a longer D-Bus timeout might be a really good
+                       idea.
 
                        Results will be signaled via the ServicesChanged
                        signal from the manager interface.
 
+                       In case of P2P technology, results will be signaled
+                       via the PeersChanged signal from the manager
+                       interface.
+
 Signals                PropertyChanged(string name, variant value)
 
                        This signal indicates a changed value of the given
@@ -45,10 +54,10 @@ Properties  boolean Powered [readwrite]
 
                boolean Connected [readonly]
 
-                       Boolean representing if a technolgy is connected.
+                       Boolean representing if a technology is connected.
 
                        This is just a convience property for allowing the
-                       UI to easily show if this technolgy has an active
+                       UI to easily show if this technology has an active
                        connection or not.
 
                        If this property is True it means that at least one
@@ -88,3 +97,8 @@ Properties    boolean Powered [readwrite]
                        This property is only valid for the WiFi technology,
                        and is then mapped to the WPA pre-shared key clients
                        will have to use in order to establish a connection.
+
+               boolean Hidden [readwrite]
+
+                       This option allows to enable or disable the support
+                       for the hidden Wi-Fi tethering.