gio/org.freedesktop.portal.ProxyResolver.xml

   1 <?xml version="1.0"?>
   2 <!--
   3  Copyright (C) 2016 Red Hat, Inc.
   4
   5  This library is free software; you can redistribute it and/or
   6  modify it under the terms of the GNU Lesser General Public
   7  License as published by the Free Software Foundation; either
   8  version 2 of the License, or (at your option) any later version.
   9
  10  This library is distributed in the hope that it will be useful,
  11  but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  Lesser General Public License for more details.
  14
  15  You should have received a copy of the GNU Lesser General Public
  16  License along with this library. If not, see <http://www.gnu.org/licenses/>.
  17
  18  Author: Matthias Clasen <mclasen@redhat.com>
  19 -->
  20 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  21   <!--
  22       org.freedesktop.portal.ProxyResolver:
  23       @short_description: Proxy information
  24
  25       The ProxyResolver interface provides network proxy information to sandboxed
  26       applications. It is not a portal in the strict sense, since it does not involve
  27       user interaction. Applications are expected to use this interface indirectly,
  28       via a library API such as the GLib GProxyResolver interface.
  29
  30       This documentation describes version 1 of this interface.
  31   -->
  32   <interface name="org.freedesktop.portal.ProxyResolver">
  33     <!--
  34         Lookup:
  35         @uri: Destination to connect to
  36         @proxies: List of proxy uris
  37
  38         Looks up which proxy to use to connect to @uri. The returned
  39         proxy uri are of the form 'protocol://[user[:password]@host:port'.
  40         The protocol can be http, rtsp, socks or another proxying protocol.
  41         'direct://' is used when no proxy is needed.
  42     -->
  43     <method name="Lookup">
  44       <arg type="s" name="uri" direction="in"/>
  45       <arg type="as" name="proxies" direction="out"/>
  46     </method>
  47     <property name="version" type="u" access="read"/>
  48   </interface>
  49 </node>