QXmppCarbonManager Class Reference

The QXmppCarbonManager class handles message carbons as described in XEP-0280: Message Carbons. More...

#include <QXmppCarbonManager.h>

Inheritance diagram for QXmppCarbonManager:

Collaboration diagram for QXmppCarbonManager:

Public Member Functions
bool	carbonsEnabled () const
void	setCarbonsEnabled (bool enabled)
Q_SIGNAL void	messageReceived (const QXmppMessage &)
Q_SIGNAL void	messageSent (const QXmppMessage &)
Public Member Functions inherited from QXmppClientExtension
	QXmppClientExtension ()
virtual QStringList	discoveryFeatures () const
virtual QList< QXmppDiscoIdentity >	discoveryIdentities () const
virtual bool	handleStanza (const QDomElement &stanza)
	You need to implement this method to process incoming XMPP stanzas.
virtual bool	handleStanza (const QDomElement &stanza, const std::optional< QXmppE2eeMetadata > &e2eeMetadata)
	You need to implement this method to process incoming XMPP stanzas.
Public Member Functions inherited from QXmppLoggable
	QXmppLoggable (QObject *parent=nullptr)
Q_SIGNAL void	setGauge (const QString &gauge, double value)
	Sets the given gauge to value.
Q_SIGNAL void	logMessage (QXmppLogger::MessageType type, const QString &msg)
	This signal is emitted to send logging messages.
Q_SIGNAL void	updateCounter (const QString &counter, qint64 amount=1)
	Updates the given counter by amount.

Additional Inherited Members
Protected Member Functions inherited from QXmppClientExtension
QXmppClient *	client () const
virtual void	setClient (QXmppClient *client)
virtual void	onRegistered (QXmppClient *client)
virtual void	onUnregistered (QXmppClient *client)
void	injectIq (const QDomElement &element, const std::optional< QXmppE2eeMetadata > &e2eeMetadata)
bool	injectMessage (QXmppMessage &&message)
Protected Member Functions inherited from QXmppLoggable
void	debug (const QString &message)
	Logs a debugging message.
void	info (const QString &message)
	Logs an informational message.
void	warning (const QString &message)
	Logs a warning message.
void	logReceived (const QString &message)
	Logs a received packet.
void	logSent (const QString &message)
	Logs a sent packet.

Detailed Description

The QXmppCarbonManager class handles message carbons as described in XEP-0280: Message Carbons.

This class emits signals whenever another resource of the currently connected client account sent or received a message.

Warning

This manager does not decrypt e2ee messages. You can use QXmppCarbonManagerV2.

Since

QXmpp 1.0

Member Function Documentation

carbonsEnabled()

bool QXmppCarbonManager::carbonsEnabled

(

)

const

Returns whether message carbons are currently enabled

messageReceived()

QXmppCarbonManager::messageReceived

(

const QXmppMessage &

)

Emitted when a message was received from someone else and directed to another resource.

If you connect this signal to the QXmppClient::messageReceived signal, they will appear as normal messages.

messageSent()

QXmppCarbonManager::messageSent

(

const QXmppMessage &

)

Emitted when another resource sent a message to someone else.

setCarbonsEnabled()

void QXmppCarbonManager::setCarbonsEnabled

(

bool

enabled

)

Enables or disables message carbons for this connection.

This function does not check whether the server supports message carbons, but just sends the corresponding stanza to the server, so one must check in advance by using the discovery manager.

By default, carbon copies are disabled.

---

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

• QXmppCarbonManager.h
• QXmppCarbonManager.cpp