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
|
// SPDX-FileCopyrightText: 2010 Manjeet Dahiya <manjeetdahiya@gmail.com>
// SPDX-FileCopyrightText: 2010 Jeremy Lainé <jeremy.laine@m4x.org>
// SPDX-FileCopyrightText: 2021 Melvin Keskin <melvo@olomono.de>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#ifndef QXMPPROSTERMANAGER_H
#define QXMPPROSTERMANAGER_H
#include "QXmppClientExtension.h"
#include "QXmppPresence.h"
#include "QXmppRosterIq.h"
#include "QXmppSendResult.h"
#include <variant>
#include <QMap>
#include <QObject>
#include <QStringList>
template<typename T>
class QXmppTask;
class QXmppRosterManagerPrivate;
///
/// \brief The QXmppRosterManager class provides access to a connected client's
/// roster.
///
/// \note Its object should not be created using its constructor. Instead
/// \c QXmppClient::findExtension<QXmppRosterManager>() should be used to get
/// the instantiated object of this class.
///
/// It stores all the Roster and Presence details of all the roster entries
/// (that is all the bareJids) in the client's friend's list. It provides the
/// functionality to get all the bareJids in the client's roster and Roster and
/// Presence details of the same.
///
/// After the QXmpp connected successfully to the XMPP server the signal
/// \c QXmppClient::connected() is emitted and the roster is requested from the
/// server. Once QXmpp receives the roster the signal
/// \c QXmppRosterManager::rosterReceived() is emitted and after that the
/// methods of this class can be used to get the roster entries.
///
/// \c QXmppRosterManager::isRosterReceived() can be used to find out whether
/// the roster has been received yet.
///
/// The \c itemAdded(), \c itemChanged() and \c itemRemoved() signals are
/// emitted whenever roster entries are added, changed or removed.
///
/// The \c presenceChanged() signal is emitted whenever the presence for a
/// roster item changes.
///
/// \ingroup Managers
///
class QXMPP_EXPORT QXmppRosterManager : public QXmppClientExtension
{
Q_OBJECT
public:
/// Empty result containing QXmpp::Success or a QXmppError
using Result = std::variant<QXmpp::Success, QXmppError>;
QXmppRosterManager(QXmppClient *stream);
~QXmppRosterManager() override;
bool isRosterReceived() const;
QStringList getRosterBareJids() const;
QXmppRosterIq::Item getRosterEntry(const QString &bareJid) const;
QStringList getResources(const QString &bareJid) const;
QMap<QString, QXmppPresence> getAllPresencesForBareJid(
const QString &bareJid) const;
QXmppPresence getPresence(const QString &bareJid,
const QString &resource) const;
QXmppTask<Result> addRosterItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
QXmppTask<Result> removeRosterItem(const QString &bareJid);
QXmppTask<Result> renameRosterItem(const QString &bareJid, const QString &name);
QXmppTask<QXmpp::SendResult> subscribeTo(const QString &bareJid, const QString &reason = {});
QXmppTask<QXmpp::SendResult> unsubscribeFrom(const QString &bareJid, const QString &reason = {});
/// \cond
bool handleStanza(const QDomElement &element) override;
/// \endcond
public Q_SLOTS:
bool acceptSubscription(const QString &bareJid, const QString &reason = {});
bool refuseSubscription(const QString &bareJid, const QString &reason = {});
bool addItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
bool removeItem(const QString &bareJid);
bool renameItem(const QString &bareJid, const QString &name);
bool subscribe(const QString &bareJid, const QString &reason = {});
bool unsubscribe(const QString &bareJid, const QString &reason = {});
Q_SIGNALS:
/// This signal is emitted when the Roster IQ is received after a successful
/// connection. That is the roster entries are empty before this signal is emitted.
/// One should use getRosterBareJids() and getRosterEntry() only after
/// this signal has been emitted.
///
/// \note If the previous stream could be resumed, this signal is not
/// emitted since QXmpp 1.4. Changes since the last connection are reported
/// via the itemAdded(), itemChanged() and itemRemoved() signals.
void rosterReceived();
/// This signal is emitted when the presence of a particular bareJid and resource changes.
void presenceChanged(const QString &bareJid, const QString &resource);
/// This signal is emitted when a contact asks to subscribe to your presence.
///
/// You can either accept the request by calling acceptSubscription() or refuse it
/// by calling refuseSubscription().
///
/// \note If you set QXmppConfiguration::autoAcceptSubscriptions() to true, this
/// signal will not be emitted.
void subscriptionReceived(const QString &bareJid);
void subscriptionRequestReceived(const QString &subscriberBareJid, const QXmppPresence &presence);
/// This signal is emitted when the roster entry of a particular bareJid is
/// added as a result of roster push.
void itemAdded(const QString &bareJid);
/// This signal is emitted when the roster entry of a particular bareJid
/// changes as a result of roster push.
void itemChanged(const QString &bareJid);
/// This signal is emitted when the roster entry of a particular bareJid is
/// removed as a result of roster push.
void itemRemoved(const QString &bareJid);
private Q_SLOTS:
void _q_connected();
void _q_disconnected();
void _q_presenceReceived(const QXmppPresence &);
private:
const std::unique_ptr<QXmppRosterManagerPrivate> d;
};
#endif // QXMPPROSTER_H
|
