dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-access-point.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.AccessPoint">
5     <property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS">
6       <annotation name="org.gtk.GDBus.DocString" value="Flags describing the capabilities of the access point." />
7     </property>
8     <property name="WpaFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
9       <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to WPA (Wifi Protected Access)." />
10     </property>
11     <property name="RsnFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
12       <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." />
13     </property>
14     <property name="Ssid" type="ay" access="read">
15       <!-- gdbus-codegen assumes that "ay" means "non-UTF-8 string" and
16            won't deal with '\0' bytes correctly.
17       -->
18       <annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/>
19       <annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." />
20     </property>
21     <property name="Frequency" type="u" access="read">
22       <annotation name="org.gtk.GDBus.DocString" value="The radio channel frequency in use by the access point, in MHz." />
23     </property>
24     <property name="HwAddress" type="s" access="read">
25       <annotation name="org.gtk.GDBus.DocString" value="The hardware address (BSSID) of the access point." />
26     </property>
27
28     <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
29       <annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." />
30     </property>
31     <property name="MaxBitrate" type="u" access="read">
32       <annotation name="org.gtk.GDBus.DocString" value="The maximum bitrate this access point is capable of, in kilobits/second (Kb/s)." />
33     </property>
34     <property name="Strength" type="y" access="read">
35       <annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the access point, in percent." />
36     </property>
37     <property name="LastSeen" type="i" access="read">
38       <annotation name="org.gtk.GDBus.DocString" value="
39         The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access
40         point was found in scan results.  A value of -1 means the access point
41         has never been found in scan results.
42       " />
43     </property>
44
45     <signal name="PropertiesChanged">
46         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
47             <annotation name="org.gtk.GDBus.DocString" value="
48                 A dictionary mapping property names to variant boxed values
49             " />
50         </arg>
51     </signal>
52     <tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u">
53       <annotation name="org.gtk.GDBus.DocString" value="
54         Flags describing the general capabilities of the access point.
55       " />
56       <tp:flag suffix="NONE" value="0x0">
57         <annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." />
58       </tp:flag>
59       <tp:flag suffix="PRIVACY" value="0x1">
60         <annotation name="org.gtk.GDBus.DocString" value="Access point supports privacy measures." />
61       </tp:flag>
62     </tp:flags>
63     <tp:flags name="NM_802_11_AP_SEC" value-prefix="NM_802_11_AP_SEC" type="u">
64       <annotation name="org.gtk.GDBus.DocString" value="
65         Flags describing the security capabilities of the access point.
66       " />
67       <tp:flag suffix="NONE" value="0x0">
68         <annotation name="org.gtk.GDBus.DocString" value="Null flag." />
69       </tp:flag>
70       <tp:flag suffix="PAIR_WEP40" value="0x1">
71         <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." />
72       </tp:flag>
73       <tp:flag suffix="PAIR_WEP104" value="0x2">
74         <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." />
75       </tp:flag>
76       <tp:flag suffix="PAIR_TKIP" value="0x4">
77         <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." />
78       </tp:flag>
79       <tp:flag suffix="PAIR_CCMP" value="0x8">
80         <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." />
81       </tp:flag>
82       <tp:flag suffix="GROUP_WEP40" value="0x10">
83         <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 40-bit WEP cipher." />
84       </tp:flag>
85       <tp:flag suffix="GROUP_WEP104" value="0x20">
86         <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 104-bit WEP cipher." />
87       </tp:flag>
88       <tp:flag suffix="GROUP_TKIP" value="0x40">
89         <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." />
90       </tp:flag>
91       <tp:flag suffix="GROUP_CCMP" value="0x80">
92         <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." />
93       </tp:flag>
94       <tp:flag suffix="KEY_MGMT_PSK" value="0x100">
95         <annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." />
96       </tp:flag>
97       <tp:flag suffix="KEY_MGMT_802_1X" value="0x200">
98         <annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." />
99       </tp:flag>
100     </tp:flags>
101   </interface>
102 </node>
103