src/solidextras/org.freedesktop.portal.NetworkMonitor.xml

0001 <?xml version="1.0"?>
0002 <!--
0003  SPDX-FileCopyrightText: 2016 Red Hat Inc.
0004  SPDX-FileContributor: Matthias Clasen <mclasen@redhat.com>
0005
0006  SPDX-License-Identifier: LGPL-2.0-or-later
0007 -->
0008 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
0009   <!--
0010       org.freedesktop.portal.NetworkMonitor:
0011       @short_description: Network monitoring portal
0012
0013       The NetworkMonitor interface provides network status information
0014       to sandboxed applications. It is not a portal in the strict sense,
0015       since it does not involve user interaction. Applications are
0016       expected to use this interface indirectly, via a library API
0017       such as the GLib GNetworkMonitor interface.
0018
0019       This documentation describes version 3 of this interface.
0020   -->
0021   <interface name="org.freedesktop.portal.NetworkMonitor">
0022     <!--
0023         changed:
0024
0025         Emitted when the network configuration changes.
0026     -->
0027     <signal name="changed"/>
0028     <!--
0029         GetAvailable:
0030         @available: whether the network is available
0031
0032         Returns whether the network is considered available.
0033         That is, whether the system as a default route for
0034         at least one of IPv4 or IPv6.
0035
0036         This method was added in version 2 to replace
0037         the available property.
0038     -->
0039     <method name="GetAvailable">
0040       <arg type='b' name='available' direction='out'/>
0041     </method>
0042     <!--
0043         GetMetered:
0044         @metered: whether the network is metered
0045
0046         Returns whether the network is considered metered.
0047         That is, whether the system as traffic flowing through
0048         the default connection that is subject ot limitations
0049         by service providers.
0050
0051         This method was added in version 2 to replace
0052         the metered property.
0053     -->
0054     <method name="GetMetered">
0055       <arg type='b' name='metered' direction='out'/>
0056     </method>
0057     <!--
0058         GetConnectivity:
0059         @connectivity: the level of connectivity
0060
0061         Returns more detailed information about the host's network
0062         connectivity. The meaning of the value is:
0063         <simplelist>
0064           <member>1: Local only. The host is not configured with a route to the internet.</member>
0065           <member>2: Limited connectivity. The host is connected to a network, but can't reach the full internet.</member>
0066           <member>3: Captive portal. The host is behind a captive portal and cannot reach the full internet.</member>
0067           <member>4: Full network. The host connected to a network, and can reach the full internet.</member>
0068         </simplelist>
0069
0070         This method was added in version 2 to replace
0071         the connectivity property.
0072     -->
0073     <method name="GetConnectivity">
0074       <arg type='u' name='connectivity' direction='out'/>
0075     </method>
0076     <!--
0077         GetStatus:
0078         @status: a dictionary with the current values
0079
0080         Returns the three values all at once.
0081
0082         The following results get returned via @status:
0083         <variablelist>
0084           <varlistentry>
0085             <term>available b</term>
0086             <listitem><para>
0087               Whether the network is available.
0088             </para></listitem>
0089           </varlistentry>
0090           <varlistentry>
0091             <term>metered b</term>
0092             <listitem><para>
0093               Whether the network is metered.
0094             </para></listitem>
0095           </varlistentry>
0096           <varlistentry>
0097             <term>connectivity u</term>
0098             <listitem><para>
0099               The level of connectivity.
0100             </para></listitem>
0101           </varlistentry>
0102         </variablelist>
0103
0104         This method was added in version 3 to avoid multiple round-trips.
0105     -->
0106     <method name="GetStatus">
0107       <arg type='a{sv}' name='status' direction='out'/>
0108       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="QVariantMap" />
0109     </method>
0110
0111     <!--
0112         CanReach:
0113         @hostname: the hostname to reach
0114         @port: the port to reach
0115         @reachable: Whether the hostname:port was reachable
0116
0117         Returns whether the given hostname is believed to be reachable.
0118         This method was added in version 3.
0119     -->
0120     <method name="CanReach">
0121       <arg type='s' name='hostname' direction='in'/>
0122       <arg type='u' name='port' direction='in'/>
0123       <arg type='b' name='reachable' direction='out'/>
0124     </method>
0125
0126     <property name="version" type="u" access="read"/>
0127   </interface>
0128 </node>