dbus: use the annotations for documentation
[NetworkManager.git] / introspection / nm-ip4-config.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.NetworkManager.IP4Config">
5     <property name="Addresses" type="aau" access="read">
6       <annotation name="org.gtk.GDBus.DocString" value="
7         Array of arrays of IPv4 address/prefix/gateway.  All 3
8         elements of each array are in network byte order.  Essentially:
9         [(addr, prefix, gateway), (addr, prefix, gateway), ...]
10
11         Deprecated: use AddressData and Gateway
12       " />
13     </property>
14     <property name="AddressData" type="aa{sv}" access="read">
15       <annotation name="org.gtk.GDBus.DocString" value="
16         Array of IP address data objects. All addresses will include
17         &quot;address&quot; (an IP address string), and &quot;prefix&quot; (a uint). Some
18         addresses may include additional attributes.
19       " />
20     </property>
21     <property name="Gateway" type="s" access="read">
22       <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." />
23     </property>
24     <property name="Routes" type="aau" access="read">
25       <annotation name="org.gtk.GDBus.DocString" value="
26         Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of
27         each tuple are in network byte order. 'route' and 'next hop'
28         are IPv4 addresses, while prefix and metric are simple
29         unsigned integers. Essentially: [(route, prefix, next-hop,
30         metric), (route, prefix, next-hop, metric), ...]
31
32         Deprecated: use RouteData
33       " />
34     </property>
35     <property name="RouteData" type="aa{sv}" access="read">
36       <annotation name="org.gtk.GDBus.DocString" value="
37         Array of IP route data objects. All routes will include &quot;dest&quot;
38         (an IP address string) and &quot;prefix&quot; (a uint). Some routes may
39         include &quot;next-hop&quot; (an IP address string), &quot;metric&quot; (a uint),
40         and additional attributes.
41       " />
42     </property>
43     <property name="Nameservers" type="au" access="read">
44       <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." />
45     </property>
46     <property name="Domains" type="as" access="read">
47       <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." />
48     </property>
49     <property name="Searches" type="as" access="read">
50       <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." />
51     </property>
52     <property name="DnsOptions" type="as" access="read">
53       <annotation name="org.gtk.GDBus.DocString" value="
54         A list of DNS options that modify the behavior of the DNS
55         resolver. See resolv.conf(5) manual page for the list of
56         supported options.
57       " />
58     </property>
59     <property name="WinsServers" type="au" access="read">
60       <annotation name="org.gtk.GDBus.DocString" value="The Windows Internet Name Service servers associated with the connection.  Each address is in network byte order." />
61     </property>
62
63     <signal name="PropertiesChanged">
64       <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
65         <annotation name="org.gtk.GDBus.DocString" value="
66           A dictionary mapping property names to variant boxed values
67         " />
68       </arg>
69     </signal>
70   </interface>
71 </node>
72