<?xml version="1.0"?>
<!--
 Copyright (C) 2016 Red Hat, Inc.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library. If not, see <http://www.gnu.org/licenses/>.

 Author: Matthias Clasen <mclasen@redhat.com>
-->

<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
  <!--
      org.freedesktop.portal.Inhibit:
      @short_description: Portal for inhibiting session transitions

      This simple interface lets sandboxed applications inhibit the user
      session from ending, suspending, idling or getting switched away.

      This documentation describes version 1 of this interface.
  -->
  <interface name="org.freedesktop.portal.Inhibit">
    <!--
        Inhibit:
        @window: Identifier for the window
        @flags: Flags identifying what is inhibited
        @options: Vardict with optional further information
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call

        Inhibits a session status changes. To remove the inhibition,
        call org.freedesktop.portal.Request.Close() on the returned
        handle.

        The flags determine what changes are inhibited:
        <simplelist>
          <member>1: Logout</member>
          <member>2: User Switch</member>
          <member>4: Suspend</member>
          <member>8: Idle</member>
        </simplelist>

        Supported keys in the @options vardict include:
        <variablelist>
          <varlistentry>
            <term>handle_token s</term>
            <listitem><para>
              A string that will be used as the last element of the @handle. Must be a valid
              object path element. See the #org.freedesktop.portal.Request documentation for
              more information about the @handle.
            </para></listitem>
          </varlistentry>
          <varlistentry>
            <term>reason s</term>
            <listitem><para>User-visible reason for the inhibition.</para></listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="Inhibit">
      <arg type="s" name="window" direction="in"/>
      <arg type="u" name="flags" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <arg type="o" name="handle" direction="out"/>
    </method>
    <property name="version" type="u" access="read"/>
  </interface>
</node>
