Imported Upstream version 1.24

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

diff --git a/doc/technology-api.txt b/doc/technology-api.txt
index 851d5ea..f97eac0 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)
@@ -20,16 +23,21 @@ Methods             dict GetProperties()
                        will be emitted.
 
                        Possible Errors: [service].Error.InvalidArguments
-                                        [service].Error.InvalidProperty
+                                        [service].Error.InvalidProperty
 
                void Scan()
 
                        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.
 
-                       Results will be signaled via the ServicesAdded (or
-                       also ServicesRemoved) signal from the manager
+                       In case of P2P technology, results will be signaled
+                       via the PeersChanged signal from the manager
                        interface.
 
 Signals                PropertyChanged(string name, variant value)
@@ -46,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
@@ -76,16 +84,16 @@ Properties  boolean Powered [readwrite]
 
                string TetheringIdentifier [readwrite]
 
-                      The tethering broadcasted identifier.
+                       The tethering broadcasted identifier.
 
-                      This property is only valid for the WiFi technology,
-                      and is then mapped to the WiFi AP SSID clients will
-                      have to join in order to gain internet connectivity.
+                       This property is only valid for the WiFi technology,
+                       and is then mapped to the WiFi AP SSID clients will
+                       have to join in order to gain internet connectivity.
 
                string TetheringPassphrase [readwrite]
 
-                      The tethering connection passphrase.
+                       The tethering connection passphrase.
 
-                      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.
+                       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.