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