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
|
// SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
//
// SPDX-License-Identifier: LGPL-2.1-or-later
#ifndef QXMPPPRESENCE_H
#define QXMPPPRESENCE_H
#include "QXmppMucIq.h"
#include "QXmppStanza.h"
class QXmppPresencePrivate;
/// \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).
};
QXmppPresence(QXmppPresence::Type type = QXmppPresence::Available);
QXmppPresence(const QXmppPresence &other);
~QXmppPresence() override;
QXmppPresence &operator=(const QXmppPresence &other);
bool isXmppStanza() const override;
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);
// XEP-0045: Multi-User Chat
QXmppMucItem mucItem() const;
void setMucItem(const QXmppMucItem &item);
QString mucPassword() const;
void setMucPassword(const QString &password);
QList<int> mucStatusCodes() const;
void setMucStatusCodes(const QList<int> &codes);
bool isMucSupported() const;
void setMucSupported(bool supported);
// 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;
// XEP-0319: Last User Interaction in Presence
QDateTime lastUserInteraction() const;
void setLastUserInteraction(const QDateTime &);
// XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements
QString mixUserJid() const;
void setMixUserJid(const QString &);
QString mixUserNick() const;
void setMixUserNick(const QString &);
/// \cond
void parse(const QDomElement &element) override;
void toXml(QXmlStreamWriter *writer) const override;
/// \endcond
private:
/// \cond
void parseExtension(const QDomElement &element, QXmppElementList &unknownElements);
/// \endcond
QSharedDataPointer<QXmppPresencePrivate> d;
};
#endif // QXMPPPRESENCE_H
|
