diff options
Diffstat (limited to 'docs/libnm/html/NMRemoteConnection.html')
| -rw-r--r-- | docs/libnm/html/NMRemoteConnection.html | 135 |
1 files changed, 25 insertions, 110 deletions
diff --git a/docs/libnm/html/NMRemoteConnection.html b/docs/libnm/html/NMRemoteConnection.html index b415e3c0..efa6bcd8 100644 --- a/docs/libnm/html/NMRemoteConnection.html +++ b/docs/libnm/html/NMRemoteConnection.html @@ -8,17 +8,14 @@ <link rel="up" href="ch03.html" title="Connection and Setting API Reference"> <link rel="prev" href="NMSimpleConnection.html" title="NMSimpleConnection"> <link rel="next" href="NMSetting.html" title="NMSetting"> -<meta name="generator" content="GTK-Doc V1.29.1 (XML mode)"> +<meta name="generator" content="GTK-Doc V1.29 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> <td width="100%" align="left" class="shortcuts"> <a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> - <a href="#NMRemoteConnection.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span> - <a href="#NMRemoteConnection.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_interfaces"> <span class="dim">|</span> - <a href="#NMRemoteConnection.implemented-interfaces" class="shortcut">Implemented Interfaces</a></span><span id="nav_properties"> <span class="dim">|</span> - <a href="#NMRemoteConnection.properties" class="shortcut">Properties</a></span> + <a href="#NMRemoteConnection.description" class="shortcut">Description</a></span> </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch03.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> @@ -189,39 +186,6 @@ </table></div> </div> <div class="refsect1"> -<a name="NMRemoteConnection.properties"></a><h2>Properties</h2> -<div class="informaltable"><table class="informaltable" border="0"> -<colgroup> -<col width="150px" class="properties_type"> -<col width="300px" class="properties_name"> -<col width="200px" class="properties_flags"> -</colgroup> -<tbody> -<tr> -<td class="property_type"> -<a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</td> -<td class="property_name"><a class="link" href="NMRemoteConnection.html#NMRemoteConnection--filename" title="The “filename” property">filename</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></td> -<td class="property_name"><a class="link" href="NMRemoteConnection.html#NMRemoteConnection--flags" title="The “flags” property">flags</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> -<td class="property_name"><a class="link" href="NMRemoteConnection.html#NMRemoteConnection--unsaved" title="The “unsaved” property">unsaved</a></td> -<td class="property_flags">Read</td> -</tr> -<tr> -<td class="property_type"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></td> -<td class="property_name"><a class="link" href="NMRemoteConnection.html#NMRemoteConnection--visible" title="The “visible” property">visible</a></td> -<td class="property_flags">Read</td> -</tr> -</tbody> -</table></div> -</div> -<div class="refsect1"> <a name="NMRemoteConnection.other"></a><h2>Types and Values</h2> <div class="informaltable"><table class="informaltable" width="100%" border="0"> <colgroup> @@ -253,27 +217,10 @@ <td class="define_keyword">#define</td> <td class="function_name"><a class="link" href="NMRemoteConnection.html#NM-REMOTE-CONNECTION-VISIBLE:CAPS" title="NM_REMOTE_CONNECTION_VISIBLE">NM_REMOTE_CONNECTION_VISIBLE</a></td> </tr> -<tr> -<td class="datatype_keyword"> </td> -<td class="function_name"><a class="link" href="NMRemoteConnection.html#NMRemoteConnection-struct" title="NMRemoteConnection">NMRemoteConnection</a></td> -</tr> </tbody> </table></div> </div> <div class="refsect1"> -<a name="NMRemoteConnection.object-hierarchy"></a><h2>Object Hierarchy</h2> -<pre class="screen"> <a href="https://developer.gnome.org/gobject/unstable/gobject-The-Base-Object-Type.html#GObject-struct">GObject</a> - <span class="lineart">╰──</span> <a class="link" href="NMObject.html" title="NMObject">NMObject</a> - <span class="lineart">╰──</span> NMRemoteConnection -</pre> -</div> -<div class="refsect1"> -<a name="NMRemoteConnection.implemented-interfaces"></a><h2>Implemented Interfaces</h2> -<p> -NMRemoteConnection implements - <a href="https://developer.gnome.org/gio/unstable/GInitable.html#GInitable-struct">GInitable</a>, <a href="https://developer.gnome.org/gio/unstable/GAsyncInitable.html#GAsyncInitable-struct">GAsyncInitable</a> and <a class="link" href="NMConnection.html" title="NMConnection">NMConnection</a>.</p> -</div> -<div class="refsect1"> <a name="NMRemoteConnection.description"></a><h2>Description</h2> <p>A <a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection"><span class="type">NMRemoteConnection</span></a> represents a connection that is exported via NetworkManager D-Bus interface.</p> @@ -378,8 +325,9 @@ nm_remote_connection_update2_finish (<em class="parameter"><code><a class="link" </div> <div class="refsect3"> <a name="nm-remote-connection-update2-finish.returns"></a><h4>Returns</h4> -<p> on success, a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type "a{sv}" with the result. On failure, -<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.</p> +<p>on success, a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type "a{sv}" with the result. On failure, +<a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> @@ -390,6 +338,10 @@ nm_remote_connection_commit_changes (<em class="parameter"><code><a class="link" <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> save_to_disk</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">nm_remote_connection_commit_changes</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p> +<p>, use <a class="link" href="NMRemoteConnection.html#nm-remote-connection-commit-changes-async" title="nm_remote_connection_commit_changes_async ()"><code class="function">nm_remote_connection_commit_changes_async()</code></a> or GDBusConnection</p> +</div> <p>Send any local changes to the settings and properties of <em class="parameter"><code>connection</code></em> to NetworkManager. If <em class="parameter"><code>save_to_disk</code></em> @@ -537,6 +489,10 @@ will be set.</p> nm_remote_connection_save (<em class="parameter"><code><a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection"><span class="type">NMRemoteConnection</span></a> *connection</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">nm_remote_connection_save</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p> +<p>, use <a class="link" href="NMRemoteConnection.html#nm-remote-connection-save-async" title="nm_remote_connection_save_async ()"><code class="function">nm_remote_connection_save_async()</code></a> or GDBusConnection</p> +</div> <p>Saves the connection to disk if the connection has changes that have not yet been written to disk, or if the connection has never been saved.</p> <div class="refsect3"> @@ -664,6 +620,10 @@ will be set.</p> nm_remote_connection_delete (<em class="parameter"><code><a class="link" href="NMRemoteConnection.html" title="NMRemoteConnection"><span class="type">NMRemoteConnection</span></a> *connection</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">nm_remote_connection_delete</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p> +<p>, use <a class="link" href="NMRemoteConnection.html#nm-remote-connection-delete-async" title="nm_remote_connection_delete_async ()"><code class="function">nm_remote_connection_delete_async()</code></a> or GDBusConnection</p> +</div> <p>Deletes the connection.</p> <div class="refsect3"> <a name="nm-remote-connection-delete.parameters"></a><h4>Parameters</h4> @@ -790,6 +750,10 @@ nm_remote_connection_get_secrets (<em class="parameter"><code><a class="link" hr <em class="parameter"><code>const <span class="type">char</span> *setting_name</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a> *cancellable</code></em>, <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre> +<div class="warning"> +<p><code class="literal">nm_remote_connection_get_secrets</code> has been deprecated since version 1.22 and should not be used in newly-written code.</p> +<p>, use <a class="link" href="NMRemoteConnection.html#nm-remote-connection-get-secrets-async" title="nm_remote_connection_get_secrets_async ()"><code class="function">nm_remote_connection_get_secrets_async()</code></a> or GDBusConnection</p> +</div> <p>Request the connection's secrets. Note that this is a blocking D-Bus call, not a simple property accessor.</p> <div class="refsect3"> @@ -826,9 +790,10 @@ not a simple property accessor.</p> </div> <div class="refsect3"> <a name="nm-remote-connection-get-secrets.returns"></a><h4>Returns</h4> -<p> a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type <code class="literal">NM_VARIANT_TYPE_CONNECTION</code> containing +<p>a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type <code class="literal">NM_VARIANT_TYPE_CONNECTION</code> containing <em class="parameter"><code>connection</code></em> -'s secrets, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error.</p> +'s secrets, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on error. </p> +<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p> </div> </div> <hr> @@ -1076,59 +1041,9 @@ user, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.ht <pre class="programlisting">#define NM_REMOTE_CONNECTION_VISIBLE "visible" </pre> </div> -<hr> -<div class="refsect2"> -<a name="NMRemoteConnection-struct"></a><h3>NMRemoteConnection</h3> -<pre class="programlisting">typedef struct _NMRemoteConnection NMRemoteConnection;</pre> -</div> -</div> -<div class="refsect1"> -<a name="NMRemoteConnection.property-details"></a><h2>Property Details</h2> -<div class="refsect2"> -<a name="NMRemoteConnection--filename"></a><h3>The <code class="literal">“filename”</code> property</h3> -<pre class="programlisting"> “filename” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *</pre> -<p>File that stores the connection in case the connection is -file-backed.</p> -<p>Flags: Read</p> -<p>Default value: NULL</p> -<p class="since">Since: 1.12</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMRemoteConnection--flags"></a><h3>The <code class="literal">“flags”</code> property</h3> -<pre class="programlisting"> “flags” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a></pre> -<p>The flags of the connection as unsigned integer. The values -correspond to the <a class="link" href="libnm-nm-dbus-interface.html#NMSettingsConnectionFlags" title="enum NMSettingsConnectionFlags"><span class="type">NMSettingsConnectionFlags</span></a> enum.</p> -<p>Flags: Read</p> -<p>Default value: 0</p> -<p class="since">Since: 1.12</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMRemoteConnection--unsaved"></a><h3>The <code class="literal">“unsaved”</code> property</h3> -<pre class="programlisting"> “unsaved” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the remote connection contains changes that have not been saved -to disk, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if the connection is the same as its on-disk representation.</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> -<hr> -<div class="refsect2"> -<a name="NMRemoteConnection--visible"></a><h3>The <code class="literal">“visible”</code> property</h3> -<pre class="programlisting"> “visible” <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a></pre> -<p><a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the remote connection is visible to the current user, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> if -not. If the connection is not visible then it is essentially useless; it -will not contain any settings, and operations such as -<a class="link" href="NMRemoteConnection.html#nm-remote-connection-save" title="nm_remote_connection_save ()"><code class="function">nm_remote_connection_save()</code></a> and <a class="link" href="NMRemoteConnection.html#nm-remote-connection-delete" title="nm_remote_connection_delete ()"><code class="function">nm_remote_connection_delete()</code></a> will always -fail. (<span class="type">NMRemoteSettings</span> will not normally return non-visible connections -to callers, but it is possible for a connection's visibility to change -after you already have a reference to it.)</p> -<p>Flags: Read</p> -<p>Default value: FALSE</p> -</div> </div> </div> <div class="footer"> -<hr>Generated by GTK-Doc V1.29.1</div> +<hr>Generated by GTK-Doc V1.29</div> </body> </html> \ No newline at end of file |