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

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