afb81b8278
Some checks failed
Docker. / Ubuntu (push) Has been cancelled
User-agent updater. / User-agent (push) Failing after 15s
Lock Threads / lock (push) Failing after 10s
Waiting for answer. / waiting-for-answer (push) Failing after 22s
Close stale issues and PRs / stale (push) Successful in 13s
Needs user action. / needs-user-action (push) Failing after 8s
Can't reproduce. / cant-reproduce (push) Failing after 8s
132 lines
5.2 KiB
XML
132 lines
5.2 KiB
XML
<?xml version="1.0"?>
|
|
<!--
|
|
Copyright (C) 2022 Matthew Leeds
|
|
|
|
SPDX-License-Identifier: LGPL-2.1-or-later
|
|
|
|
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.1 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: Matthew Leeds <mwleeds@protonmail.com>
|
|
-->
|
|
|
|
<node name="/" xmlns:doc="http://www.freedesktop.org/dbus/1.0/doc.dtd">
|
|
<!--
|
|
org.freedesktop.impl.portal.DynamicLauncher:
|
|
@short_description: Dynamic launcher portal backend interface
|
|
|
|
This documentation describes version 1 of this interface.
|
|
-->
|
|
<interface name="org.freedesktop.impl.portal.DynamicLauncher">
|
|
<!--
|
|
PrepareInstall:
|
|
@handle: Object path for the :ref:`org.freedesktop.impl.portal.Request` object representing this call
|
|
@app_id: App id of the application
|
|
@parent_window: Identifier for the application window, see :doc:`window-identifiers`
|
|
@name: The default name for the launcher
|
|
@icon_v: A #GBytesIcon as returned by g_icon_serialize()
|
|
@options: Vardict with optional further information
|
|
@response: Numeric response (0 == success)
|
|
@results: Vardict with the results of the call
|
|
|
|
Presents a dialog to the user to allow them to see the icon, potentially
|
|
change the name, and confirm installation of the launcher.
|
|
|
|
Supported keys in the @options vardict:
|
|
|
|
* ``modal`` (``b``)
|
|
|
|
Whether to make the dialog modal. Defaults to yes.
|
|
|
|
* ``launcher_type`` (``u``)
|
|
|
|
The type of launcher being created. For supported values see the
|
|
SupportedLauncherTypes property. Defaults to "Application".
|
|
|
|
* ``target`` (``s``)
|
|
|
|
For a launcher of type "Webapp", this is the URL of the web app
|
|
being installed. This is displayed in the user-facing dialog.
|
|
For other launcher types, this is not needed.
|
|
|
|
* ``editable_name`` (``b``)
|
|
|
|
If true, the user will be able to edit the name of the launcher.
|
|
Defaults to true.
|
|
|
|
* ``editable_icon`` (``b``)
|
|
|
|
If true, the user will be able to edit the icon of the launcher,
|
|
if the implementation supports this. Defaults to false.
|
|
|
|
The following results get returned via the @results vardict:
|
|
|
|
* ``name`` (``s``)
|
|
|
|
The name chosen by the user for the launcher (or the default if
|
|
the editable_name option was false).
|
|
|
|
* ``icon`` (``v``)
|
|
|
|
The icon chosen by the user for the launcher (or the default if
|
|
the ``editable_icon`` option was false).
|
|
-->
|
|
<method name="PrepareInstall">
|
|
<arg type="o" name="handle" direction="in"/>
|
|
<arg type="s" name="app_id" direction="in"/>
|
|
<arg type="s" name="parent_window" direction="in"/>
|
|
<arg type="s" name="name" direction="in"/>
|
|
<arg type="v" name="icon_v" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In5" value="QVariantMap"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<arg type="u" name="response" direction="out"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.Out1" value="QVariantMap"/>
|
|
<arg type="a{sv}" name="results" direction="out"/>
|
|
</method>
|
|
<!--
|
|
RequestInstallToken:
|
|
@app_id: App id of the application
|
|
@options: Vardict with optional further information
|
|
@response: 0 if the caller should be allowed to do non-interactive launcher installation, a nonzero number otherwise
|
|
|
|
The @response returned by this method is used to determine whether to
|
|
give an install token to the caller, which can be used to avoid the need
|
|
for a confirmation dialog; the token can be passed to the
|
|
:ref:`org.freedesktop.portal.DynamicLauncher.Install` method just as if it
|
|
were acquired via the
|
|
:ref:`org.freedesktop.portal.DynamicLauncher.PrepareInstall` method.
|
|
|
|
It is up to the portal implementation to decide whether this method is
|
|
allowed based on the @app_id of the caller.
|
|
|
|
The @options vardict currently has no supported entries.
|
|
-->
|
|
<method name="RequestInstallToken">
|
|
<arg type="s" name="app_id" direction="in"/>
|
|
<annotation name="org.qtproject.QtDBus.QtTypeName.In1" value="QVariantMap"/>
|
|
<arg type="a{sv}" name="options" direction="in"/>
|
|
<arg type="u" name="response" direction="out"/>
|
|
</method>
|
|
<!--
|
|
SupportedLauncherTypes:
|
|
|
|
A bitmask of available launcher types. Currently defined types are:
|
|
|
|
- ``1``: Application. A launcher that represents an application.
|
|
- ``2``: Webapp. A launcher that represents a web app.
|
|
-->
|
|
<property name="SupportedLauncherTypes" type="u" access="read"/>
|
|
<property name="version" type="u" access="read"/>
|
|
</interface>
|
|
</node>
|