technology: Remove 'available' state
[platform/upstream/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 Signals         PropertyChanged(string name, variant value)
16
17                         This signal indicates a changed value of the given
18                         property.
19
20 Properties      string State [readonly]
21
22                         The technology state information.
23
24                         Valid states are "offline", "enabled" and "connected".
25
26                 string Name [readonly]
27
28                         Name of this technology.
29
30                 string Type [readonly]
31
32                         The technology type (for example "ethernet" etc.)
33
34                         This information should only be used to determine
35                         advanced properties or showing the correct icon
36                         to the user.
37
38                 boolean Tethering [readwrite]
39
40                         This option allows to enable or disable the support
41                         for tethering. When tethering is enabled then the
42                         default service is bridged to all clients connected
43                         through the technology.
44
45                 string TetheringIdentifier [readwrite]
46
47                        The tethering broadcasted identifier.
48
49                        This property is only valid for the WiFi technology,
50                        and is then mapped to the WiFi AP SSID clients will
51                        have to join in order to gain internet connectivity.
52
53                 string TetheringPassphrase [readwrite]
54
55                        The tethering connection passphrase.
56
57                        This property is only valid for the WiFi technology,
58                        and is then mapped to the WPA pre-shared key clients
59                        will have to use in order to establish a connection.