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
|
/*
* Copyright (C) 2008-2012 The QXmpp developers
*
* Author:
* Manjeet Dahiya
*
* 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 QXMPPPRESENCE_H
#define QXMPPPRESENCE_H
#include "QXmppStanza.h"
#include "QXmppMucIq.h"
/// \brief The QXmppPresence class represents an XMPP presence stanza.
///
/// \ingroup Stanzas
class QXMPP_EXPORT QXmppPresence : public QXmppStanza
{
public:
/// This enum is used to describe a presence type.
enum Type
{
Error = 0, ///< An error has occurred regarding processing or delivery of a previously-sent presence stanza.
Available, ///< Signals that the sender is online and available for communication.
Unavailable, ///< Signals that the sender is no longer available for communication.
Subscribe, ///< The sender wishes to subscribe to the recipient's presence.
Subscribed, ///< The sender has allowed the recipient to receive their presence.
Unsubscribe, ///< The sender is unsubscribing from another entity's presence.
Unsubscribed, ///< The subscription request has been denied or a previously-granted subscription has been cancelled.
Probe ///< A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
};
/// This enum is used to describe an availability status.
enum AvailableStatusType
{
Online = 0, ///< The entity or resource is online.
Away, ///< The entity or resource is temporarily away.
XA, ///< The entity or resource is away for an extended period.
DND, ///< The entity or resource is busy ("Do Not Disturb").
Chat, ///< The entity or resource is actively interested in chatting.
Invisible ///< obsolete XEP-0018: Invisible Presence
};
/// This enum is used to describe vCard updates as defined by
/// XEP-0153: vCard-Based Avatars
enum VCardUpdateType
{
VCardUpdateNone = 0, ///< Protocol is not supported
VCardUpdateNoPhoto, ///< User is not using any image
VCardUpdateValidPhoto, ///< User is advertising an image
VCardUpdateNotReady ///< User is not ready to advertise an image
/// \note This enables recipients to distinguish between the absence of an image
/// (empty photo element) and mere support for the protocol (empty update child).
};
/// \cond
// Deprecated since 0.7.0
class QXMPP_EXPORT Status
{
public:
/// This enum is used to describe an availability status.
enum Type
{
Online = 0, ///< The entity or resource is online.
Away, ///< The entity or resource is temporarily away.
XA, ///< The entity or resource is away for an extended period.
DND, ///< The entity or resource is busy ("Do Not Disturb").
Chat, ///< The entity or resource is actively interested in chatting.
Invisible ///< obsolete XEP-0018: Invisible Presence
};
Status(QXmppPresence::Status::Type type = QXmppPresence::Status::Online,
const QString statusText = "", int priority = 0);
QXmppPresence::Status::Type type() const;
void setType(QXmppPresence::Status::Type);
QString statusText() const;
void setStatusText(const QString&);
int priority() const;
void setPriority(int);
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
private:
QString getTypeStr() const;
void setTypeFromStr(const QString&);
QXmppPresence::Status::Type m_type;
QString m_statusText;
int m_priority;
};
Q_DECL_DEPRECATED QXmppPresence(QXmppPresence::Type type, const QXmppPresence::Status& status);
QXmppPresence::Status Q_DECL_DEPRECATED &status();
const QXmppPresence::Status Q_DECL_DEPRECATED &status() const;
void Q_DECL_DEPRECATED setStatus(const QXmppPresence::Status&);
/// \endcond
QXmppPresence(QXmppPresence::Type type = QXmppPresence::Available);
~QXmppPresence();
AvailableStatusType availableStatusType() const;
void setAvailableStatusType(AvailableStatusType type);
int priority() const;
void setPriority(int priority);
QXmppPresence::Type type() const;
void setType(QXmppPresence::Type);
QString statusText() const;
void setStatusText(const QString& statusText);
/// \cond
void parse(const QDomElement &element);
void toXml(QXmlStreamWriter *writer) const;
/// \endcond
// XEP-0045: Multi-User Chat
QXmppMucItem mucItem() const;
void setMucItem(const QXmppMucItem &item);
QList<int> mucStatusCodes() const;
void setMucStatusCodes(const QList<int> &codes);
/// XEP-0153: vCard-Based Avatars
QByteArray photoHash() const;
void setPhotoHash(const QByteArray&);
VCardUpdateType vCardUpdateType() const;
void setVCardUpdateType(VCardUpdateType type);
// XEP-0115: Entity Capabilities
QString capabilityHash() const;
void setCapabilityHash(const QString&);
QString capabilityNode() const;
void setCapabilityNode(const QString&);
QByteArray capabilityVer() const;
void setCapabilityVer(const QByteArray&);
QStringList capabilityExt() const;
private:
QString getTypeStr() const;
void setTypeFromStr(const QString&);
AvailableStatusType m_availableStatusType;
Type m_type;
QXmppPresence::Status m_status;
/// XEP-0153: vCard-Based Avatars
/// m_photoHash: the SHA1 hash of the avatar image data itself (not the base64-encoded version)
/// in accordance with RFC 3174
QByteArray m_photoHash;
VCardUpdateType m_vCardUpdateType;
// XEP-0115: Entity Capabilities
QString m_capabilityHash;
QString m_capabilityNode;
QByteArray m_capabilityVer;
// Legacy XEP-0115: Entity Capabilities
QStringList m_capabilityExt;
// XEP-0045: Multi-User Chat
QXmppMucItem m_mucItem;
QList<int> m_mucStatusCodes;
};
#endif // QXMPPPRESENCE_H
|
