2007-02-12 09:23:43 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2007-08-15 07:52:25 +00:00
<!--
READ ME! READ ME! READ ME! READ ME! READ ME!
This file needs to be kept in sync with nm-manager-client.xml with the exception of
the legacy methods at the end of this file.
-->
2008-02-28 02:07:21 +00:00
<node name= "/" xmlns:tp= "http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" >
2007-02-12 09:23:43 +00:00
<interface name= "org.freedesktop.NetworkManager" >
<method name= "GetDevices" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
Get the list of network devices.
</tp:docstring>
2007-02-12 09:23:43 +00:00
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_get_devices" />
2008-02-28 02:07:21 +00:00
<arg name= "devices" type= "ao" direction= "out" >
<tp:docstring >
List of object paths of network devices known to the system.
</tp:docstring>
</arg>
2007-02-12 09:23:43 +00:00
</method>
2007-10-01 15:38:39 +00:00
<method name= "ActivateDevice" >
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_activate_device" />
<annotation name= "org.freedesktop.DBus.GLib.Async" value= "" />
2008-02-28 02:07:21 +00:00
<tp:docstring >
Activate a device using the supplied connection.
</tp:docstring>
<arg name= "device" type= "o" direction= "in" >
<tp:docstring >
The device to be activated.
</tp:docstring>
</arg>
<arg name= "service_name" type= "s" direction= "in" >
<tp:docstring >
The D-Bus service name of the settings service that provides this connection.
</tp:docstring>
</arg>
<arg name= "connection" type= "o" direction= "in" >
<tp:docstring >
The connection to activate the devices with.
</tp:docstring>
</arg>
<arg name= "specific_object" type= "o" direction= "in" >
<tp:docstring >
The path of a device-type-specific object this activation should use, for example a WiFi access point.
</tp:docstring>
</arg>
<tp:possible-errors >
<tp:error name= "org.freedesktop.NetworkManager.Error.UnknownConnection" />
<tp:error name= "org.freedesktop.NetworkManager.Error.UnknownDevice" />
<tp:error name= "org.freedesktop.NetworkManager.Error.InvalidService" />
<tp:error name= "org.freedesktop.NetworkManager.Error.ConnectionActivating" >
<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>
</tp:error>
<tp:error name= "org.freedesktop.NetworkManager.Error.ConnectionInvalid" >
<tp:docstring > The connection is invalid for this device.</tp:docstring>
</tp:error>
</tp:possible-errors>
2007-10-01 15:38:39 +00:00
</method>
2007-10-03 14:48:25 +00:00
<method name= "GetActiveConnections" >
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_get_active_connections" />
<!-- 'connections' is an array of structs
2008-02-28 02:07:21 +00:00
consisting of the following elements:
service name
connection object path
specific object
array of (device object path)
2007-10-03 14:48:25 +00:00
-->
2008-02-28 02:07:21 +00:00
<arg name= "connections" type= "a(sooao)" direction= "out" tp:type= "Active_Connection[]" >
<tp:docstring >
List of active connections
</tp:docstring>
</arg>
2007-10-03 14:48:25 +00:00
</method>
2007-02-12 09:23:43 +00:00
<method name= "Sleep" >
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_sleep" />
2008-02-28 02:07:21 +00:00
<tp:docstring >
Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated. When awake, devices are available to be activated.
</tp:docstring>
<arg name= "sleep" type= "b" direction= "in" >
<tp:docstring >
Indicates whether the NetworkManager daemon should sleep or wake.
</tp:docstring>
</arg>
2007-02-12 09:23:43 +00:00
</method>
2008-02-28 02:07:21 +00:00
<property name= "WirelessEnabled" type= "b" access= "readwrite" >
<tp:docstring >
Indicates if wireless is currently enabled or not.
</tp:docstring>
</property>
<property name= "WirelessHardwareEnabled" type= "b" access= "read" >
<tp:docstring >
Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
</tp:docstring>
</property>
<property name= "State" type= "u" access= "read" tp:type= "NM_STATE" >
<tp:docstring >
The overall state of the NetworkManager daemon.
</tp:docstring>
</property>
2007-02-12 09:23:43 +00:00
<signal name= "StateChange" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
NetworkManager's state changed.
</tp:docstring>
<arg name= "state" type= "u" tp:type= "NM_STATE" >
<tp:docstring >
The new state of NetworkManager.
</tp:docstring>
</arg>
2007-02-12 09:23:43 +00:00
</signal>
2007-10-15 14:46:37 +00:00
<signal name= "PropertiesChanged" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
NetworkManager's properties changed.
</tp:docstring>
<arg name= "properties" type= "a{sv}" tp:type= "String_Variant_Map" >
<tp:docstring >
The changed properties.
</tp:docstring>
</arg>
2007-10-15 14:46:37 +00:00
</signal>
2007-02-12 09:23:43 +00:00
<signal name= "DeviceAdded" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
A device was added to the system
</tp:docstring>
<arg name= "device_path" type= "o" >
<tp:docstring >
The object path of the newly added device.
</tp:docstring>
</arg>
2007-02-12 09:23:43 +00:00
</signal>
<signal name= "DeviceRemoved" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
A device was removed from the system, and is no longer available.
</tp:docstring>
<arg name= "device_path" type= "o" >
<tp:docstring >
The object path of the device that was just removed.
</tp:docstring>
</arg>
2007-02-12 09:23:43 +00:00
</signal>
2008-02-28 02:07:21 +00:00
<tp:enum name= "NM_STATE" type= "u" >
<tp:docstring >
Describes the overall state of the daemon.
</tp:docstring>
<tp:enumvalue suffix= "UNKNOWN" value= "0" >
<tp:docstring >
The NetworkManager daemon is in an unknown state.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix= "ASLEEP" value= "1" >
<tp:docstring >
The NetworkManager daemon is asleep and all interfaces managed by it are inactive.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix= "CONNECTING" value= "2" >
<tp:docstring >
The NetworkManager daemon is connecting a device. FIXME: What does this mean when one device is active and another is connecting?
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix= "CONNECTED" value= "3" >
<tp:docstring >
The NetworkManager daemon is connected.
</tp:docstring>
</tp:enumvalue>
<tp:enumvalue suffix= "DISCONNECTED" value= "4" >
<tp:docstring >
The NetworkManager daemon is disconnected.
</tp:docstring>
</tp:enumvalue>
</tp:enum>
<tp:struct name= "Active_Connection" array-name= "Active_Connection_List" >
<tp:docstring > A struct representing an active connection, returned by GetActiveConnections on the NetworkManager interface.
</tp:docstring>
<tp:member type= "s" name= "service_name" >
<tp:docstring >
The D-Bus service name of the settings service that provides this connection.
</tp:docstring>
</tp:member>
<tp:member type= "o" name= "connection_path" >
<tp:docstring >
Object path of the active connection
</tp:docstring>
</tp:member>
<tp:member type= "o" name= "specific_object" >
<tp:docstring >
Object path of a device-type-specific object this connection uses, for example a specific WiFi access point.
</tp:docstring>
</tp:member>
<tp:member type= "ao" name= "active_device_list" >
<tp:docstring >
Array of object paths to the devices this connection is active on.
</tp:docstring>
</tp:member>
</tp:struct>
2007-08-15 07:52:25 +00:00
<!-- Legacy methods to maintain backwards compatibility for 0.6 branch. -->
<method name= "sleep" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
DEPRECATED. Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated.
</tp:docstring>
2007-08-15 07:52:25 +00:00
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_legacy_sleep" />
</method>
<method name= "wake" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
DEPRECATED. Control the NetworkManager daemon's sleep state. When awake, all known interfaces are available to be activated.
</tp:docstring>
2007-08-15 07:52:25 +00:00
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_legacy_wake" />
</method>
<method name= "state" >
2008-02-28 02:07:21 +00:00
<tp:docstring >
DEPRECATED. The overall state of the NetworkManager daemon.
</tp:docstring>
2007-08-15 07:52:25 +00:00
<annotation name= "org.freedesktop.DBus.GLib.CSymbol" value= "impl_manager_legacy_state" />
2008-02-28 02:07:21 +00:00
<arg name= "state" type= "u" direction= "out" tp:type= "NM_STATE" />
2007-08-15 07:52:25 +00:00
</method>
2007-02-12 09:23:43 +00:00
</interface>
</node>