src/cloudmessaging/qcloudmessagingprovider.h


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

/****************************************************************************
**
** Copyright (C) 2017 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing/
**
** This file is part of the QtCloudMessaging module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL3-COMM$
** Commercial License Usage
** Licensees holding valid commercial Qt 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 http://www.qt.io/terms-conditions. For further
** information use the contact form at http://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.LGPLv3 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.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/

#ifndef QTCLOUDMESSAGINGPROVIDER_H
#define QTCLOUDMESSAGINGPROVIDER_H

#include <QObject>
#include <QVariantMap>
#include <QMap>
#include <QString>
#include <QScopedPointer>
#include <QtCloudMessaging/qtcloudmessagingglobal.h>
#include <QtCloudMessaging/qcloudmessagingclient.h>

QT_BEGIN_NAMESPACE

/*!
 * \brief The QtCloudMessagingProvider class
 */
class QCloudMessagingProviderPrivate;

class Q_CLOUDMESSAGING_EXPORT QCloudMessagingProvider : public QObject
{
    Q_OBJECT

public:

    enum CloudMessagingProviderState {
        QtCloudMessagingProviderNotRegistered,
        QtCloudMessagingProviderRegistering,
        QtCloudMessagingProviderRegistered
    };
    Q_ENUM(CloudMessagingProviderState)

    explicit QCloudMessagingProvider(QObject *parent = nullptr);
    ~QCloudMessagingProvider();

    virtual bool registerProvider(
            const QString &providerId,
            const QVariantMap &parameters = QVariantMap());

    virtual void deregisterProvider();

    virtual QString connectClient(
            const QString &clientId,
            const QVariantMap &parameters = QVariantMap()) = 0;

    virtual void disconnectClient(
            const QString &clientId,
            const QVariantMap &parameters = QVariantMap());

    virtual bool sendMessage(
            const QByteArray &msg,
            const QString &clientId = QString(),
            const QString &clientToken = QString(),
            const QString &channel = QString()) = 0;

    virtual CloudMessagingProviderState setServiceState(QCloudMessagingProvider::CloudMessagingProviderState state);

    virtual QMap <QString, QCloudMessagingClient *>  *clients();

    QString clientToken(const QString &clientId);

    virtual bool remoteClients() = 0;

    QCloudMessagingClient *client(const QString &clientId);

    QString providerId();

    void setProviderId(const QString &providerId);

    QCloudMessagingProvider::CloudMessagingProviderState getServiceState();

    bool removeClient(const QString &clientId);

    virtual bool subscribeToChannel(
            const QString &channel,
            const QString &clientId = QString()) = 0;

    virtual bool unsubscribeFromChannel(
            const QString &channel,
            const QString &clientId = QString()) = 0;


    bool flushMessageQueue();

    QString connectClientToProvider(
            const QString &clientId,
            const QVariantMap &parameters = QVariantMap(),
            QCloudMessagingClient *serviceClient = nullptr);

private Q_SLOTS:
    void messageReceivedSlot(const QString &clientId,
                             const QByteArray &message);

Q_SIGNALS:
    void clientTokenReceived(const QString &token);

    void messageReceived(const QString &providerId,
                         const QString &clientId,
                         const QByteArray &message);

    void remoteClientsReceived(const QString &clients);

    void serviceStateUpdated(int state);

    void clientStateChanged(const QString &clientId,
                            int status);


private:
    QScopedPointer<QCloudMessagingProviderPrivate> d;
};

QT_END_NAMESPACE

#endif // QTCLOUDMESSAGINGPROVIDER_H