New upstream version 1.5.90 upstream/1.5.90

1 files changed, 211 insertions, 0 deletions

diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml
new file mode 100644
index 00000000..2de23972
--- /dev/null
+++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml
@@ -0,0 +1,211 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
+]>
+<refentry id="gdbus-org.freedesktop.NetworkManager.Settings.Connection">
+  <refmeta>    <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection.top_of_page">org.freedesktop.NetworkManager.Settings.Connection</refentrytitle>
+  <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection.top_of_page"><primary sortas=".Settings.Connection">org.freedesktop.NetworkManager.Settings.Connection</primary></indexterm>
+  </refmeta>  <refnamediv>    <refname>org.freedesktop.NetworkManager.Settings.Connection</refname>    <refpurpose></refpurpose>  </refnamediv>  <refsynopsisdiv role="synopsis">
+    <title role="synopsis.title">Methods</title>
+    <synopsis>
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">Update</link>        (IN  a{sa{sv}} properties);
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved">UpdateUnsaved</link> (IN  a{sa{sv}} properties);
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete">Delete</link>        ();
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings">GetSettings</link>   (OUT a{sa{sv}} settings);
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSecrets">GetSecrets</link>    (IN  s         setting_name,
+               OUT a{sa{sv}} secrets);
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.ClearSecrets">ClearSecrets</link>  ();
+<link linkend="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">Save</link>          ();
+</synopsis>
+  </refsynopsisdiv>
+  <refsect1 role="signal_proto">
+    <title role="signal_proto.title">Signals</title>
+    <synopsis>
+<link linkend="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Updated">Updated</link>           ();
+<link linkend="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed">Removed</link>           ();
+<link linkend="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.PropertiesChanged">PropertiesChanged</link> (a{sv} properties);
+</synopsis>
+  </refsect1>
+  <refsect1 role="properties">
+    <title role="properties.title">Properties</title>
+    <synopsis>
+<link linkend="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Unsaved">Unsaved</link>  readable   b
+</synopsis>
+  </refsect1>
+<refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Settings-Connection">
+  <title role="desc.title">Description</title>
+  <para>      Represents a single network connection configuration.
+</para>
+</refsect1>
+<refsect1 role="details" id="gdbus-methods-org.freedesktop.NetworkManager.Settings.Connection">
+  <title role="details.title">Method Details</title>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update">
+  <title>The Update() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update"><primary sortas=".Settings.Connection.Update">org.freedesktop.NetworkManager.Settings.Connection.Update()</primary></indexterm>
+<programlisting>
+Update (IN  a{sa{sv}} properties);
+</programlisting>
+<para>        Update the connection with new settings and properties (replacing all
+        previous settings and properties) and save the connection to disk. Secrets
+        may be part of the update request, and will be either stored in persistent
+        storage or sent to a Secret Agent for storage, depending on the flags
+        associated with each secret.
+</para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term>
+  <listitem><para>New connection settings, properties, and (optionally) secrets.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved">
+  <title>The UpdateUnsaved() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved"><primary sortas=".Settings.Connection.UpdateUnsaved">org.freedesktop.NetworkManager.Settings.Connection.UpdateUnsaved()</primary></indexterm>
+<programlisting>
+UpdateUnsaved (IN  a{sa{sv}} properties);
+</programlisting>
+<para>        Update the connection with new settings and properties (replacing all
+        previous settings and properties) but do not immediately save the
+        connection to disk. Secrets may be part of the update request and may sent
+        to a Secret Agent for storage, depending on the flags associated with each
+        secret. Use the 'Save' method to save these changes to disk. Note that
+        unsaved changes will be lost if the connection is reloaded from disk
+        (either automatically on file change or due to an explicit
+        ReloadConnections call).
+</para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN a{sa{sv}} <parameter>properties</parameter></literal>:</term>
+  <listitem><para>New connection settings, properties, and (optionally) secrets.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete">
+  <title>The Delete() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete"><primary sortas=".Settings.Connection.Delete">org.freedesktop.NetworkManager.Settings.Connection.Delete()</primary></indexterm>
+<programlisting>
+Delete ();
+</programlisting>
+<para>        Delete the connection.
+</para>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings">
+  <title>The GetSettings() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSettings"><primary sortas=".Settings.Connection.GetSettings">org.freedesktop.NetworkManager.Settings.Connection.GetSettings()</primary></indexterm>
+<programlisting>
+GetSettings (OUT a{sa{sv}} settings);
+</programlisting>
+<para>        Get the settings maps describing this network configuration. This will
+        never include any secrets required for connection to the network, as those
+        are often protected. Secrets must be requested separately using the
+        GetSecrets() call.
+</para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>OUT a{sa{sv}} <parameter>settings</parameter></literal>:</term>
+  <listitem><para>The nested settings maps describing this object.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSecrets">
+  <title>The GetSecrets() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.GetSecrets"><primary sortas=".Settings.Connection.GetSecrets">org.freedesktop.NetworkManager.Settings.Connection.GetSecrets()</primary></indexterm>
+<programlisting>
+GetSecrets (IN  s         setting_name,
+            OUT a{sa{sv}} secrets);
+</programlisting>
+<para>        Get the secrets belonging to this network configuration. Only secrets from
+        persistent storage or a Secret Agent running in the requestor's session
+        will be returned. The user will never be prompted for secrets as a result
+        of this request.
+</para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>IN s <parameter>setting_name</parameter></literal>:</term>
+  <listitem><para>Name of the setting to return secrets for. If empty, all all secrets will be returned.</para></listitem>
+</varlistentry>
+<varlistentry>
+  <term><literal>OUT a{sa{sv}} <parameter>secrets</parameter></literal>:</term>
+  <listitem><para>Nested settings maps containing secrets.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.ClearSecrets">
+  <title>The ClearSecrets() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.ClearSecrets"><primary sortas=".Settings.Connection.ClearSecrets">org.freedesktop.NetworkManager.Settings.Connection.ClearSecrets()</primary></indexterm>
+<programlisting>
+ClearSecrets ();
+</programlisting>
+<para>        Clear the secrets belonging to this network connection profile.
+</para>
+</refsect2>
+<refsect2 role="method" id="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save">
+  <title>The Save() method</title>
+  <indexterm zone="gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Save"><primary sortas=".Settings.Connection.Save">org.freedesktop.NetworkManager.Settings.Connection.Save()</primary></indexterm>
+<programlisting>
+Save ();
+</programlisting>
+<para>        Saves a "dirty" connection (that had previously been updated with
+        UpdateUnsaved) to persistent storage.
+</para>
+</refsect2>
+</refsect1>
+<refsect1 role="details" id="gdbus-signals-org.freedesktop.NetworkManager.Settings.Connection">
+  <title role="details.title">Signal Details</title>
+<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Updated">
+  <title>The "Updated" signal</title>
+  <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Updated"><primary sortas=".Settings.Connection::Updated">org.freedesktop.NetworkManager.Settings.Connection::Updated</primary></indexterm>
+<programlisting>
+Updated ();
+</programlisting>
+<para>        Emitted when any settings or permissions change. When handling this
+        signal, clients should re-read the connection using the GetSettings method
+        to get the changes and to ensure the client still has permission to access
+        the connection.
+</para>
+</refsect2>
+<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed">
+  <title>The "Removed" signal</title>
+  <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.Removed"><primary sortas=".Settings.Connection::Removed">org.freedesktop.NetworkManager.Settings.Connection::Removed</primary></indexterm>
+<programlisting>
+Removed ();
+</programlisting>
+<para>        Emitted when this connection is no longer available. This happens when the
+        connection is deleted or if it is no longer accessible by any of the
+        system's logged-in users. After receipt of this signal, the object no
+        longer exists. Also see the Settings.ConnectionRemoved signal.
+</para>
+</refsect2>
+<refsect2 role="signal" id="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.PropertiesChanged">
+  <title>The "PropertiesChanged" signal</title>
+  <indexterm zone="gdbus-signal-org-freedesktop-NetworkManager-Settings-Connection.PropertiesChanged"><primary sortas=".Settings.Connection::PropertiesChanged">org.freedesktop.NetworkManager.Settings.Connection::PropertiesChanged</primary></indexterm>
+<programlisting>
+PropertiesChanged (a{sv} properties);
+</programlisting>
+<para>        DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
+</para>
+<variablelist role="params">
+<varlistentry>
+  <term><literal>a{sv} <parameter>properties</parameter></literal>:</term>
+  <listitem><para>A dictionary mapping property names to variant boxed values.</para></listitem>
+</varlistentry>
+</variablelist>
+</refsect2>
+</refsect1>
+<refsect1 role="details" id="gdbus-properties-org.freedesktop.NetworkManager.Settings.Connection">
+  <title role="details.title">Property Details</title>
+<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Unsaved">
+  <title>The "Unsaved" property</title>
+  <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Settings-Connection.Unsaved"><primary sortas=".Settings.Connection:Unsaved">org.freedesktop.NetworkManager.Settings.Connection:Unsaved</primary></indexterm>
+<programlisting>
+Unsaved  readable   b
+</programlisting>
+<para>        If set, indicates that the in-memory state of the connection does not
+        match the on-disk state. This flag will be set when UpdateUnsaved() is
+        called or when any connection details change, and cleared when the
+        connection is saved to disk via Save() or from internal operations.
+</para>
+</refsect2>
+</refsect1>
+</refentry>
+