QXmpp  Version: 1.10.4
QXmppRosterManager.h
1 // SPDX-FileCopyrightText: 2010 Manjeet Dahiya <manjeetdahiya@gmail.com>
2 // SPDX-FileCopyrightText: 2010 Jeremy LainĂ© <jeremy.laine@m4x.org>
3 // SPDX-FileCopyrightText: 2021 Melvin Keskin <melvo@olomono.de>
4 // SPDX-FileCopyrightText: 2024 Filipe Azevedo <pasnox@gmail.com>
5 //
6 // SPDX-License-Identifier: LGPL-2.1-or-later
7 
8 #ifndef QXMPPROSTERMANAGER_H
9 #define QXMPPROSTERMANAGER_H
10 
11 #include "QXmppClientExtension.h"
12 #include "QXmppPresence.h"
13 #include "QXmppRosterIq.h"
14 #include "QXmppSendResult.h"
15 
16 #include <variant>
17 
18 #include <QMap>
19 #include <QObject>
20 #include <QStringList>
21 
22 template<typename T>
23 class QXmppTask;
24 class QXmppRosterManagerPrivate;
25 
83 class QXMPP_EXPORT QXmppRosterManager : public QXmppClientExtension
84 {
85  Q_OBJECT
86 
87 public:
89  using Result = std::variant<QXmpp::Success, QXmppError>;
90 
91  explicit QXmppRosterManager(QXmppClient *stream);
92  ~QXmppRosterManager() override;
93 
94  bool isRosterReceived() const;
95  QStringList getRosterBareJids() const;
96  QXmppRosterIq::Item getRosterEntry(const QString &bareJid) const;
97 
98  QStringList getResources(const QString &bareJid) const;
99  QMap<QString, QXmppPresence> getAllPresencesForBareJid(
100  const QString &bareJid) const;
101  QXmppPresence getPresence(const QString &bareJid,
102  const QString &resource) const;
103 
104  QXmppTask<Result> addRosterItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
105  QXmppTask<Result> removeRosterItem(const QString &bareJid);
106  QXmppTask<Result> renameRosterItem(const QString &bareJid, const QString &name);
107  QXmppTask<QXmpp::SendResult> subscribeTo(const QString &bareJid, const QString &reason = {});
108  QXmppTask<QXmpp::SendResult> unsubscribeFrom(const QString &bareJid, const QString &reason = {});
109 
111  bool handleStanza(const QDomElement &element) override;
113 
114 public Q_SLOTS:
115  bool acceptSubscription(const QString &bareJid, const QString &reason = {});
116  bool refuseSubscription(const QString &bareJid, const QString &reason = {});
117  bool addItem(const QString &bareJid, const QString &name = {}, const QSet<QString> &groups = {});
118  bool removeItem(const QString &bareJid);
119  bool renameItem(const QString &bareJid, const QString &name);
120  bool subscribe(const QString &bareJid, const QString &reason = {});
121  bool unsubscribe(const QString &bareJid, const QString &reason = {});
122 
123 Q_SIGNALS:
132  void rosterReceived();
133 
135  void presenceChanged(const QString &bareJid, const QString &resource);
136 
146  void subscriptionReceived(const QString &bareJid);
147 
148  void subscriptionRequestReceived(const QString &subscriberBareJid, const QXmppPresence &presence);
149 
152  void itemAdded(const QString &bareJid);
153 
156  void itemChanged(const QString &bareJid);
157 
160  void itemRemoved(const QString &bareJid);
161 
162 protected:
163  void onRegistered(QXmppClient *client) override;
164  void onUnregistered(QXmppClient *client) override;
165 
166 private Q_SLOTS:
167  void _q_connected();
168  void _q_disconnected();
169  void _q_presenceReceived(const QXmppPresence &);
170 
171 private:
172  using RosterResult = std::variant<QXmppRosterIq, QXmppError>;
173 
174  void handleSubscriptionRequest(const QString &bareJid, const QXmppPresence &presence);
175  QXmppTask<RosterResult> requestRoster();
176 
177  const std::unique_ptr<QXmppRosterManagerPrivate> d;
178 
179  friend class QXmppMixManager;
180 };
181 
182 #endif // QXMPPROSTER_H
virtual void onRegistered(QXmppClient *client)
Definition: QXmppClientExtension.cpp:85
virtual void onUnregistered(QXmppClient *client)
Definition: QXmppClientExtension.cpp:95
virtual bool handleStanza(const QDomElement &stanza)
You need to implement this method to process incoming XMPP stanzas.
Definition: client/compat/removed_api.cpp:26
std::variant< QXmpp::Success, QXmppError > Result
Empty result containing QXmpp::Success or a QXmppError.
Definition: QXmppRosterManager.h:89
Definition: QXmppTask.h:61
The QXmppRosterManager class provides access to a connected client&#39;s roster.
Definition: QXmppRosterManager.h:83
The QXmppPresence class represents an XMPP presence stanza.
Definition: QXmppPresence.h:21
The QXmppClientExtension class is the base class for QXmppClient extensions.
Definition: QXmppClientExtension.h:31
Definition: QXmppMixManager.h:19
Main class for starting and managing connections to XMPP servers.
Definition: QXmppClient.h:61
The QXmppRosterIq::Item class represents a roster entry.
Definition: QXmppRosterIq.h:32