Blame docs/api/dbus-org.freedesktop.NetworkManager.VPN.Connection.xml

Packit 5756e2
Packit 5756e2
Packit 5756e2
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
Packit 5756e2
]>
Packit 5756e2
<refentry id="gdbus-org.freedesktop.NetworkManager.VPN.Connection">
Packit 5756e2
  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager-VPN-Connection.top_of_page">org.freedesktop.NetworkManager.VPN.Connection</refentrytitle>
Packit 5756e2
  <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager-VPN-Connection.top_of_page"><primary sortas="VpnConnection">org.freedesktop.NetworkManager.VPN.Connection</primary></indexterm>
Packit 5756e2
  </refmeta>  <refnamediv>    <refname>org.freedesktop.NetworkManager.VPN.Connection</refname>    <refpurpose>Active VPN Connection</refpurpose>  </refnamediv>  <refsect1 role="signal_proto">
Packit 5756e2
    <title role="signal_proto.title">Signals</title>
Packit 5756e2
    <synopsis>
Packit 5756e2
<link linkend="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.PropertiesChanged">PropertiesChanged</link> (a{sv} properties);
Packit 5756e2
<link linkend="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.VpnStateChanged">VpnStateChanged</link>   (u     state,
Packit 5756e2
                   u     reason);
Packit 5756e2
</synopsis>
Packit 5756e2
  </refsect1>
Packit 5756e2
  <refsect1 role="properties">
Packit 5756e2
    <title role="properties.title">Properties</title>
Packit 5756e2
    <synopsis>
Packit 5756e2
<link linkend="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.VpnState">VpnState</link>  readable   u
Packit 5756e2
<link linkend="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.Banner">Banner</link>    readable   s
Packit 5756e2
</synopsis>
Packit 5756e2
  </refsect1>
Packit 5756e2
<refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-VPN-Connection">
Packit 5756e2
  <title role="desc.title">Description</title>
Packit 5756e2
  <para>      Represents an active connection to a Virtual Private Network.
Packit 5756e2
</para>
Packit 5756e2
</refsect1>
Packit 5756e2
<refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.VPN.Connection">
Packit 5756e2
  <title role="details.title">Signal Details</title>
Packit 5756e2
<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.PropertiesChanged">
Packit 5756e2
  <title>The "PropertiesChanged" signal</title>
Packit 5756e2
  <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.PropertiesChanged"><primary sortas="VpnConnection::PropertiesChanged">org.freedesktop.NetworkManager.VPN.Connection::PropertiesChanged</primary></indexterm>
Packit 5756e2
<programlisting>
Packit 5756e2
PropertiesChanged (a{sv} properties);
Packit 5756e2
</programlisting>
Packit 5756e2
<para>        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
Packit 5756e2
</para>
Packit 5756e2
<variablelist role="params">
Packit 5756e2
<varlistentry>
Packit 5756e2
  <term><literal>a{sv} <parameter>properties</parameter></literal>:</term>
Packit 5756e2
  <listitem><para>A dictionary mapping property names to variant boxed values</para></listitem>
Packit 5756e2
</varlistentry>
Packit 5756e2
</variablelist>
Packit 5756e2
</refsect2>
Packit 5756e2
<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.VpnStateChanged">
Packit 5756e2
  <title>The "VpnStateChanged" signal</title>
Packit 5756e2
  <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-VPN-Connection.VpnStateChanged"><primary sortas="VpnConnection::VpnStateChanged">org.freedesktop.NetworkManager.VPN.Connection::VpnStateChanged</primary></indexterm>
Packit 5756e2
<programlisting>
Packit 5756e2
VpnStateChanged (u state,
Packit 5756e2
                 u reason);
Packit 5756e2
</programlisting>
Packit 5756e2
<para>        Emitted when the state of the VPN connection has changed.
Packit 5756e2
</para>
Packit 5756e2
<variablelist role="params">
Packit 5756e2
<varlistentry>
Packit 5756e2
  <term><literal>u <parameter>state</parameter></literal>:</term>
Packit 5756e2
  <listitem><para>(<link linkend="NMVpnConnectionState">NMVpnConnectionState</link>) The new state of the VPN connection.</para></listitem>
Packit 5756e2
</varlistentry>
Packit 5756e2
<varlistentry>
Packit 5756e2
  <term><literal>u <parameter>reason</parameter></literal>:</term>
Packit 5756e2
  <listitem><para>(<link linkend="NMActiveConnectionStateReason">NMActiveConnectionStateReason</link>) Reason code describing the change to the new state.</para></listitem>
Packit 5756e2
</varlistentry>
Packit 5756e2
</variablelist>
Packit 5756e2
</refsect2>
Packit 5756e2
</refsect1>
Packit 5756e2
<refsect1 role="details" id="gdbus-properties-org.freedesktop.NetworkManager.VPN.Connection">
Packit 5756e2
  <title role="details.title">Property Details</title>
Packit 5756e2
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.VpnState">
Packit 5756e2
  <title>The "VpnState" property</title>
Packit 5756e2
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.VpnState"><primary sortas="VpnConnection:VpnState">org.freedesktop.NetworkManager.VPN.Connection:VpnState</primary></indexterm>
Packit 5756e2
<programlisting>
Packit 5756e2
VpnState  readable   u
Packit 5756e2
</programlisting>
Packit 5756e2
<para>        The VPN-specific state of the connection.
Packit 5756e2
</para><para>        Returns: <link linkend="NMVpnConnectionState">NMVpnConnectionState</link>
Packit 5756e2
</para>
Packit 5756e2
</refsect2>
Packit 5756e2
<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.Banner">
Packit 5756e2
  <title>The "Banner" property</title>
Packit 5756e2
  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-VPN-Connection.Banner"><primary sortas="VpnConnection:Banner">org.freedesktop.NetworkManager.VPN.Connection:Banner</primary></indexterm>
Packit 5756e2
<programlisting>
Packit 5756e2
Banner  readable   s
Packit 5756e2
</programlisting>
Packit 5756e2
<para>        The banner string of the VPN connection.
Packit 5756e2
</para>
Packit 5756e2
</refsect2>
Packit 5756e2
</refsect1>
Packit 5756e2
</refentry>
Packit 5756e2