aboutsummaryrefslogtreecommitdiff
path: root/src/base/QXmppRosterIq.h
diff options
context:
space:
mode:
authorJeremy Lainé <jeremy.laine@m4x.org>2012-02-08 12:51:15 +0000
committerJeremy Lainé <jeremy.laine@m4x.org>2012-02-08 12:51:15 +0000
commitdeb9d6cb53057ca8b90d10d6a3bdc5dcfd1b3ee4 (patch)
treed956bad28e28aadc3c83dbf88b3eddb5e1d9a9f4 /src/base/QXmppRosterIq.h
parente8a1ad0cc608f12874ba4bafbd8282fa537ec9fb (diff)
downloadqxmpp-deb9d6cb53057ca8b90d10d6a3bdc5dcfd1b3ee4.tar.gz
move files common to client/server into "base"
Diffstat (limited to 'src/base/QXmppRosterIq.h')
-rw-r--r--src/base/QXmppRosterIq.h107
1 files changed, 107 insertions, 0 deletions
diff --git a/src/base/QXmppRosterIq.h b/src/base/QXmppRosterIq.h
new file mode 100644
index 00000000..9680a176
--- /dev/null
+++ b/src/base/QXmppRosterIq.h
@@ -0,0 +1,107 @@
+/*
+ * Copyright (C) 2008-2011 The QXmpp developers
+ *
+ * Authors:
+ * Manjeet Dahiya
+ * Jeremy Lainé
+ *
+ * Source:
+ * http://code.google.com/p/qxmpp
+ *
+ * This file is a part of QXmpp library.
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ */
+
+
+#ifndef QXMPPROSTERIQ_H
+#define QXMPPROSTERIQ_H
+
+#include "QXmppIq.h"
+#include <QList>
+#include <QSet>
+
+/// \brief The QXmppRosterIq class represents a roster IQ.
+///
+/// \ingroup Stanzas
+
+class QXmppRosterIq : public QXmppIq
+{
+public:
+
+ /// \brief The QXmppRosterIq::Item class represents a roster entry.
+ class Item
+ {
+ public:
+ /// An enumeration for type of subscription with the bareJid in the roster.
+ enum SubscriptionType
+ {
+ None = 0, ///< the user does not have a subscription to the
+ ///< contact's presence information, and the contact does
+ ///< not have a subscription to the user's presence information
+ From = 1, ///< the contact has a subscription to the user's presence information,
+ ///< but the user does not have a subscription to the contact's presence information
+ To = 2, ///< the user has a subscription to the contact's presence information,
+ ///< but the contact does not have a subscription to the user's presence information
+ Both = 3, ///< both the user and the contact have subscriptions to each
+ ///< other's presence information
+ Remove = 4, ///< to delete a roster item
+ NotSet = 8 ///< the subscription state was not specified
+ };
+
+ QString bareJid() const;
+ QSet<QString> groups() const;
+ QString name() const;
+ QString subscriptionStatus() const;
+ SubscriptionType subscriptionType() const;
+
+ void setBareJid(const QString&);
+ void setGroups(const QSet<QString>&);
+ void setName(const QString&);
+ void setSubscriptionStatus(const QString&);
+ void setSubscriptionType(SubscriptionType);
+
+ /// \cond
+ void parse(const QDomElement &element);
+ void toXml(QXmlStreamWriter *writer) const;
+ /// \endcond
+
+ private:
+ QString getSubscriptionTypeStr() const;
+ void setSubscriptionTypeFromStr(const QString&);
+
+ QString m_bareJid;
+ SubscriptionType m_type;
+ QString m_name;
+ // can be subscribe/unsubscribe (attribute "ask")
+ QString m_subscriptionStatus;
+ QSet<QString> m_groups;
+ };
+
+ void addItem(const Item&);
+ QList<Item> items() const;
+
+ /// \cond
+ static bool isRosterIq(const QDomElement &element);
+ /// \endcond
+
+protected:
+ /// \cond
+ void parseElementFromChild(const QDomElement &element);
+ void toXmlElementFromChild(QXmlStreamWriter *writer) const;
+ /// \endcond
+
+private:
+ QList<Item> m_items;
+};
+
+#endif // QXMPPROSTERIQ_H