dbus: use the annotations for documentation
[NetworkManager.git] / callouts / nm-dispatcher.xml
1 <?xml version="1.0" encoding="UTF-8" ?>
2
3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
4   <interface name="org.freedesktop.nm_dispatcher">
5     <annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/>
6
7     <method name="Action">
8       <annotation name="org.gtk.GDBus.DocString" value="
9         INTERNAL; not public API.  Perform an action.
10       " />
11
12       <arg name="action" type="s" direction="in">
13         <annotation name="org.gtk.GDBus.DocString" value="
14           The action being performed.
15         " />
16       </arg>
17
18       <arg name="connection" type="a{sa{sv}}" direction="in">
19         <annotation name="org.gtk.GDBus.DocString" value="
20           The connection for which this action was triggered.
21         " />
22       </arg>
23
24       <arg name="connection_properties" type="a{sv}" direction="in">
25         <annotation name="org.gtk.GDBus.DocString" value="
26           Properties of the connection, including service and path.
27         " />
28       </arg>
29
30       <arg name="device_properties" type="a{sv}" direction="in">
31         <annotation name="org.gtk.GDBus.DocString" value="
32           Properties of the device, including type, path, interface, and state.
33         " />
34       </arg>
35
36       <arg name="device_ip4_config" type="a{sv}" direction="in">
37         <annotation name="org.gtk.GDBus.DocString" value="
38           Properties of the device's IPv4 configuration.
39         " />
40       </arg>
41
42       <arg name="device_ip6_config" type="a{sv}" direction="in">
43         <annotation name="org.gtk.GDBus.DocString" value="
44           Properties of the device's IPv6 configuration.
45         " />
46       </arg>
47
48       <arg name="device_dhcp4_config" type="a{sv}" direction="in">
49         <annotation name="org.gtk.GDBus.DocString" value="
50           Properties of the device's DHCPv4 configuration.
51         " />
52       </arg>
53
54       <arg name="device_dhcp6_config" type="a{sv}" direction="in">
55         <annotation name="org.gtk.GDBus.DocString" value="
56           Properties of the device's DHCPv6 configuration.
57         " />
58       </arg>
59
60       <arg name="vpn_ip_iface" type="s" direction="in">
61         <annotation name="org.gtk.GDBus.DocString" value="VPN interface name." />
62       </arg>
63
64       <arg name="vpn_ip4_config" type="a{sv}" direction="in">
65         <annotation name="org.gtk.GDBus.DocString" value="
66           Properties of the VPN's IPv4 configuration.
67         " />
68       </arg>
69
70       <arg name="vpn_ip6_config" type="a{sv}" direction="in">
71         <annotation name="org.gtk.GDBus.DocString" value="
72           Properties of the VPN's IPv6 configuration.
73         " />
74       </arg>
75
76       <arg name="debug" type="b" direction="in">
77         <annotation name="org.gtk.GDBus.DocString" value="
78           Whether to log debug output.
79         " />
80       </arg>
81
82       <arg name="results" type="a(sus)" direction="out">
83         <annotation name="org.gtk.GDBus.DocString" value="
84           Results of dispatching operations.  Each element of the returned
85           array is a struct containing the path of an executed script (s),
86           the result of running that script (u), and a description of the
87           result (s).
88         " />
89       </arg>
90
91     </method>
92   </interface>
93 </node>