QXmpp Version: 1.10.3
 
Loading...
Searching...
No Matches
QXmppPresence.h
1// SPDX-FileCopyrightText: 2009 Manjeet Dahiya <manjeetdahiya@gmail.com>
2// SPDX-FileCopyrightText: 2022 Melvin Keskin <melvo@olomono.de>
3// SPDX-FileCopyrightText: 2024 Filipe Azevedo <pasnox@gmail.com>
4//
5// SPDX-License-Identifier: LGPL-2.1-or-later
6
7#ifndef QXMPPPRESENCE_H
8#define QXMPPPRESENCE_H
9
10#include "QXmppJingleIq.h"
11#include "QXmppMucIq.h"
12#include "QXmppStanza.h"
13
14class QXmppPresencePrivate;
15
21class QXMPP_EXPORT QXmppPresence : public QXmppStanza
22{
23public:
35
45
57
61 ~QXmppPresence() override;
62
65
66 bool isXmppStanza() const override;
67
70
71 int priority() const;
72 void setPriority(int priority);
73
76
77 QString statusText() const;
78 void setStatusText(const QString &statusText);
79
80 // XEP-0045: Multi-User Chat
81 QXmppMucItem mucItem() const;
82 void setMucItem(const QXmppMucItem &item);
83
84 QString mucPassword() const;
85 void setMucPassword(const QString &password);
86
87 QList<int> mucStatusCodes() const;
88 void setMucStatusCodes(const QList<int> &codes);
89
90 bool isMucSupported() const;
91 void setMucSupported(bool supported);
92
93 // XEP-0153: vCard-Based Avatars
94 QByteArray photoHash() const;
95 void setPhotoHash(const QByteArray &);
96
99
100 // XEP-0115: Entity Capabilities
101 QString capabilityHash() const;
102 void setCapabilityHash(const QString &);
103
104 QString capabilityNode() const;
105 void setCapabilityNode(const QString &);
106
107 QByteArray capabilityVer() const;
108 void setCapabilityVer(const QByteArray &);
109
110 QStringList capabilityExt() const;
111
112 // XEP-0272: Multiparty Jingle (Muji)
113 bool isPreparingMujiSession() const;
115
116 QVector<QXmppJingleIq::Content> mujiContents() const;
117 void setMujiContents(const QVector<QXmppJingleIq::Content> &mujiContents);
118
119 // XEP-0283: Moved
120 QString oldJid() const;
121 void setOldJid(const QString &oldJid);
122
123 // XEP-0319: Last User Interaction in Presence
124 QDateTime lastUserInteraction() const;
125 void setLastUserInteraction(const QDateTime &);
126
127 // XEP-0405: Mediated Information eXchange (MIX): Participant Server Requirements
128 QString mixUserJid() const;
129 void setMixUserJid(const QString &);
130
131 QString mixUserNick() const;
132 void setMixUserNick(const QString &);
133
135 void parse(const QDomElement &element) override;
136 void toXml(QXmlStreamWriter *writer) const override;
138
139private:
141 void parseExtension(const QDomElement &element, QXmppElementList &unknownElements);
143
144 QSharedDataPointer<QXmppPresencePrivate> d;
145};
146
147#endif // QXMPPPRESENCE_H
The QXmppMucItem class represents a chat room "item".
Definition QXmppMucIq.h:18
virtual void parse(const QDomElement &)=0
virtual void toXml(QXmlStreamWriter *writer) const =0
virtual bool isXmppStanza() const
Definition QXmppNonza.h:19
The QXmppPresence class represents an XMPP presence stanza.
Definition QXmppPresence.h:22
void setType(QXmppPresence::Type)
Sets the presence type.
Definition QXmppPresence.cpp:184
void setMixUserNick(const QString &)
Definition QXmppPresence.cpp:432
void setCapabilityNode(const QString &)
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:236
void setVCardUpdateType(VCardUpdateType type)
Sets the type of VCardUpdate.
Definition QXmppPresence.cpp:212
QXmppMucItem mucItem() const
Returns the MUC item.
Definition QXmppPresence.cpp:308
int priority() const
Returns the priority level of the resource.
Definition QXmppPresence.cpp:143
QXmppPresence & operator=(const QXmppPresence &other)
Assignemnt operator.
bool isPreparingMujiSession() const
Definition QXmppPresence.cpp:266
void setMucStatusCodes(const QList< int > &codes)
Sets the MUC status codes.
Definition QXmppPresence.cpp:338
void setMucSupported(bool supported)
Sets whether MUC is supported.
Definition QXmppPresence.cpp:350
void setMucItem(const QXmppMucItem &item)
Sets the MUC item.
Definition QXmppPresence.cpp:314
AvailableStatusType availableStatusType() const
Definition QXmppPresence.cpp:131
void setStatusText(const QString &statusText)
Definition QXmppPresence.cpp:165
QXmppPresence::Type type() const
Definition QXmppPresence.cpp:178
Type
This enum is used to describe a presence type.
Definition QXmppPresence.h:25
@ Unsubscribe
The sender is unsubscribing from another entity's presence.
Definition QXmppPresence.h:31
@ Subscribe
The sender wishes to subscribe to the recipient's presence.
Definition QXmppPresence.h:29
@ Subscribed
The sender has allowed the recipient to receive their presence.
Definition QXmppPresence.h:30
@ Unavailable
Signals that the sender is no longer available for communication.
Definition QXmppPresence.h:28
@ Unsubscribed
The subscription request has been denied or a previously-granted subscription has been cancelled.
Definition QXmppPresence.h:32
@ Probe
A request for an entity's current presence; SHOULD be generated only by a server on behalf of a user.
Definition QXmppPresence.h:33
@ Available
Signals that the sender is online and available for communication.
Definition QXmppPresence.h:27
@ Error
An error has occurred regarding processing or delivery of a previously-sent presence stanza.
Definition QXmppPresence.h:26
QByteArray capabilityVer() const
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:242
void setCapabilityHash(const QString &)
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:224
QByteArray photoHash() const
Returns the photo-hash of the VCardUpdate.
Definition QXmppPresence.cpp:190
void setMixUserJid(const QString &)
Definition QXmppPresence.cpp:412
VCardUpdateType
Definition QXmppPresence.h:48
@ VCardUpdateNoPhoto
User is not using any image.
Definition QXmppPresence.h:50
@ VCardUpdateNotReady
User is not ready to advertise an image.
Definition QXmppPresence.h:52
@ VCardUpdateValidPhoto
User is advertising an image.
Definition QXmppPresence.h:51
@ VCardUpdateNone
Protocol is not supported.
Definition QXmppPresence.h:49
void setOldJid(const QString &oldJid)
Definition QXmppPresence.cpp:370
void setLastUserInteraction(const QDateTime &)
Definition QXmppPresence.cpp:392
QList< int > mucStatusCodes() const
Returns the MUC status codes.
Definition QXmppPresence.cpp:332
QXmppPresence(const QXmppPresence &other)
Copy-constructor.
void setMucPassword(const QString &password)
Sets the password used to join a MUC room.
Definition QXmppPresence.cpp:326
void setMujiContents(const QVector< QXmppJingleIq::Content > &mujiContents)
Definition QXmppPresence.cpp:302
QXmppPresence(QXmppPresence &&)
Move-constructor.
void setIsPreparingMujiSession(bool isPreparingMujiSession)
Definition QXmppPresence.cpp:278
QXmppPresence & operator=(QXmppPresence &&)
Move-assignemnt operator.
void setAvailableStatusType(AvailableStatusType type)
Sets the availability status type, for instance busy or away.
Definition QXmppPresence.cpp:137
QDateTime lastUserInteraction() const
Definition QXmppPresence.cpp:381
QString capabilityHash() const
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:218
QXmppPresence(QXmppPresence::Type type=QXmppPresence::Available)
Definition QXmppPresence.cpp:97
void setCapabilityVer(const QByteArray &)
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:248
~QXmppPresence() override
Destroys a QXmppPresence.
QString mixUserJid() const
Definition QXmppPresence.cpp:402
void setPhotoHash(const QByteArray &)
Definition QXmppPresence.cpp:200
QStringList capabilityExt() const
Legacy XEP-0115: Entity Capabilities.
Definition QXmppPresence.cpp:254
QString capabilityNode() const
XEP-0115: Entity Capabilities
Definition QXmppPresence.cpp:230
AvailableStatusType
This enum is used to describe an availability status.
Definition QXmppPresence.h:37
@ Invisible
obsolete XEP-0018: Invisible Presence
Definition QXmppPresence.h:43
@ Online
The entity or resource is online.
Definition QXmppPresence.h:38
@ Chat
The entity or resource is actively interested in chatting.
Definition QXmppPresence.h:42
@ DND
The entity or resource is busy ("Do Not Disturb").
Definition QXmppPresence.h:41
@ Away
The entity or resource is temporarily away.
Definition QXmppPresence.h:39
@ XA
The entity or resource is away for an extended period.
Definition QXmppPresence.h:40
QVector< QXmppJingleIq::Content > mujiContents() const
Definition QXmppPresence.cpp:290
void setPriority(int priority)
Sets the priority level of the resource.
Definition QXmppPresence.cpp:149
VCardUpdateType vCardUpdateType() const
Returns the type of VCardUpdate.
Definition QXmppPresence.cpp:206
QString mixUserNick() const
Definition QXmppPresence.cpp:422
QString mucPassword() const
Returns the password used to join a MUC room.
Definition QXmppPresence.cpp:320
QString oldJid() const
Definition QXmppPresence.cpp:360
QString statusText() const
Returns the status text, a textual description of the user's status.
Definition QXmppPresence.cpp:155
bool isMucSupported() const
Returns true if the sender has indicated MUC support.
Definition QXmppPresence.cpp:344
QXmppStanza(const QString &from=QString(), const QString &to=QString())
Definition QXmppStanza.cpp:810