dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-device-wifi.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.NetworkManager.Device.Wireless">
5     <annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/>
6
7     <method name="GetAccessPoints">
8       <arg name="access_points" type="ao" direction="out">
9         <annotation name="org.gtk.GDBus.DocString" value="
10           List of access point object paths.
11         " />
12       </arg>
13       <annotation name="org.gtk.GDBus.DocString" value="
14         DEPRECATED.  Get the list of access points visible to this device.  Note
15         that this list does not include access points which hide their SSID.  To
16         retrieve a list of all access points (including hidden ones) use the
17         GetAllAccessPoints() method.
18       " />
19     </method>
20
21     <method name="GetAllAccessPoints">
22       <arg name="access_points" type="ao" direction="out">
23         <annotation name="org.gtk.GDBus.DocString" value="
24           List of access point object paths.
25         " />
26       </arg>
27       <annotation name="org.gtk.GDBus.DocString" value="
28         Get the list of all access points visible to this device, including
29         hidden ones for which the SSID is not yet known.
30       " />
31     </method>
32
33     <method name="RequestScan">
34       <arg name="options" type="a{sv}" direction="in">
35         <annotation name="org.gtk.GDBus.DocString" value="
36           Options of scan.
37           Currently 'ssids' option with value of &quot;aay&quot; type is supported.
38         " />
39       </arg>
40       <annotation name="org.gtk.GDBus.DocString" value="
41         Request the device to scan
42       " />
43     </method>
44
45     <property name="HwAddress" type="s" access="read">
46       <annotation name="org.gtk.GDBus.DocString" value="
47         The active hardware address of the device.
48       " />
49     </property>
50
51     <property name="PermHwAddress" type="s" access="read">
52       <annotation name="org.gtk.GDBus.DocString" value="
53         The permanent hardware address of the device.
54       " />
55     </property>
56
57     <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
58       <annotation name="org.gtk.GDBus.DocString" value="
59         The operating mode of the wireless device.
60       " />
61     </property>
62
63     <property name="Bitrate" type="u" access="read">
64       <annotation name="org.gtk.GDBus.DocString" value="
65         The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
66       " />
67     </property>
68
69     <property name="AccessPoints" type="ao" access="read">
70       <annotation name="org.gtk.GDBus.DocString" value="
71         List of object paths of access point visible to this wireless device.
72       " />
73     </property>
74
75     <property name="ActiveAccessPoint" type="o" access="read">
76       <annotation name="org.gtk.GDBus.DocString" value="
77         Object path of the access point currently used by the wireless device.
78       " />
79     </property>
80
81     <property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP">
82       <annotation name="org.gtk.GDBus.DocString" value="
83         The capabilities of the wireless device.
84       " />
85     </property>
86
87     <signal name="PropertiesChanged">
88         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
89             <annotation name="org.gtk.GDBus.DocString" value="
90                 A dictionary containing the FIXME: check changed parameters.
91             " />
92         </arg>
93         <annotation name="org.gtk.GDBus.DocString" value="
94             Emitted when the wireless device's properties changed.
95         " />
96     </signal>
97
98     <signal name="AccessPointAdded">
99         <arg name="access_point" type="o">
100             <annotation name="org.gtk.GDBus.DocString" value="
101                 The object path of the newly found access point.
102             " />
103         </arg>
104         <annotation name="org.gtk.GDBus.DocString" value="
105             Emitted when a new access point is found by the device.
106         " />
107     </signal>
108
109     <signal name="AccessPointRemoved">
110       <arg name="access_point" type="o">
111             <annotation name="org.gtk.GDBus.DocString" value="
112                 The object path of the access point that has disappeared.
113             " />
114         </arg>
115         <annotation name="org.gtk.GDBus.DocString" value="
116             Emitted when an access point disappears from view of the device.
117         " />
118     </signal>
119
120     <tp:flags name="NM_802_11_DEVICE_CAP" type="u">
121       <annotation name="org.gtk.GDBus.DocString" value="
122         Flags describing the capabilities of a wireless device.
123       " />
124       <tp:flag suffix="NONE" value="0x0">
125         <annotation name="org.gtk.GDBus.DocString" value="Null capability - syntactic sugar for no capabilities supported.  Do not AND this with other capabilities!" />
126       </tp:flag>
127       <tp:flag suffix="CIPHER_WEP40" value="0x1">
128         <annotation name="org.gtk.GDBus.DocString" value="The device supports the 40-bit WEP cipher." />
129       </tp:flag>
130       <tp:flag suffix="CIPHER_WEP104" value="0x2">
131         <annotation name="org.gtk.GDBus.DocString" value="The device supports the 104-bit WEP cipher." />
132       </tp:flag>
133       <tp:flag suffix="CIPHER_TKIP" value="0x4">
134         <annotation name="org.gtk.GDBus.DocString" value="The device supports the TKIP cipher." />
135       </tp:flag>
136       <tp:flag suffix="CIPHER_CCMP" value="0x8">
137         <annotation name="org.gtk.GDBus.DocString" value="The device supports the CCMP cipher." />
138       </tp:flag>
139       <tp:flag suffix="WPA" value="0x10">
140         <annotation name="org.gtk.GDBus.DocString" value="The device supports the WPA encryption/authentication protocol." />
141       </tp:flag>
142       <tp:flag suffix="RSN" value="0x20">
143         <annotation name="org.gtk.GDBus.DocString" value="The device supports the RSN encryption/authentication protocol." />
144       </tp:flag>
145       <tp:flag suffix="AP" value="0x40">
146         <annotation name="org.gtk.GDBus.DocString" value="The device supports Access Point mode." />
147       </tp:flag>
148       <tp:flag suffix="ADHOC" value="0x80">
149         <annotation name="org.gtk.GDBus.DocString" value="The device supports Ad-Hoc mode." />
150       </tp:flag>
151       <tp:flag suffix="FREQ_VALID" value="0x100">
152         <annotation name="org.gtk.GDBus.DocString" value="
153           The device properly reports information about supported
154           frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and
155           NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid.
156         " />
157       </tp:flag>
158       <tp:flag suffix="FREQ_2GHZ" value="0x200">
159         <annotation name="org.gtk.GDBus.DocString" value="
160           The device supports 2.4GHz frequencies.
161         " />
162       </tp:flag>
163       <tp:flag suffix="FREQ_5GHZ" value="0x400">
164         <annotation name="org.gtk.GDBus.DocString" value="
165           The device supports 5GHz frequencies.
166         " />
167       </tp:flag>
168     </tp:flags>
169   </interface>
170 </node>