doc: Fix description of technology scan method
[framework/connectivity/connman.git] / doc / technology-api.txt
1 Technology hierarchy
2 ====================
3
4 Service         net.connman
5 Interface       net.connman.Technology
6 Object path     [variable prefix]/{technology0,technology1,...}
7
8 Methods         dict GetProperties()
9
10                         Returns properties for the technology object. See
11                         the properties section for available properties.
12
13                         Possible Errors: [service].Error.InvalidArguments
14
15                 void SetProperty(string name, variant value)
16
17                         Changes the value of the specified property. Only
18                         properties that are listed as read-write are
19                         changeable. On success a PropertyChanged signal
20                         will be emitted.
21
22                         Possible Errors: [service].Error.InvalidArguments
23                                          [service].Error.InvalidProperty
24
25                 void Scan()
26
27                         Trigger a scan for this specific technology. The
28                         method call will return when a scan has been
29                         finished and results are available.
30
31                         Results will be signaled via the ServicesChanged
32                         signal from the manager interface.
33
34 Signals         PropertyChanged(string name, variant value)
35
36                         This signal indicates a changed value of the given
37                         property.
38
39 Properties      boolean Powered [readwrite]
40
41                         Boolean representing the power state of the
42                         technology. False means that the technology is
43                         off (and is available RF-Killed) while True means
44                         that the technology is enabled.
45
46                 boolean Connected [readonly]
47
48                         Boolean representing if a technolgy is connected.
49
50                         This is just a convience property for allowing the
51                         UI to easily show if this technolgy has an active
52                         connection or not.
53
54                         If this property is True it means that at least one
55                         service of this technology is in ready state.
56
57                 string Name [readonly]
58
59                         Name of this technology.
60
61                 string Type [readonly]
62
63                         The technology type (for example "ethernet" etc.)
64
65                         This information should only be used to determine
66                         advanced properties or showing the correct icon
67                         to the user.
68
69                 boolean Tethering [readwrite]
70
71                         This option allows to enable or disable the support
72                         for tethering. When tethering is enabled then the
73                         default service is bridged to all clients connected
74                         through the technology.
75
76                 string TetheringIdentifier [readwrite]
77
78                        The tethering broadcasted identifier.
79
80                        This property is only valid for the WiFi technology,
81                        and is then mapped to the WiFi AP SSID clients will
82                        have to join in order to gain internet connectivity.
83
84                 string TetheringPassphrase [readwrite]
85
86                        The tethering connection passphrase.
87
88                        This property is only valid for the WiFi technology,
89                        and is then mapped to the WPA pre-shared key clients
90                        will have to use in order to establish a connection.