summaryrefslogtreecommitdiffstats
path: root/src/intent-client-lib/intentclientrequest.h
blob: 41e579d8ba084db1ddd7ee9142c4043a33231b8b (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
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Luxoft 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
**
****************************************************************************/

#pragma once

#include <QObject>
#include <QDir>
#include <QUuid>
#include <QString>
#include <QVariantMap>
#include <QtAppManCommon/global.h>

QT_BEGIN_NAMESPACE_AM

class IntentClient;

class IntentClientRequest : public QObject
{
    Q_OBJECT
    Q_CLASSINFO("AM-QmlType", "QtApplicationManager/IntentRequest 2.0")

    Q_PROPERTY(QUuid requestId READ requestId NOTIFY requestIdChanged)
    Q_PROPERTY(Direction direction READ direction CONSTANT)
    Q_PROPERTY(QString intentId READ intentId CONSTANT)
    Q_PROPERTY(QString applicationId READ applicationId CONSTANT)
    Q_PROPERTY(QVariantMap parameters READ parameters CONSTANT)
    Q_PROPERTY(bool succeeded READ succeeded NOTIFY replyReceived)
    Q_PROPERTY(QString errorMessage READ errorMessage NOTIFY replyReceived)
    Q_PROPERTY(QVariantMap result READ result NOTIFY replyReceived)

public:
    enum class Direction { ToSystem, ToApplication };
    Q_ENUM(Direction)

    ~IntentClientRequest() override;

    QUuid requestId() const;
    Direction direction() const;
    QString intentId() const;
    QString applicationId() const;
    QString requestingApplicationId() const;
    QVariantMap parameters() const;

    const QVariantMap result() const;
    bool succeeded() const;
    QString errorMessage() const;

    Q_INVOKABLE void sendReply(const QVariantMap &result);
    Q_INVOKABLE void sendErrorReply(const QString &errorMessage);

    void startTimeout(int timeout);

signals:
    void requestIdChanged();
    void replyReceived();

protected:
    void connectNotify(const QMetaMethod &signal) override;

private:
    IntentClientRequest(Direction direction, const QString &requestingApplicationId, const QUuid &id,
                        const QString &intentId, const QString &applicationId, const QVariantMap &parameters);

    void setRequestId(const QUuid &requestId);
    void setResult(const QVariantMap &result);
    void setErrorMessage(const QString &errorMessage);
    void doFinish();

    Direction m_direction;
    QUuid m_id;
    QString m_intentId;
    QString m_requestingApplicationId;
    QString m_applicationId;
    QVariantMap m_parameters;
    QVariantMap m_result;
    QString m_errorMessage;
    bool m_succeeded = false;
    // The client side of this request is finished - the object will stay in this state until
    // garbage collected by the JS engine. The state is entered, depending on the direction:
    //  ToSystem: we have received the final result or errorMessage via replyReceived()
    //  ToApplication: the request was handled and send(Error)Reply was called
    bool m_finished = false;

    Q_DISABLE_COPY(IntentClientRequest)

    friend class IntentClient;
};

QT_END_NAMESPACE_AM

Q_DECLARE_METATYPE(QT_PREPEND_NAMESPACE_AM(IntentClientRequest) *)