introspection/nm-active-connection.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.Connection.Active">
   5     <annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
   6     <annotation name="org.gtk.GDBus.DocString" value="
   7       Objects that implement the Connection.Active interface represent an attempt
   8       to connect to a network using the details provided by a Connection object.
   9       The Connection.Active object tracks the life-cycle of the connection
  10       attempt and if successful indicates whether the connected network is the
  11       &quot;default&quot; or preferred network for access.
  12       NetworkManager has the concept of connections, which can be thought of as
  13       settings, a profile or a configuration that can be applied on a networking
  14       device.
  15       Such settings-connections are exposed as D-Bus object and the active-connection
  16       expresses this relationship between device and settings-connection.
  17       At any time a settings-connection can only be activated on one device and vice
  18       versa. However, during activation and deactivation multiple active-connections
  19       can reference the same device or settings-connection as they are waiting to
  20       be activated or to be deactivated.
  21     " />
  22
  23     <property name="Connection" type="o" access="read">
  24       <annotation name="org.gtk.GDBus.DocString" value="
  25         The path of the connection.
  26       " />
  27     </property>
  28     <property name="SpecificObject" type="o" access="read">
  29       <annotation name="org.gtk.GDBus.DocString" value="
  30         A specific object associated with the active connection.  This property
  31         reflects the specific object used during connection activation, and will
  32         not change over the lifetime of the ActiveConnection once set.
  33       " />
  34     </property>
  35     <property name="Id" type="s" access="read">
  36       <annotation name="org.gtk.GDBus.DocString" value="
  37         The ID of the connection, provided as a convenience so that clients
  38         do not have to retrieve all connection details.
  39       " />
  40     </property>
  41     <property name="Uuid" type="s" access="read">
  42       <annotation name="org.gtk.GDBus.DocString" value="
  43         The UUID of the connection, provided as a convenience so that clients
  44         do not have to retrieve all connection details.
  45       " />
  46     </property>
  47     <property name="Type" type="s" access="read">
  48       <annotation name="org.gtk.GDBus.DocString" value="
  49         The type of the connection, provided as a convenience so that clients
  50         do not have to retrieve all connection details.
  51       " />
  52     </property>
  53     <property name="Devices" type="ao" access="read">
  54       <annotation name="org.gtk.GDBus.DocString" value="
  55         Array of object paths representing devices which are part of this active
  56         connection.
  57       " />
  58     </property>
  59     <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
  60       <annotation name="org.gtk.GDBus.DocString" value="
  61         The state of this active connection.
  62       " />
  63     </property>
  64     <property name="Default" type="b" access="read">
  65       <annotation name="org.gtk.GDBus.DocString" value="
  66         Whether this active connection is the default IPv4 connection, i.e.
  67         whether it currently owns the default IPv4 route.
  68       " />
  69     </property>
  70     <property name="Ip4Config" type="o" access="read">
  71       <annotation name="org.gtk.GDBus.DocString" value="
  72         Object path of the Ip4Config object describing the configuration of the
  73         connection. Only valid when the connection is in the
  74         NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
  75       " />
  76     </property>
  77     <property name="Dhcp4Config" type="o" access="read">
  78       <annotation name="org.gtk.GDBus.DocString" value="
  79         Object path of the Dhcp4Config object describing the DHCP options
  80         returned by the DHCP server (assuming the connection used DHCP). Only
  81         valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
  82         state.
  83       " />
  84     </property>
  85     <property name="Default6" type="b" access="read">
  86       <annotation name="org.gtk.GDBus.DocString" value="
  87         Whether this active connection is the default IPv6 connection, i.e.
  88         whether it currently owns the default IPv6 route.
  89       " />
  90     </property>
  91     <property name="Ip6Config" type="o" access="read">
  92       <annotation name="org.gtk.GDBus.DocString" value="
  93         Object path of the Ip6Config object describing the configuration of the
  94         connection. Only valid when the connection is in the
  95         NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
  96       " />
  97     </property>
  98     <property name="Dhcp6Config" type="o" access="read">
  99       <annotation name="org.gtk.GDBus.DocString" value="
 100         Object path of the Dhcp6Config object describing the DHCP options
 101         returned by the DHCP server (assuming the connection used DHCP). Only
 102         valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
 103         state.
 104       " />
 105     </property>
 106     <property name="Vpn" type="b" access="read">
 107       <annotation name="org.gtk.GDBus.DocString" value="
 108         Whether this active connection is also a VPN connection.
 109       " />
 110     </property>
 111     <property name="Master" type="o" access="read">
 112       <annotation name="org.gtk.GDBus.DocString" value="
 113         The path to the master device if the connection is a slave.
 114       " />
 115     </property>
 116
 117     <signal name="PropertiesChanged">
 118         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
 119             <annotation name="org.gtk.GDBus.DocString" value="
 120                 A dictionary mapping property names to variant boxed values
 121             " />
 122         </arg>
 123     </signal>
 124
 125     <tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u">
 126       <tp:enumvalue suffix="UNKNOWN" value="0">
 127         <annotation name="org.gtk.GDBus.DocString" value="
 128           The active connection is in an unknown state.
 129         " />
 130       </tp:enumvalue>
 131       <tp:enumvalue suffix="ACTIVATING" value="1">
 132         <annotation name="org.gtk.GDBus.DocString" value="
 133           The connection is activating.
 134         " />
 135       </tp:enumvalue>
 136       <tp:enumvalue suffix="ACTIVATED" value="2">
 137         <annotation name="org.gtk.GDBus.DocString" value="
 138           The connection is activated.
 139         " />
 140       </tp:enumvalue>
 141       <tp:enumvalue suffix="DEACTIVATING" value="3">
 142         <annotation name="org.gtk.GDBus.DocString" value="
 143           The connection is being torn down and cleaned up.
 144         " />
 145       </tp:enumvalue>
 146       <tp:enumvalue suffix="DEACTIVATED" value="4">
 147         <annotation name="org.gtk.GDBus.DocString" value="
 148           The connection is no longer active.
 149         " />
 150       </tp:enumvalue>
 151     </tp:enum>
 152   </interface>
 153 </node>
 154