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

Packit ae235b
Packit ae235b
Packit ae235b
 Copyright (C) 2016 Red Hat, Inc.
Packit ae235b
Packit ae235b
 This library is free software; you can redistribute it and/or
Packit ae235b
 modify it under the terms of the GNU Lesser General Public
Packit ae235b
 License as published by the Free Software Foundation; either
Packit ae235b
 version 2.1 of the License, or (at your option) any later version.
Packit ae235b
Packit ae235b
 This library is distributed in the hope that it will be useful,
Packit ae235b
 but WITHOUT ANY WARRANTY; without even the implied warranty of
Packit ae235b
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Packit ae235b
 Lesser General Public License for more details.
Packit ae235b
Packit ae235b
 You should have received a copy of the GNU Lesser General Public
Packit ae235b
 License along with this library. If not, see <http://www.gnu.org/licenses/>.
Packit ae235b
Packit ae235b
 Author: Matthias Clasen <mclasen@redhat.com>
Packit ae235b
-->
Packit ae235b
Packit ae235b
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
Packit ae235b
  
Packit ae235b
       org.freedesktop.portal.OpenURI:
Packit ae235b
       @short_description: Portal for opening URIs
Packit ae235b
Packit ae235b
       The OpenURI portal allows sandboxed applications to open
Packit ae235b
       URIs (e.g. a http: link to the applications homepage)
Packit ae235b
       under the control of the user.
Packit ae235b
  -->
Packit ae235b
  <interface name="org.freedesktop.portal.OpenURI">
Packit ae235b
    
Packit ae235b
        OpenURI:
Packit ae235b
        @parent_window: Identifier for the application window
Packit ae235b
        @uri: The uri to open
Packit ae235b
        @options: Vardict with optional further onformation
Packit ae235b
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call
Packit ae235b
Packit ae235b
        Asks to open a uri.
Packit ae235b
Packit ae235b
        The @parent_window identifier must be of the form "x11:$XID" for an X11
Packit ae235b
        window. Support for other window systems may be added in the future.
Packit ae235b
Packit ae235b
        Note that file:// uris are explicitly not supported by this method.
Packit ae235b
        To request opening local files, use org.freedesktop.portal.OpenFile().
Packit ae235b
Packit ae235b
        Supported keys in the @options vardict include:
Packit ae235b
        <variablelist>
Packit ae235b
          <varlistentry>
Packit ae235b
            <term>writable b</term>
Packit ae235b
            <listitem><para>
Packit ae235b
              Whether to allow the chosen application to write to the file.
Packit ae235b
            </para><para>
Packit ae235b
              This key only takes effect the uri points to a local file that
Packit ae235b
              is exported in the document portal, and the chosen application
Packit ae235b
              is sandboxed itself.
Packit ae235b
            </para></listitem>
Packit ae235b
          </varlistentry>
Packit ae235b
        </variablelist>
Packit ae235b
Packit ae235b
    -->
Packit ae235b
    <method name="OpenURI">
Packit ae235b
      <arg type="s" name="parent_window" direction="in"/>
Packit ae235b
      <arg type="s" name="uri" direction="in"/>
Packit ae235b
      <arg type="a{sv}" name="options" direction="in"/>
Packit ae235b
      <arg type="o" name="handle" direction="out"/>
Packit ae235b
    </method>
Packit ae235b
Packit ae235b
    
Packit ae235b
        OpenFile:
Packit ae235b
        @parent_window: Identifier for the application window
Packit ae235b
        @fd: File descriptor for the file to open
Packit ae235b
        @options: Vardict with optional further onformation
Packit ae235b
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call
Packit ae235b
Packit ae235b
        Asks to open a local file.
Packit ae235b
Packit ae235b
        The @parent_window identifier must be of the form "x11:$XID" for an X11
Packit ae235b
        window. Support for other window systems may be added in the future.
Packit ae235b
Packit ae235b
        Supported keys in the @options vardict include:
Packit ae235b
        <variablelist>
Packit ae235b
          <varlistentry>
Packit ae235b
            <term>writable b</term>
Packit ae235b
            <listitem><para>
Packit ae235b
              Whether to allow the chosen application to write to the file.
Packit ae235b
            </para><para>
Packit ae235b
              This key only takes effect the uri points to a local file that
Packit ae235b
              is exported in the document portal, and the chosen application
Packit ae235b
              is sandboxed itself.
Packit ae235b
            </para></listitem>
Packit ae235b
          </varlistentry>
Packit ae235b
        </variablelist>
Packit ae235b
Packit ae235b
        The OpenFile method was introduced in version 2 of the OpenURI portal API.
Packit ae235b
    -->
Packit ae235b
    <method name="OpenFile">
Packit ae235b
      <arg type="s" name="parent_window" direction="in"/>
Packit ae235b
      <arg type="h" name="fd" direction="in"/>
Packit ae235b
      <arg type="a{sv}" name="options" direction="in"/>
Packit ae235b
      <arg type="o" name="handle" direction="out"/>
Packit ae235b
    </method>
Packit ae235b
Packit ae235b
    <property name="version" type="u" access="read"/>
Packit ae235b
  </interface>
Packit ae235b
</node>