diff options
Diffstat (limited to 'docs/libnm/html/NMClient.html')
| -rw-r--r-- | docs/libnm/html/NMClient.html | 189 |
1 files changed, 181 insertions, 8 deletions
diff --git a/docs/libnm/html/NMClient.html b/docs/libnm/html/NMClient.html index 7ccbd977..e6387588 100644 --- a/docs/libnm/html/NMClient.html +++ b/docs/libnm/html/NMClient.html @@ -430,6 +430,22 @@ </tr> <tr> <td class="function_type"> +<span class="returnvalue">void</span> +</td> +<td class="function_name"> +<a class="link" href="NMClient.html#nm-client-add-and-activate-connection2" title="nm_client_add_and_activate_connection2 ()">nm_client_add_and_activate_connection2</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="returnvalue">NMActiveConnection</span></a> * +</td> +<td class="function_name"> +<a class="link" href="NMClient.html#nm-client-add-and-activate-connection2-finish" title="nm_client_add_and_activate_connection2_finish ()">nm_client_add_and_activate_connection2_finish</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> <a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> </td> <td class="function_name"> @@ -2770,6 +2786,161 @@ will be set. </p> </div> <hr> <div class="refsect2"> +<a name="nm-client-add-and-activate-connection2"></a><h3>nm_client_add_and_activate_connection2 ()</h3> +<pre class="programlisting"><span class="returnvalue">void</span> +nm_client_add_and_activate_connection2 + (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, + <em class="parameter"><code><a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> *partial</code></em>, + <em class="parameter"><code><a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a> *device</code></em>, + <em class="parameter"><code>const <span class="type">char</span> *specific_object</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *options</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/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a> callback</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> +<p>Adds a new connection using the given details (if any) as a template, +automatically filling in missing settings with the capabilities of the given +device and specific object. The new connection is then asynchronously +activated as with <a class="link" href="NMClient.html#nm-client-activate-connection-async" title="nm_client_activate_connection_async ()"><code class="function">nm_client_activate_connection_async()</code></a>. Cannot be used for +VPN connections at this time.</p> +<p>Note that the callback is invoked when NetworkManager has started activating +the new connection, not when it finishes. You can used the returned +<a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> object (in particular, <a class="link" href="NMActiveConnection.html#NMActiveConnection--state" title="The “state” property"><span class="type">“state”</span></a>) to +track the activation to its completion.</p> +<p>This is identitcal to <a class="link" href="NMClient.html#nm-client-add-and-activate-connection-async" title="nm_client_add_and_activate_connection_async ()"><code class="function">nm_client_add_and_activate_connection_async()</code></a> but takes +a further <em class="parameter"><code>options</code></em> + parameter. Currently the following options are supported +by the daemon:</p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p>"persist": A string describing how the connection should be stored. + The default is "disk", but it can be modified to "memory" (until + the daemon quits) or "volatile" (will be deleted on disconnect).</p></li> +<li class="listitem"><p>"bind-activation": Bind the connection lifetime to something. The default is "none", + meaning an explicit disconnect is needed. The value "dbus-client" + means the connection will automatically be deactivated when the calling + DBus client disappears from the system bus.</p></li> +</ul></div> +<div class="refsect3"> +<a name="nm-client-add-and-activate-connection2.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>client</p></td> +<td class="parameter_description"><p>a <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>partial</p></td> +<td class="parameter_description"><p>an <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a> to add; the connection may be +partially filled (or even <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>) and will be completed by NetworkManager +using the given <em class="parameter"><code>device</code></em> +and <em class="parameter"><code>specific_object</code></em> +before being added. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>device</p></td> +<td class="parameter_description"><p>the <a class="link" href="NMDevice.html" title="NMDevice"><span class="type">NMDevice</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>specific_object</p></td> +<td class="parameter_description"><p>the object path of a connection-type-specific +object this activation should use. This parameter is currently ignored for +wired and mobile broadband connections, and the value of <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> should be used +(ie, no specific object). For Wi-Fi or WiMAX connections, pass the object +path of a <a class="link" href="NMAccessPoint.html" title="NMAccessPoint"><span class="type">NMAccessPoint</span></a> or <a class="link" href="NMWimaxNsp.html" title="NMWimaxNsp"><span class="type">NMWimaxNsp</span></a> owned by <em class="parameter"><code>device</code></em> +, which you can +get using <a class="link" href="NMObject.html#nm-object-get-path" title="nm_object_get_path ()"><code class="function">nm_object_get_path()</code></a>, and which will be used to complete the +details of the newly added connection. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td> +</tr> +<tr> +<td class="parameter_name"><p>options</p></td> +<td class="parameter_description"><p>a <a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> containing a dictionary with options, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>cancellable</p></td> +<td class="parameter_description"><p>a <a href="https://developer.gnome.org/gio/unstable/GCancellable.html#GCancellable-struct"><span class="type">GCancellable</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>callback</p></td> +<td class="parameter_description"><p>callback to be called when the activation has started</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>user_data</p></td> +<td class="parameter_description"><p>caller-specific data passed to <em class="parameter"><code>callback</code></em> +</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<p class="since">Since: 1.16</p> +</div> +<hr> +<div class="refsect2"> +<a name="nm-client-add-and-activate-connection2-finish"></a><h3>nm_client_add_and_activate_connection2_finish ()</h3> +<pre class="programlisting"><a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="returnvalue">NMActiveConnection</span></a> * +nm_client_add_and_activate_connection2_finish + (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncResult-struct"><span class="type">GAsyncResult</span></a> *result</code></em>, + <em class="parameter"><code><a href="https://developer.gnome.org/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> **out_result</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> +<p>Gets the result of a call to <a class="link" href="NMClient.html#nm-client-add-and-activate-connection2" title="nm_client_add_and_activate_connection2 ()"><code class="function">nm_client_add_and_activate_connection2()</code></a>.</p> +<p>You can call <a class="link" href="NMActiveConnection.html#nm-active-connection-get-connection" title="nm_active_connection_get_connection ()"><code class="function">nm_active_connection_get_connection()</code></a> on the returned +<a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> to find the path of the created <a class="link" href="NMConnection.html" title="NMConnection"><span class="type">NMConnection</span></a>.</p> +<div class="refsect3"> +<a name="nm-client-add-and-activate-connection2-finish.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>client</p></td> +<td class="parameter_description"><p>an <a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>result</p></td> +<td class="parameter_description"><p>the result passed to the <a href="https://developer.gnome.org/gio/unstable/GAsyncResult.html#GAsyncReadyCallback"><span class="type">GAsyncReadyCallback</span></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>error</p></td> +<td class="parameter_description"><p>location for a <a href="https://developer.gnome.org/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a>, or <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a></p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>out_result</p></td> +<td class="parameter_description"><p>the output result +of type "a{sv}" returned by D-Bus' AddAndActivate2 call. Currently no +output is implemented yet. </p></td> +<td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>][<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="nm-client-add-and-activate-connection2-finish.returns"></a><h4>Returns</h4> +<p>the new <a class="link" href="NMActiveConnection.html" title="NMActiveConnection"><span class="type">NMActiveConnection</span></a> on success, <a href="https://developer.gnome.org/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> on +failure, in which case <em class="parameter"><code>error</code></em> +will be set. </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> +<div class="refsect2"> <a name="nm-client-deactivate-connection"></a><h3>nm_client_deactivate_connection ()</h3> <pre class="programlisting"><a href="https://developer.gnome.org/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> nm_client_deactivate_connection (<em class="parameter"><code><a class="link" href="NMClient.html" title="NMClient"><span class="type">NMClient</span></a> *client</code></em>, @@ -4339,6 +4510,13 @@ clients can obtain to perform certain tasks on behalf of the current user.</p> <td class="enum_member_annotations"> </td> </tr> <tr> +<td class="enum_member_name"><p><a name="NM-CLIENT-PERMISSION-WIFI-SCAN:CAPS"></a>NM_CLIENT_PERMISSION_WIFI_SCAN</p></td> +<td class="enum_member_description"> +<p>controls whether wifi scans can be performed</p> +</td> +<td class="enum_member_annotations"> </td> +</tr> +<tr> <td class="enum_member_name"><p><a name="NM-CLIENT-PERMISSION-LAST:CAPS"></a>NM_CLIENT_PERMISSION_LAST</p></td> <td class="enum_member_description"> <p>a reserved boundary value</p> @@ -4541,14 +4719,9 @@ permission to read the details of.)</p> <div class="refsect2"> <a name="NMClient--dns-configuration"></a><h3>The <code class="literal">“dns-configuration”</code> property</h3> <pre class="programlisting"> “dns-configuration” <a href="https://developer.gnome.org/glib/unstable/glib-Pointer-Arrays.html#GPtrArray"><span class="type">GPtrArray</span></a> *</pre> -<p>The current DNS configuration represented as an array of -dictionaries. Each dictionary has the "nameservers", -"priority" keys and, optionally, "interface" and "vpn". -"nameservers" is the list of DNS servers, "priority" their -relative priority, "interface" the interface on which these -servers are contacted, "vpn" a boolean telling whether the -configuration was obtained from a VPN connection.</p> -<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(GVariant)]</span></p> +<p>The current DNS configuration, represented as an array +of <a class="link" href="NMClient.html#NMDnsEntry"><span class="type">NMDnsEntry</span></a> objects.</p> +<p><span class="annotation">[<acronym title="Override the parsed C type with given type."><span class="acronym">type</span></acronym> GPtrArray(NMDnsEntry)]</span></p> <p>Flags: Read</p> <p class="since">Since: 1.6</p> </div> |