summaryrefslogtreecommitdiff
path: root/introspection/org.freedesktop.NetworkManager.Device.Wireless.xml
blob: d9af0964eca26e842e8ad26f1db4bb5d8ba007ca (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
<?xml version="1.0" encoding="UTF-8"?>
<node name="/">
  <!--
      org.freedesktop.NetworkManager.Device.Wireless:
      @short_description: Wi-Fi Device

  -->
  <interface name="org.freedesktop.NetworkManager.Device.Wireless">
    <annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/>

    <!--
        GetAccessPoints:
        @access_points: List of access point object paths.

        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 name="GetAccessPoints">
      <arg name="access_points" type="ao" direction="out"/>
      </method>

    <!--
        GetAllAccessPoints:
        @access_points: List of access point object paths.

        Get the list of all access points visible to this device, including hidden
        ones for which the SSID is not yet known.
    -->
    <method name="GetAllAccessPoints">
      <arg name="access_points" type="ao" direction="out"/>
      </method>

    <!--
        RequestScan:
        @options: Options of scan. Currently 'ssids' option with value of "aay" type is supported.

        Request the device to scan. To know when the scan is finished, use the "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" to listen to changes to the "LastScan" property.
    -->
    <method name="RequestScan">
      <arg name="options" type="a{sv}" direction="in"/>
      </method>

    <!--
        HwAddress:

        The active hardware address of the device.

        DEPRECATED. Use the "HwAddress" property in "org.freedesktop.NetworkManager.Device" instead which exists since version NetworkManager 1.24.0.
    -->
    <property name="HwAddress" type="s" access="read"/>

    <!--
        PermHwAddress:

        The permanent hardware address of the device.
    -->
    <property name="PermHwAddress" type="s" access="read"/>

    <!--
        Mode:

        The operating mode of the wireless device.

        Returns: <link linkend="NM80211Mode">NM80211Mode</link>
    -->
    <property name="Mode" type="u" access="read"/>

    <!--
        Bitrate:

        The bit rate currently used by the wireless device, in kilobits/second
        (Kb/s).
    -->
    <property name="Bitrate" type="u" access="read"/>

    <!--
        AccessPoints:

        List of object paths of access point visible to this wireless device.
    -->
    <property name="AccessPoints" type="ao" access="read"/>

    <!--
        ActiveAccessPoint:

        Object path of the access point currently used by the wireless device.
    -->
    <property name="ActiveAccessPoint" type="o" access="read"/>

    <!--
        WirelessCapabilities:

        The capabilities of the wireless device.

        Returns: <link linkend="NMDeviceWifiCapabilities">NMDeviceWifiCapabilities</link>
    -->
    <property name="WirelessCapabilities" type="u" access="read"/>

    <!--
        LastScan:

        The timestamp (in CLOCK_BOOTTIME milliseconds) for the last finished network scan.
        A value of -1 means the device never scanned for access points.

        Since: 1.12
    -->
    <property name="LastScan" type="x" access="read"/>

    <!--
        PropertiesChanged:
        @properties: A dictionary containing the changed parameters.

        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
    -->
    <signal name="PropertiesChanged">
        <arg name="properties" type="a{sv}"/>
        </signal>

    <!--
        AccessPointAdded:
        @access_point: The object path of the newly found access point.

        Emitted when a new access point is found by the device.
    -->
    <signal name="AccessPointAdded">
        <arg name="access_point" type="o"/>
        </signal>

    <!--
        AccessPointRemoved:
        @access_point: The object path of the access point that has disappeared.

        Emitted when an access point disappears from view of the device.
    -->
    <signal name="AccessPointRemoved">
      <arg name="access_point" type="o"/>
    </signal>
  </interface>
</node>