diff options
| author | Michael Biebl <biebl@debian.org> | 2017-05-11 14:55:55 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2017-05-11 14:55:55 +0200 |
| commit | c333f062ddcba9b35330647bf6cbd0a07f2d786e (patch) | |
| tree | 257c3a0c74c09f4ad2328eab5b932806405f0c1c /docs/api/dbus-org.freedesktop.NetworkManager.xml | |
| parent | a222e56e103f949b148a6942e385ccca2c26d9f3 (diff) | |
New upstream version 1.8.0 upstream/1.8.0
Diffstat (limited to 'docs/api/dbus-org.freedesktop.NetworkManager.xml')
| -rw-r--r-- | docs/api/dbus-org.freedesktop.NetworkManager.xml | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.xml b/docs/api/dbus-org.freedesktop.NetworkManager.xml index f8f7c5ab..0ef23d79 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.xml @@ -5,7 +5,7 @@ <refentry id="gdbus-org.freedesktop.NetworkManager"> <refmeta> <refentrytitle role="top_of_page" id="gdbus-interface-org-freedesktop-NetworkManager.top_of_page">org.freedesktop.NetworkManager</refentrytitle> <indexterm zone="gdbus-interface-org-freedesktop-NetworkManager.top_of_page"><primary sortas="Manager">org.freedesktop.NetworkManager</primary></indexterm> - </refmeta> <refnamediv> <refname>org.freedesktop.NetworkManager</refname> <refpurpose></refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> + </refmeta> <refnamediv> <refname>org.freedesktop.NetworkManager</refname> <refpurpose>Connection Manager</refpurpose> </refnamediv> <refsynopsisdiv role="synopsis"> <title role="synopsis.title">Methods</title> <synopsis> <link linkend="gdbus-method-org-freedesktop-NetworkManager.Reload">Reload</link> (IN u flags); @@ -705,6 +705,13 @@ Capabilities readable au State readable u </programlisting> <para> The overall state of the NetworkManager daemon. +</para><para> This takes state of all active connections and the connectivity state into account + to produce a single indicator of the network accessibility status. +</para><para> The graphical shells may use this property to provide network connection status + indication and applications may use this to check if Internet connection is + accessible. Shell that is able to cope with captive portals should use the + "Connectivity" property to decide whether to present a captive portal authentication + dialog. </para><para> Returns: <link linkend="NMState">NMState</link> </para> </refsect2> @@ -714,7 +721,17 @@ State readable u <programlisting> Connectivity readable u </programlisting> -<para> The network connectivity state. +<para> The result of the last connectivity check. The connectivity check is triggered + automatically when a default connection becomes available, periodically and by + calling a CheckConnectivity() method. +</para><para> This property is in general useful for the graphical shell to determine whether + the Internet access is being hijacked by an authentication gateway (a "captive + portal"). In such case it would typically present a web browser window to give + the user a chance to authenticate and call CheckConnectivity() when the user + submits a form or dismisses the window. +</para><para> To determine the whether the user is able to access the Internet without dealing + with captive portals (e.g. to provide a network connection indicator or disable + controls that require Internet access), the "State" property is more suitable. </para><para> Returns: <link linkend="NMConnectivityState">NMConnectivityState</link> </para> </refsect2> |