QXmpp Version: 1.5.6
Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
QXmppPresence Class Reference

The QXmppPresence class represents an XMPP presence stanza. More...

#include <QXmppPresence.h>

Inheritance diagram for QXmppPresence:
Inheritance graph
[legend]
Collaboration diagram for QXmppPresence:
Collaboration graph
[legend]

Public Types

enum  Type {
  Error = 0 , Available , Unavailable , Subscribe ,
  Subscribed , Unsubscribe , Unsubscribed , Probe
}
 This enum is used to describe a presence type. More...
 
enum  AvailableStatusType {
  Online = 0 , Away , XA , DND ,
  Chat , Invisible
}
 This enum is used to describe an availability status. More...
 
enum  VCardUpdateType { VCardUpdateNone = 0 , VCardUpdateNoPhoto , VCardUpdateValidPhoto , VCardUpdateNotReady }
 

Public Member Functions

 QXmppPresence (QXmppPresence::Type type=QXmppPresence::Available)
 
 QXmppPresence (const QXmppPresence &other)
 Copy-constructor.
 
 QXmppPresence (QXmppPresence &&)
 Move-constructor.
 
 ~QXmppPresence () override
 Destroys a QXmppPresence.
 
QXmppPresenceoperator= (const QXmppPresence &other)
 Assignemnt operator.
 
QXmppPresenceoperator= (QXmppPresence &&)
 Move-assignemnt operator.
 
bool isXmppStanza () const override
 
AvailableStatusType availableStatusType () const
 
void setAvailableStatusType (AvailableStatusType type)
 Sets the availability status type, for instance busy or away.
 
int priority () const
 Returns the priority level of the resource.
 
void setPriority (int priority)
 Sets the priority level of the resource.
 
QXmppPresence::Type type () const
 
void setType (QXmppPresence::Type)
 
QString statusText () const
 Returns the status text, a textual description of the user's status.
 
void setStatusText (const QString &statusText)
 
QXmppMucItem mucItem () const
 Returns the MUC item.
 
void setMucItem (const QXmppMucItem &item)
 
QString mucPassword () const
 Returns the password used to join a MUC room.
 
void setMucPassword (const QString &password)
 Sets the password used to join a MUC room.
 
QList< int > mucStatusCodes () const
 Returns the MUC status codes.
 
void setMucStatusCodes (const QList< int > &codes)
 
bool isMucSupported () const
 Returns true if the sender has indicated MUC support.
 
void setMucSupported (bool supported)
 Sets whether MUC is supported.
 
QByteArray photoHash () const
 
void setPhotoHash (const QByteArray &)
 
VCardUpdateType vCardUpdateType () const
 
void setVCardUpdateType (VCardUpdateType type)
 
QString capabilityHash () const
 XEP-0115: Entity Capabilities
 
void setCapabilityHash (const QString &)
 XEP-0115: Entity Capabilities
 
QString capabilityNode () const
 XEP-0115: Entity Capabilities
 
void setCapabilityNode (const QString &)
 XEP-0115: Entity Capabilities
 
QByteArray capabilityVer () const
 XEP-0115: Entity Capabilities
 
void setCapabilityVer (const QByteArray &)
 XEP-0115: Entity Capabilities
 
QStringList capabilityExt () const
 Legacy XEP-0115: Entity Capabilities.
 
bool isPreparingMujiSession () const
 
void setIsPreparingMujiSession (bool isPreparingMujiSession)
 
QVector< QXmppJingleIq::Content > mujiContents () const
 
void setMujiContents (const QVector< QXmppJingleIq::Content > &mujiContents)
 
QDateTime lastUserInteraction () const
 
void setLastUserInteraction (const QDateTime &)
 
QString mixUserJid () const
 
void setMixUserJid (const QString &)
 
QString mixUserNick () const
 
void setMixUserNick (const QString &)
 
- Public Member Functions inherited from QXmppStanza
 QXmppStanza (const QString &from=QString(), const QString &to=QString())
 
 QXmppStanza (const QXmppStanza &other)
 Constructs a copy of other.
 
 QXmppStanza (QXmppStanza &&)
 Move constructor.
 
virtual ~QXmppStanza ()
 Destroys a QXmppStanza.
 
QXmppStanzaoperator= (const QXmppStanza &other)
 Assigns other to this stanza.
 
QXmppStanzaoperator= (QXmppStanza &&)
 Move-assignment operator.
 
QString to () const
 
void setTo (const QString &)
 
QString from () const
 
void setFrom (const QString &)
 
QString id () const
 
void setId (const QString &)
 
QString lang () const
 
void setLang (const QString &)
 
QXmppStanza::Error error () const
 
std::optional< ErrorerrorOptional () const
 
void setError (const QXmppStanza::Error &error)
 
void setError (const std::optional< Error > &error)
 
QXmppElementList extensions () const
 
void setExtensions (const QXmppElementList &elements)
 
QList< QXmppExtendedAddressextendedAddresses () const
 
void setExtendedAddresses (const QList< QXmppExtendedAddress > &extendedAddresses)
 
std::optional< QXmppE2eeMetadatae2eeMetadata () const
 
void setE2eeMetadata (const std::optional< QXmppE2eeMetadata > &e2eeMetadata)
 
- Public Member Functions inherited from QXmppNonza
virtual void parse (const QDomElement &)=0
 
virtual void toXml (QXmlStreamWriter *writer) const =0
 

Detailed Description

The QXmppPresence class represents an XMPP presence stanza.

Member Enumeration Documentation

◆ AvailableStatusType

This enum is used to describe an availability status.

Enumerator
Online 

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

◆ Type

This enum is used to describe a presence type.

Enumerator
Error 

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.

◆ VCardUpdateType

This enum is used to describe vCard updates as defined by XEP-0153: vCard-Based Avatars

Enumerator
VCardUpdateNone 

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).

Constructor & Destructor Documentation

◆ QXmppPresence()

QXmppPresence::QXmppPresence ( QXmppPresence::Type  type = QXmppPresence::Available)

Constructs a QXmppPresence.

Member Function Documentation

◆ availableStatusType()

QXmppPresence::AvailableStatusType QXmppPresence::availableStatusType ( ) const

Returns the availability status type, for instance busy or away.

This will not tell you whether a contact is connected, check whether type() is QXmppPresence::Available instead.

◆ isPreparingMujiSession()

bool QXmppPresence::isPreparingMujiSession ( ) const

Returns whether a XEP-0272: Multiparty Jingle (Muji) session is being prepared.

Returns
whether a Muji session is being prepared
Since
QXmpp 1.5

◆ isXmppStanza()

bool QXmppPresence::isXmppStanza ( ) const
overridevirtual

Indicates if the QXmppStanza is a stanza in the XMPP sence (i. e. a message, iq or presence)

Since
QXmpp 1.0

Reimplemented from QXmppNonza.

◆ lastUserInteraction()

QDateTime QXmppPresence::lastUserInteraction ( ) const

Returns when the last user interaction with the client took place. See XEP-0319: Last User Interaction in Presence for details.

Since
QXmpp 1.0

◆ mixUserJid()

QString QXmppPresence::mixUserJid ( ) const

Returns the actual (full) JID of the MIX channel participant.

Since
QXmpp 1.1

◆ mixUserNick()

QString QXmppPresence::mixUserNick ( ) const

Returns the MIX participant's nickname.

Since
QXmpp 1.1

◆ mujiContents()

QVector< QXmppJingleIq::Content > QXmppPresence::mujiContents ( ) const

Returns XEP-0272: Multiparty Jingle (Muji) contents.

Returns
Muji contents
Since
QXmpp 1.5

◆ photoHash()

QByteArray QXmppPresence::photoHash ( ) const

Returns the photo-hash of the VCardUpdate.

Returns
QByteArray

◆ setIsPreparingMujiSession()

void QXmppPresence::setIsPreparingMujiSession ( bool  isPreparingMujiSession)

Sets whether a XEP-0272: Multiparty Jingle (Muji) session is being prepared.

Parameters
isPreparingMujiSessionwhether a Muji session is being prepared
Since
QXmpp 1.5

◆ setLastUserInteraction()

void QXmppPresence::setLastUserInteraction ( const QDateTime &  lastUserInteraction)

Sets the time of the last user interaction as defined in XEP-0319: Last User Interaction in Presence.

Since
QXmpp 1.0

◆ setMixUserJid()

void QXmppPresence::setMixUserJid ( const QString &  mixUserJid)

Sets the actual (full) JID of the MIX channel participant.

Since
QXmpp 1.1

◆ setMixUserNick()

void QXmppPresence::setMixUserNick ( const QString &  mixUserNick)

Sets the MIX participant's nickname.

Since
QXmpp 1.1

◆ setMucItem()

void QXmppPresence::setMucItem ( const QXmppMucItem item)

Sets the MUC item.

Parameters
item

◆ setMucStatusCodes()

void QXmppPresence::setMucStatusCodes ( const QList< int > &  codes)

Sets the MUC status codes.

Parameters
codes

◆ setMujiContents()

void QXmppPresence::setMujiContents ( const QVector< QXmppJingleIq::Content > &  mujiContents)

Sets XEP-0272: Multiparty Jingle (Muji) contents.

Parameters
mujiContentsMuji contents
Since
QXmpp 1.5

◆ setPhotoHash()

void QXmppPresence::setPhotoHash ( const QByteArray &  photoHash)

Sets the photo-hash of the VCardUpdate.

Parameters
photoHashas QByteArray

◆ setStatusText()

void QXmppPresence::setStatusText ( const QString &  statusText)

Sets the status text, a textual description of the user's status.

Parameters
statusTextThe status text, for example "Gone fishing".

◆ setType()

void QXmppPresence::setType ( QXmppPresence::Type  type)

Sets the presence type.

Parameters
type

◆ setVCardUpdateType()

void QXmppPresence::setVCardUpdateType ( VCardUpdateType  type)

Sets the type of VCardUpdate

Parameters
typeVCardUpdateType

◆ type()

QXmppPresence::Type QXmppPresence::type ( ) const

Returns the presence type.

You can use this method to determine the action which needs to be taken in response to receiving the presence. For instance, if the type is QXmppPresence::Available or QXmppPresence::Unavailable, you could update the icon representing a contact's availability.

◆ vCardUpdateType()

QXmppPresence::VCardUpdateType QXmppPresence::vCardUpdateType ( ) const

Returns the type of VCardUpdate

Returns
VCardUpdateType

The documentation for this class was generated from the following files: