Warning, /libraries/xdg-portal-test-kde/src/org.freedesktop.portal.Request.xml is written in an unsupported language. File is not indexed.
0001 <?xml version="1.0"?> 0002 <!-- 0003 Copyright (C) 2015 Red Hat, Inc. 0004 0005 This library is free software; you can redistribute it and/or 0006 modify it under the terms of the GNU Lesser General Public 0007 License as published by the Free Software Foundation; either 0008 version 2 of the License, or (at your option) any later version. 0009 0010 This library is distributed in the hope that it will be useful, 0011 but WITHOUT ANY WARRANTY; without even the implied warranty of 0012 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 0013 Lesser General Public License for more details. 0014 0015 You should have received a copy of the GNU Lesser General Public 0016 License along with this library. If not, see <http://www.gnu.org/licenses/>. 0017 0018 Author: Alexander Larsson <alexl@redhat.com> 0019 --> 0020 0021 <node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd"> 0022 <!-- 0023 org.freedesktop.portal.Request: 0024 @short_description: Shared request interface 0025 0026 The Request interface is shared by all portal interfaces. When a 0027 portal method is called, the reply includes a handle (i.e. object path) 0028 for a Request object, which will stay alive for the duration of the 0029 user interaction related to the method call. 0030 0031 The portal indicates that a portal request interaction is over by 0032 emitting the #org.freedesktop.portal.Request::Response signal on the 0033 Request object. 0034 0035 The application can abort the interaction calling 0036 org.freedesktop.portal.Request.Close() on the Request object. 0037 0038 Since version 0.9 of xdg-desktop-portal, the handle will be of the form 0039 /org/freedesktop/portal/desktop/request/SENDER/TOKEN, 0040 where SENDER is the callers unique name, with the initial ':' removed and 0041 all '.' replaced by '_', and TOKEN is a unique token that the caller provided 0042 with the handle_token key in the options vardict. 0043 0044 This change was made to let applications subscribe to the Response signal before 0045 making the initial portal call, thereby avoiding a race condition. It is recommended 0046 that the caller should verify that the returned handle is what it expected, and update 0047 its signal subscription if it isn't. This ensures that applications will work with both 0048 old and new versions of xdg-desktop-portal. 0049 0050 The token that the caller provides should be unique and not guessable. To avoid clashes 0051 with calls made from unrelated libraries, it is a good idea to use a per-library prefix 0052 combined with a random number. 0053 --> 0054 <interface name="org.freedesktop.portal.Request"> 0055 0056 <!-- 0057 Close: 0058 0059 Closes the portal request to which this object refers and ends all 0060 related user interaction (dialogs, etc). 0061 A Response signal will not be emitted in this case. 0062 --> 0063 <method name="Close"> 0064 </method> 0065 0066 <!-- 0067 Response: 0068 @response: Numeric response 0069 @results: Vardict with results. The keys and values in the vardict depend on the request. 0070 0071 Emitted when the user interaction for a portal request is over. 0072 0073 The @response indicates how the user interaction ended: 0074 <simplelist> 0075 <member>0: Success, the request is carried out</member> 0076 <member>1: The user cancelled the interaction</member> 0077 <member>2: The user interaction was ended in some other way</member> 0078 </simplelist> 0079 --> 0080 <signal name="Response"> 0081 <arg type="u" name="response"/> 0082 <arg type="a{sv}" name="results"/> 0083 <annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMap"/> 0084 </signal> 0085 </interface> 0086 </node>