org.freedesktop.portal.Account.xml

<?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.Account:
      @short_description: Portal for obtaining information about the user

      This simple interface lets sandboxed applications query basic
      information about the user, like his name and avatar photo.
  -->
  <interface name="org.freedesktop.portal.Account">
    <!--
        GetUserInformation:
        @window: Identifier for the window
        @handle: Object path for the #org.freedesktop.portal.Request object representing this call

        Gets information about the user.

        Supported keys in the @options vardict include:
        <variablelist>
          <varlistentry>
            <term>reason s</term>
            <listitem><para>
              A string that can be shown in the dialog to expain why the information is needed.
              This should be a complete sentence that explains what the application will do with
              the returned information, for example: Allows your personal information to be included
              with recipes you share with your friends.
            </para></listitem>•
          </varlistentry>
        </variablelist>

        The following results get returned via the #org.freedesktop.portal.Request::Response signal:
        <variablelist>
          <varlistentry>
            <term>id s</term>
            <listitem><para>
              The user id.
            </para></listitem>
          </varlistentry>
          <varlistentry>
            <term>name s</term>
            <listitem>
              <para>
                The users real name.
              </para>
            </listitem>
          </varlistentry>
          <varlistentry>
            <term>image s</term>
            <listitem>
              <para>
                The uri of an image file for the users avatar photo.
              </para>
            </listitem>
          </varlistentry>
        </variablelist>
    -->
    <method name="GetUserInformation">
      <arg type="s" name="window" direction="in"/>
      <arg type="a{sv}" name="options" direction="in"/>
      <arg type="o" name="handle" direction="out"/>
    </method>
  </interface>
</node>