blob: 76f9a0182210defbf485005f6b271f89d7fb4df7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
|
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company Ltd.
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Qt Application Manager.
**
** $QT_BEGIN_LICENSE:LGPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite licenses may use
** this file in accordance with the commercial license agreement provided
** with the Software or, alternatively, in accordance with the terms
** contained in a written agreement between you and The Qt Company. For
** licensing terms and conditions see https://www.qt.io/terms-conditions.
** For further information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: LGPL-3.0
**
****************************************************************************/
#include <QQmlInfo>
#include "intenthandler.h"
#include "intentclient.h"
QT_BEGIN_NAMESPACE_AM
/*! \qmltype IntentHandler
\inqmlmodule QtApplicationManager.Application
\ingroup application-instantiatable
\brief A handler for intent requests received by applications.
Any application that has intents listed in its manifest file needs to have a corresponding
IntentHandler instance that is actually able to handle incoming requests. This class gives
you the flexibility to handle multiple, different intent ids via a single IntentHandler
instance or have a dedicated IntentHandler instance for every intent id (or any combination of
those).
\note For handling intent requests within the System UI, you have to use the derived component
IntentServerHandler, which works the same way, but provides all the necessary meta-data
from within QML.
Here is a fairly standard way to handle an incoming intent request and send out a result or
error message:
\qml
Image {
id: viewer
}
IntentHandler {
intentIds: [ "show-image" ]
onRequestReceived: {
var url = request.parameters["url"]
if (!url.startsWith("file://")) {
request.sendErrorReply("Only file:// urls are supported")
} else {
viewer.source = url
request.sendReply({ "status": source.status })
}
}
}
\endqml
*/
/*! \qmlproperty list<string> IntentHandler::intentIds
Every handler needs to register at least one unique intent id that it will handle. Having
multiple IntentHandlers that are registering the same intent id is not possible.
\note Any changes to this property after component completion will have no effect.
*/
/*! \qmlsignal IntentHandler::requestReceived(IntentRequest request)
This signal will be emitted once for every incoming intent \a request that this handler was
registered for via its intentIds property.
Handling the request can be done synchronously or asynchronously. As soon as your handler has
either produced a result or detected an error condition, it should call
IntentRequest::sendReply() or IntentRequest::sendErrorReply() respectively to send a reply back
to the requesting party. Even if your intent does not have a return value, you still need to
send an empty object \c{{}} reply to signal that the intent request has been handled
successfully.
Only the first call to one of these functions will have any effect. Any further invocations
will be ignored.
If these functions are not called after receiving an intent request within the \l{Intent
Timeout Specification}{system's specified timeout interval}, the system will send an implicit
"failed due to timeout" error reply back to the original sender.
*/
IntentHandler::IntentHandler(QObject *parent)
: QObject(parent)
{ }
IntentHandler::~IntentHandler()
{
if (auto ie = IntentClient::instance())
ie->unregisterHandler(this);
}
QStringList IntentHandler::intentIds() const
{
return m_intentIds;
}
void IntentHandler::setIntentIds(const QStringList &intentIds)
{
if (isComponentCompleted()) {
qmlWarning(this) << "Cannot change the intentIds property of an IntentHandler after creation.";
return;
}
m_intentIds = intentIds;
}
void IntentHandler::componentComplete()
{
IntentClient::instance()->registerHandler(this);
m_completed = true;
}
void IntentHandler::classBegin()
{ }
bool IntentHandler::isComponentCompleted() const
{
return m_completed;
}
QT_END_NAMESPACE_AM
#include "moc_intenthandler.cpp"
|
