NetworkManager/callouts/nm-dispatcher.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

93 lines
3.2 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.nm_dispatcher">
<annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/>
<method name="Action">
<annotation name="org.gtk.GDBus.DocString" value="
INTERNAL; not public API. Perform an action.
" />
<arg name="action" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
The action being performed.
" />
</arg>
<arg name="connection" type="a{sa{sv}}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
The connection for which this action was triggered.
" />
</arg>
<arg name="connection_properties" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the connection, including service and path.
" />
</arg>
<arg name="device_properties" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device, including type, path, interface, and state.
" />
</arg>
<arg name="device_ip4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv4 configuration.
" />
</arg>
<arg name="device_ip6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv6 configuration.
" />
</arg>
<arg name="device_dhcp4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv4 configuration.
" />
</arg>
<arg name="device_dhcp6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv6 configuration.
" />
</arg>
<arg name="vpn_ip_iface" type="s" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="VPN interface name." />
</arg>
<arg name="vpn_ip4_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv4 configuration.
" />
</arg>
<arg name="vpn_ip6_config" type="a{sv}" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv6 configuration.
" />
</arg>
<arg name="debug" type="b" direction="in">
<annotation name="org.gtk.GDBus.DocString" value="
Whether to log debug output.
" />
</arg>
<arg name="results" type="a(sus)" direction="out">
<annotation name="org.gtk.GDBus.DocString" value="
Results of dispatching operations. Each element of the returned
array is a struct containing the path of an executed script (s),
the result of running that script (u), and a description of the
result (s).
" />
</arg>
</method>
</interface>
</node>