NetworkManager/introspection/nm-active-connection.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

155 lines
6.7 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.Connection.Active">
<annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
<annotation name="org.gtk.GDBus.DocString" value="
Objects that implement the Connection.Active interface represent an attempt
to connect to a network using the details provided by a Connection object.
The Connection.Active object tracks the life-cycle of the connection
attempt and if successful indicates whether the connected network is the
&quot;default&quot; or preferred network for access.
NetworkManager has the concept of connections, which can be thought of as
settings, a profile or a configuration that can be applied on a networking
device.
Such settings-connections are exposed as D-Bus object and the active-connection
expresses this relationship between device and settings-connection.
At any time a settings-connection can only be activated on one device and vice
versa. However, during activation and deactivation multiple active-connections
can reference the same device or settings-connection as they are waiting to
be activated or to be deactivated.
" />
<property name="Connection" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The path of the connection.
" />
</property>
<property name="SpecificObject" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
A specific object associated with the active connection. This property
reflects the specific object used during connection activation, and will
not change over the lifetime of the ActiveConnection once set.
" />
</property>
<property name="Id" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The ID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
" />
</property>
<property name="Uuid" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The UUID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
" />
</property>
<property name="Type" type="s" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The type of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
" />
</property>
<property name="Devices" type="ao" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are part of this active
connection.
" />
</property>
<property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
<annotation name="org.gtk.GDBus.DocString" value="
The state of this active connection.
" />
</property>
<property name="Default" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv4 connection, i.e.
whether it currently owns the default IPv4 route.
" />
</property>
<property name="Ip4Config" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip4Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
" />
</property>
<property name="Dhcp4Config" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp4Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
" />
</property>
<property name="Default6" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv6 connection, i.e.
whether it currently owns the default IPv6 route.
" />
</property>
<property name="Ip6Config" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip6Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
" />
</property>
<property name="Dhcp6Config" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
" />
</property>
<property name="Vpn" type="b" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is also a VPN connection.
" />
</property>
<property name="Master" type="o" access="read">
<annotation name="org.gtk.GDBus.DocString" value="
The path to the master device if the connection is a slave.
" />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
<annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
" />
</arg>
</signal>
<tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
<annotation name="org.gtk.GDBus.DocString" value="
The active connection is in an unknown state.
" />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATING" value="1">
<annotation name="org.gtk.GDBus.DocString" value="
The connection is activating.
" />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="2">
<annotation name="org.gtk.GDBus.DocString" value="
The connection is activated.
" />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATING" value="3">
<annotation name="org.gtk.GDBus.DocString" value="
The connection is being torn down and cleaned up.
" />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATED" value="4">
<annotation name="org.gtk.GDBus.DocString" value="
The connection is no longer active.
" />
</tp:enumvalue>
</tp:enum>
</interface>
</node>