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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
|
/*
* Copyright (C) 2008-2021 The QXmpp developers
*
* Author:
* Jeremy Lainé
* Linus Jahn
*
* Source:
* https://github.com/qxmpp-project/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.
*
*/
#include "QXmppPubSubItem.h"
#include "QXmppElement.h"
#include "QXmppUtils.h"
#include <QDomElement>
class QXmppPubSubItemPrivate : public QSharedData
{
public:
QXmppPubSubItemPrivate(const QString &id, const QString &publisher);
QString id;
QString publisher;
};
QXmppPubSubItemPrivate::QXmppPubSubItemPrivate(const QString &id, const QString &publisher)
: id(id), publisher(publisher)
{
}
///
/// \class QXmppPubSubItem
///
/// The QXmppPubSubItem class represents a publish-subscribe item as defined by
/// \xep{0060, Publish-Subscribe}.
///
/// To access the payload of an item, you need to create a derived class of this
/// and override QXmppPubSubItem::parsePayload() and
/// QXmppPubSubItem::serializePayload().
///
/// It is also required that you override QXmppPubSubItem::isItem() and also
/// check for the correct payload of the PubSub item. This can be easily done by
/// using the protected overload of isItem() with an function that checks the
/// tag name and namespace of the payload. The function is only called if a
/// payload exists.
///
/// In short, you need to reimplement these methods:
/// * QXmppPubSubItem::parsePayload()
/// * QXmppPubSubItem::serializePayload()
/// * QXmppPubSubItem::isItem()
///
/// \since QXmpp 1.5
///
///
/// Constructs an item with \a id and \a publisher.
///
/// \param id
/// \param publisher
///
QXmppPubSubItem::QXmppPubSubItem(const QString &id, const QString &publisher)
: d(new QXmppPubSubItemPrivate(id, publisher))
{
}
/// Default copy-constructor
QXmppPubSubItem::QXmppPubSubItem(const QXmppPubSubItem &iq) = default;
QXmppPubSubItem::~QXmppPubSubItem() = default;
/// Default assignment operator
QXmppPubSubItem &QXmppPubSubItem::operator=(const QXmppPubSubItem &iq) = default;
///
/// Returns the ID of the PubSub item.
///
QString QXmppPubSubItem::id() const
{
return d->id;
}
///
/// Sets the ID of the PubSub item.
///
/// \param id
///
void QXmppPubSubItem::setId(const QString &id)
{
d->id = id;
}
///
/// Returns the JID of the publisher of the item.
///
QString QXmppPubSubItem::publisher() const
{
return d->publisher;
}
///
/// Sets the JID of the publisher of the item.
///
void QXmppPubSubItem::setPublisher(const QString &publisher)
{
d->publisher = publisher;
}
/// \cond
void QXmppPubSubItem::parse(const QDomElement &element)
{
d->id = element.attribute(QStringLiteral("id"));
d->publisher = element.attribute(QStringLiteral("publisher"));
parsePayload(element.firstChildElement());
}
void QXmppPubSubItem::toXml(QXmlStreamWriter *writer) const
{
writer->writeStartElement(QStringLiteral("item"));
helperToXmlAddAttribute(writer, QStringLiteral("id"), d->id);
helperToXmlAddAttribute(writer, QStringLiteral("publisher"), d->publisher);
serializePayload(writer);
writer->writeEndElement();
}
/// \endcond
///
/// Returns true, if the element is possibly a PubSub item.
///
bool QXmppPubSubItem::isItem(const QDomElement &element)
{
return element.tagName() == QStringLiteral("item");
}
///
/// Parses the payload of the item (the child element of the <item/>).
///
/// This method needs to be overriden to perform the payload-specific parsing.
///
void QXmppPubSubItem::parsePayload(const QDomElement &)
{
}
///
/// Serializes the payload of the item (the child element of the <item/>).
///
/// This method needs to be overriden to perform the payload-specific
/// serialization.
///
void QXmppPubSubItem::serializePayload(QXmlStreamWriter *) const
{
}
|
