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
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
|
/*
* Copyright (C) 2008-2019 The QXmpp developers
*
* Author:
* Manjeet Dahiya
* 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.
*
*/
#ifndef QXMPPMESSAGE_H
#define QXMPPMESSAGE_H
// Required for source compatibility
#include <QDateTime>
#include "QXmppStanza.h"
class QXmppMessagePrivate;
/// \brief The QXmppMessage class represents an XMPP message.
///
/// \ingroup Stanzas
class QXMPP_EXPORT QXmppMessage : public QXmppStanza
{
public:
/// This enum describes a message type.
enum Type {
Error = 0,
Normal,
Chat,
GroupChat,
Headline
};
/// This enum describes a chat state as defined by XEP-0085: Chat State
/// Notifications.
enum State {
None = 0, ///< The message does not contain any chat state information.
Active, ///< User is actively participating in the chat session.
Inactive, ///< User has not been actively participating in the chat session.
Gone, ///< User has effectively ended their participation in the chat session.
Composing, ///< User is composing a message.
Paused ///< User had been composing but now has stopped.
};
/// This enum describes a chat marker as defined by XEP-0333: Chat Markers.
enum Marker {
NoMarker = 0,
Received,
Displayed,
Acknowledged
};
/// XEP-0334: Message Processing Hints
///
/// \since QXmpp 1.1
enum Hint {
NoPermanentStore = 1 << 0, ///< Do not allow permanent storage
NoStore = 1 << 1, ///< Do not store at all
NoCopy = 1 << 2, ///< Do not copy the message
Store = 1 << 3 ///< Do store the message
};
/// This enum describes different end-to-end encryption methods. These can
/// be used to mark a message explicitly as encrypted with a specific
/// algothim. See XEP-0380: Explicit Message Encryption for details.
///
/// \since QXmpp 1.1
enum EncryptionMethod {
NoEncryption, ///< No encryption
UnknownEncryption, ///< Unknown encryption
OTR, ///< XEP-0364: Current Off-the-Record Messaging Usage
LegacyOpenPGP, ///< XEP-0027: Current Jabber OpenPGP Usage
OX, ///< XEP-0373: OpenPGP for XMPP
OMEMO ///< XEP-0384: OMEMO Encryption
};
QXmppMessage(const QString& from = QString(), const QString& to = QString(),
const QString& body = QString(), const QString& thread = QString());
QXmppMessage(const QXmppMessage &other);
~QXmppMessage() override;
QXmppMessage& operator=(const QXmppMessage &other);
bool isXmppStanza() const override;
QString body() const;
void setBody(const QString&);
bool isAttentionRequested() const;
void setAttentionRequested(bool requested);
bool isReceiptRequested() const;
void setReceiptRequested(bool requested);
QString mucInvitationJid() const;
void setMucInvitationJid(const QString &jid);
QString mucInvitationPassword() const;
void setMucInvitationPassword(const QString &password);
QString mucInvitationReason() const;
void setMucInvitationReason(const QString &reason);
QString receiptId() const;
void setReceiptId(const QString &id);
QDateTime stamp() const;
void setStamp(const QDateTime &stamp);
QXmppMessage::State state() const;
void setState(QXmppMessage::State);
QString subject() const;
void setSubject(const QString&);
QString thread() const;
void setThread(const QString&);
QXmppMessage::Type type() const;
void setType(QXmppMessage::Type);
QString xhtml() const;
void setXhtml(const QString &xhtml);
// XEP-0333: Chat State Markers
bool isMarkable() const;
void setMarkable(const bool);
QString markedId() const;
void setMarkerId(const QString&);
QString markedThread() const;
void setMarkedThread(const QString&);
Marker marker() const;
void setMarker(const Marker);
// XEP-0280: Message Carbons
bool isPrivate() const;
void setPrivate(const bool);
// XEP-0066: Out of Band Data
QString outOfBandUrl() const;
void setOutOfBandUrl(const QString&);
// XEP-0308: Last Message Correction
QString replaceId() const;
void setReplaceId(const QString&);
// XEP-0334: Message Processing Hints
bool hasHint(const Hint hint) const;
void addHint(const Hint hint);
void removeHint(const Hint hint);
void removeAllHints();
// XEP-0367: Message Attaching
QString attachId() const;
void setAttachId(const QString&);
// XEP-0369: Mediated Information eXchange (MIX)
QString mixUserJid() const;
void setMixUserJid(const QString&);
QString mixUserNick() const;
void setMixUserNick(const QString&);
// XEP-0380: Explicit Message Encryption
EncryptionMethod encryptionMethod() const;
void setEncryptionMethod(EncryptionMethod);
QString encryptionMethodNs() const;
void setEncryptionMethodNs(const QString&);
QString encryptionName() const;
void setEncryptionName(const QString&);
// XEP-0382: Spoiler messages
bool isSpoiler() const;
void setIsSpoiler(bool);
QString spoilerHint() const;
void setSpoilerHint(const QString&);
/// \cond
void parse(const QDomElement &element) override;
void toXml(QXmlStreamWriter *writer) const override;
/// \endcond
private:
void parseExtension(const QDomElement &element, QXmppElementList &unknownElements);
void parseXElement(const QDomElement &element, QXmppElementList &unknownElements);
QSharedDataPointer<QXmppMessagePrivate> d;
};
#endif // QXMPPMESSAGE_H
|
