Blame gio/org.freedesktop.portal.NetworkMonitor.xml

Packit 84794d
Packit 84794d
Packit 84794d
 Copyright (C) 2016 Red Hat, Inc.
Packit 84794d
Packit 84794d
 This library is free software; you can redistribute it and/or
Packit 84794d
 modify it under the terms of the GNU Lesser General Public
Packit 84794d
 License as published by the Free Software Foundation; either
Packit 84794d
 version 2 of the License, or (at your option) any later version.
Packit 84794d
Packit 84794d
 This library is distributed in the hope that it will be useful,
Packit 84794d
 but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit 84794d
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit 84794d
 Lesser General Public License for more details.
Packit 84794d
Packit 84794d
 You should have received a copy of the GNU Lesser General Public
Packit 84794d
 License along with this library. If not, see <http://www.gnu.org/licenses/>.
Packit 84794d
Packit 84794d
 Author: Matthias Clasen <mclasen@redhat.com>
Packit 84794d
-->
Packit 84794d
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
Packit 84794d
  
Packit 84794d
      org.freedesktop.portal.NetworkMonitor:
Packit 84794d
      @short_description: Network monitoring portal
Packit 84794d
Packit 84794d
      The NetworkMonitor interface provides network status information
Packit 84794d
      to sandboxed applications. It is not a portal in the strict sense,
Packit 84794d
      since it does not involve user interaction. Applications are
Packit 84794d
      expected to use this interface indirectly, via a library API
Packit 84794d
      such as the GLib GNetworkMonitor interface.
Packit 84794d
Packit 84794d
      This documentation describes version 2 of this interface.
Packit 84794d
  -->
Packit 84794d
  <interface name="org.freedesktop.portal.NetworkMonitor">
Packit 84794d
    
Packit 84794d
        changed:
Packit 84794d
Packit 84794d
        Emitted when the network configuration changes.
Packit 84794d
    -->
Packit 84794d
    <signal name="changed"/>
Packit 84794d
    
Packit 84794d
        GetAvailable:
Packit 84794d
        @available: whether the network is available
Packit 84794d
Packit 84794d
        Returns whether the network is considered available.
Packit 84794d
        That is, whether the system as a default route for
Packit 84794d
        at least one of IPv4 or IPv6.
Packit 84794d
Packit 84794d
        This method was added in version 2 to replace
Packit 84794d
        the available property.
Packit 84794d
    -->
Packit 84794d
    <method name="GetAvailable">
Packit 84794d
      <arg type='b' name='available' direction='out'/>
Packit 84794d
    </method>
Packit 84794d
    
Packit 84794d
        GetMetered:
Packit 84794d
        @metered: whether the network is metered
Packit 84794d
Packit 84794d
        Returns whether the network is considered metered.
Packit 84794d
        That is, whether the system as traffic flowing through
Packit 84794d
        the default connection that is subject ot limitations
Packit 84794d
        by service providers.
Packit 84794d
Packit 84794d
        This method was added in version 2 to replace
Packit 84794d
        the metered property.
Packit 84794d
    -->
Packit 84794d
    <method name="GetMetered">
Packit 84794d
      <arg type='b' name='metered' direction='out'/>
Packit 84794d
    </method>
Packit 84794d
    
Packit 84794d
        GetConnectivity:
Packit 84794d
        @connectivity: the level of connectivity
Packit 84794d
Packit 84794d
        Returs more detailed information about the host's network
Packit 84794d
        connectivity. The meaning of the value is:
Packit 84794d
        <simplelist>
Packit 84794d
          <member>1: Local only. The host is not configured with a route to the internet.</member>
Packit 84794d
          <member>2: Limited connectivity. The host is connected to a network, but can't reach the full internet.</member>
Packit 84794d
          <member>3: Captive portal. The host is behind a captive portal and cannot reach the full internet.</member>
Packit 84794d
          <member>4: Full network. The host connected to a network, and can reach the full internet.</member>
Packit 84794d
        </simplelist>
Packit 84794d
Packit 84794d
        This method was added in version 2 to replace
Packit 84794d
        the connectivity property.
Packit 84794d
    -->
Packit 84794d
    <method name="GetConnectivity">
Packit 84794d
      <arg type='u' name='connectivity' direction='out'/>
Packit 84794d
    </method>
Packit 84794d
    <property name="version" type="u" access="read"/>
Packit 84794d
  </interface>
Packit 84794d
</node>