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
|
/*
* Copyright (C) 2008-2019 The QXmpp developers
*
* Author:
* Manjeet Dahiya
*
* 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
#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 described 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
};
QXmppMessage(const QString& from = QString(), const QString& to = QString(),
const QString& body = QString(), const QString& thread = QString());
QXmppMessage(const QXmppMessage &other);
~QXmppMessage();
QXmppMessage& operator=(const QXmppMessage &other);
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 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);
bool isXmppStanza() const;
// 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-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-0382: Spoiler messages
bool isSpoiler() const;
void setIsSpoiler(bool);
QString spoilerHint() const;
void setSpoilerHint(const QString&);
/// \cond
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
/// \endcond
private:
QSharedDataPointer<QXmppMessagePrivate> d;
};
#endif // QXMPPMESSAGE_H
|
