workspace/solid/networkmanager-0.7/dbus/introspection/nm-manager.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <!--
   4   READ ME! READ ME! READ ME! READ ME! READ ME!
   5
   6   This file needs to be kept in sync with nm-manager-client.xml with the exception of
   7   the legacy methods at the end of this file.
   8 -->
   9
  10 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  11   <interface name="org.freedesktop.NetworkManager">
  12     <method name="GetDevices">
  13       <tp:docstring>
  14         Get the list of network devices.
  15       </tp:docstring>
  16       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_get_devices"/>
  17       <arg name="devices" type="ao" direction="out">
  18         <tp:docstring>
  19           List of object paths of network devices known to the system.
  20         </tp:docstring>
  21       </arg>
  22     </method>
  23
  24     <method name="ActivateConnection">
  25       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_activate_connection"/>
  26       <annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
  27       <tp:docstring>
  28         Activate a connection using the supplied device.
  29       </tp:docstring>
  30       <arg name="service_name" type="s" direction="in">
  31         <tp:docstring>
  32           The D-Bus service name of the settings service that provides this connection.
  33         </tp:docstring>
  34       </arg>
  35       <arg name="connection" type="o" direction="in">
  36         <tp:docstring>
  37           The connection to activate the devices with.
  38         </tp:docstring>
  39       </arg>
  40       <arg name="device" type="o" direction="in">
  41         <tp:docstring>
  42           The device to be activated.
  43         </tp:docstring>
  44       </arg>
  45       <arg name="specific_object" type="o" direction="in">
  46         <tp:docstring>
  47           The path of a device-type-specific object this activation should use, for example a WiFi access point.
  48         </tp:docstring>
  49       </arg>
  50       <arg name="active_connection" type="o" direction="out">
  51         <tp:docstring>
  52           The path of the active connection object representing this active connection.
  53         </tp:docstring>
  54       </arg>
  55       <tp:possible-errors>
  56         <tp:error name="org.freedesktop.NetworkManager.Error.UnknownConnection"/>
  57         <tp:error name="org.freedesktop.NetworkManager.Error.UnknownDevice"/>
  58         <tp:error name="org.freedesktop.NetworkManager.Error.InvalidService"/>
  59         <tp:error name="org.freedesktop.NetworkManager.Error.ConnectionActivating">
  60           <tp:docstring>Another connection is already activating or the same connection is already active.  FIXME: check if the error name is correct.  FIXME: split into 2 errors?</tp:docstring>
  61         </tp:error>
  62         <tp:error name="org.freedesktop.NetworkManager.Error.ConnectionInvalid">
  63           <tp:docstring>The connection is invalid for this device.</tp:docstring>
  64         </tp:error>
  65       </tp:possible-errors>
  66     </method>
  67
  68     <method name="DeactivateConnection">
  69       <tp:docstring>
  70         Deactivate an active connection.
  71       </tp:docstring>
  72       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_deactivate_connection"/>
  73       <arg name="active_connection" type="o" direction="in">
  74         <tp:docstring>
  75           The currently active connection to deactivate.
  76         </tp:docstring>
  77       </arg>
  78     </method>
  79
  80     <method name="Sleep">
  81       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_sleep"/>
  82       <tp:docstring>
  83         Control the NetworkManager daemon's sleep state.  When asleep, all interfaces that it manages are deactivated.  When awake, devices are available to be activated.
  84       </tp:docstring>
  85       <arg name="sleep" type="b" direction="in">
  86         <tp:docstring>
  87           Indicates whether the NetworkManager daemon should sleep or wake.
  88         </tp:docstring>
  89       </arg>
  90     </method>
  91
  92     <property name="WirelessEnabled" type="b" access="readwrite">
  93       <tp:docstring>
  94         Indicates if wireless is currently enabled or not.
  95       </tp:docstring>
  96     </property>
  97
  98     <property name="WirelessHardwareEnabled" type="b" access="read">
  99       <tp:docstring>
 100         Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
 101       </tp:docstring>
 102     </property>
 103
 104     <property name="ActiveConnections" type="ao" access="read">
 105       <tp:docstring>
 106         List of active connection object paths.
 107       </tp:docstring>
 108     </property>
 109
 110     <property name="State" type="u" access="read" tp:type="NM_STATE">
 111       <tp:docstring>
 112         The overall state of the NetworkManager daemon.
 113       </tp:docstring>
 114     </property>
 115
 116     <signal name="StateChanged">
 117       <tp:docstring>
 118         NetworkManager's state changed.
 119       </tp:docstring>
 120       <arg name="state" type="u" tp:type="NM_STATE">
 121         <tp:docstring>
 122           The new state of NetworkManager.
 123         </tp:docstring>
 124       </arg>
 125     </signal>
 126
 127     <signal name="PropertiesChanged">
 128       <tp:docstring>
 129         NetworkManager's properties changed.
 130       </tp:docstring>
 131       <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
 132         <tp:docstring>
 133           The changed properties.
 134         </tp:docstring>
 135       </arg>
 136     </signal>
 137
 138     <signal name="DeviceAdded">
 139       <tp:docstring>
 140         A device was added to the system
 141       </tp:docstring>
 142       <arg name="device_path" type="o">
 143         <tp:docstring>
 144           The object path of the newly added device.
 145         </tp:docstring>
 146       </arg>
 147     </signal>
 148
 149     <signal name="DeviceRemoved">
 150       <tp:docstring>
 151         A device was removed from the system, and is no longer available.
 152       </tp:docstring>
 153       <arg name="device_path" type="o">
 154         <tp:docstring>
 155           The object path of the device that was just removed.
 156         </tp:docstring>
 157       </arg>
 158     </signal>
 159
 160     <tp:enum name="NM_STATE" type="u">
 161       <tp:docstring>
 162         Describes the overall state of the daemon.
 163       </tp:docstring>
 164       <tp:enumvalue suffix="UNKNOWN" value="0">
 165         <tp:docstring>
 166           The NetworkManager daemon is in an unknown state.
 167         </tp:docstring>
 168       </tp:enumvalue>
 169       <tp:enumvalue suffix="ASLEEP" value="1">
 170         <tp:docstring>
 171           The NetworkManager daemon is asleep and all interfaces managed by it are inactive.
 172         </tp:docstring>
 173       </tp:enumvalue>
 174       <tp:enumvalue suffix="CONNECTING" value="2">
 175         <tp:docstring>
 176           The NetworkManager daemon is connecting a device.  FIXME: What does this mean when one device is active and another is connecting?
 177         </tp:docstring>
 178       </tp:enumvalue>
 179       <tp:enumvalue suffix="CONNECTED" value="3">
 180         <tp:docstring>
 181           The NetworkManager daemon is connected.
 182         </tp:docstring>
 183       </tp:enumvalue>
 184       <tp:enumvalue suffix="DISCONNECTED" value="4">
 185         <tp:docstring>
 186           The NetworkManager daemon is disconnected.
 187         </tp:docstring>
 188       </tp:enumvalue>
 189     </tp:enum>
 190
 191     <!-- Legacy methods to maintain backwards compatibility for 0.6 branch. -->
 192
 193     <signal name="StateChange">
 194       <tp:docstring>
 195         DEPRECATED.  NetworkManager's state changed.  Use the 'StateChanged' signal instead.
 196       </tp:docstring>
 197       <arg name="state" type="u" tp:type="NM_STATE">
 198         <tp:docstring>
 199           The new state of NetworkManager.
 200         </tp:docstring>
 201       </arg>
 202     </signal>
 203
 204     <method name="sleep">
 205       <tp:docstring>
 206         DEPRECATED.  Control the NetworkManager daemon's sleep state.  When asleep, all interfaces that it manages are deactivated.
 207       </tp:docstring>
 208       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_legacy_sleep"/>
 209     </method>
 210
 211     <method name="wake">
 212       <tp:docstring>
 213         DEPRECATED.  Control the NetworkManager daemon's sleep state.  When awake, all known interfaces are available to be activated.
 214       </tp:docstring>
 215       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_legacy_wake"/>
 216     </method>
 217
 218     <method name="state">
 219       <tp:docstring>
 220         DEPRECATED.  The overall state of the NetworkManager daemon.
 221       </tp:docstring>
 222       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_legacy_state"/>
 223       <arg name="state" type="u" direction="out" tp:type="NM_STATE"/>
 224     </method>
 225
 226   </interface>
 227 </node>