NetworkManager/introspection/nm-device-wifi.xml
Lubomir Rintel 618373a14f dbus: use the annotations for documentation
gdbus only understands those (and gtk docstrings, which we should eventually
use) when generating the documentation.
2016-03-26 11:28:19 +01:00

171 lines
6.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Device.Wireless">
<annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/>
<method name="GetAccessPoints">
<arg name="access_points" type="ao" direction="out">
<annotation name="org.gtk.GDBus.DocString" value="
List of access point object paths.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
DEPRECATED. Get the list of access points visible to this device. Note
that this list does not include access points which hide their SSID. To
retrieve a list of all access points (including hidden ones) use the
GetAllAccessPoints() method.
" />
</method>
<method name="GetAllAccessPoints">
<arg name="access_points" type="ao" direction="out">
<annotation name="org.gtk.GDBus.DocString" value="
List of access point object paths.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
Get the list of all access points visible to this device, including
hidden ones for which the SSID is not yet known.
" />
</method>
<method name="RequestScan">
<arg name="options" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Options of scan.
Currently 'ssids' option with value of &quot;aay&quot; type is supported.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
Request the device to scan
" />
</method>
<property name="HwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The active hardware address of the device.
" />
</property>
<property name="PermHwAddress" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The permanent hardware address of the device.
" />
</property>
<property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
<annotation name="org.gtk.GDBus.DocString" value="
The operating mode of the wireless device.
" />
</property>
<property name="Bitrate" type="u" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
" />
</property>
<property name="AccessPoints" type="ao" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
List of object paths of access point visible to this wireless device.
" />
</property>
<property name="ActiveAccessPoint" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the access point currently used by the wireless device.
" />
</property>
<property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP">
<annotation name="org.gtk.GDBus.DocString" value="
The capabilities of the wireless device.
" />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary containing the FIXME: check changed parameters.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
Emitted when the wireless device's properties changed.
" />
</signal>
<signal name="AccessPointAdded">
<arg name="access_point" type="o">
<annotation name="org.gtk.GDBus.DocString" value="
The object path of the newly found access point.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
Emitted when a new access point is found by the device.
" />
</signal>
<signal name="AccessPointRemoved">
<arg name="access_point" type="o">
<annotation name="org.gtk.GDBus.DocString" value="
The object path of the access point that has disappeared.
" />
</arg>
<annotation name="org.gtk.GDBus.DocString" value="
Emitted when an access point disappears from view of the device.
" />
</signal>
<tp:flags name="NM_802_11_DEVICE_CAP" type="u">
<annotation name="org.gtk.GDBus.DocString" value="
Flags describing the capabilities of a wireless device.
" />
<tp:flag suffix="NONE" value="0x0">
<annotation name="org.gtk.GDBus.DocString" value="Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!" />
</tp:flag>
<tp:flag suffix="CIPHER_WEP40" value="0x1">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the 40-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_WEP104" value="0x2">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the 104-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_TKIP" value="0x4">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the TKIP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_CCMP" value="0x8">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the CCMP cipher." />
</tp:flag>
<tp:flag suffix="WPA" value="0x10">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the WPA encryption/authentication protocol." />
</tp:flag>
<tp:flag suffix="RSN" value="0x20">
<annotation name="org.gtk.GDBus.DocString" value="The device supports the RSN encryption/authentication protocol." />
</tp:flag>
<tp:flag suffix="AP" value="0x40">
<annotation name="org.gtk.GDBus.DocString" value="The device supports Access Point mode." />
</tp:flag>
<tp:flag suffix="ADHOC" value="0x80">
<annotation name="org.gtk.GDBus.DocString" value="The device supports Ad-Hoc mode." />
</tp:flag>
<tp:flag suffix="FREQ_VALID" value="0x100">
<annotation name="org.gtk.GDBus.DocString" value="
The device properly reports information about supported
frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and
NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid.
" />
</tp:flag>
<tp:flag suffix="FREQ_2GHZ" value="0x200">
<annotation name="org.gtk.GDBus.DocString" value="
The device supports 2.4GHz frequencies.
" />
</tp:flag>
<tp:flag suffix="FREQ_5GHZ" value="0x400">
<annotation name="org.gtk.GDBus.DocString" value="
The device supports 5GHz frequencies.
" />
</tp:flag>
</tp:flags>
</interface>
</node>