QXmppMessage Class Reference

The QXmppMessage class represents an XMPP message. More...

#include <QXmppMessage.h>

Inheritance diagram for QXmppMessage:

Collaboration diagram for QXmppMessage:

Public Types
enum	Type {   Error = 0, Normal, Chat, GroupChat,   Headline }
	This enum described a message type.
enum	State {   None = 0, Active, Inactive, Gone,   Composing, Paused }
enum	Marker { NoMarker = 0, Received, Displayed, Acknowledged }

Public Member Functions
	QXmppMessage (const QString &from=QString(), const QString &to=QString(), const QString &body=QString(), const QString &thread=QString())
	QXmppMessage (const QXmppMessage &other)
	Constructs a copy of other.
QXmppMessage &	operator= (const QXmppMessage &other)
	Assigns other to this message.
QString	body () const
void	setBody (const QString &)
bool	isAttentionRequested () const
void	setAttentionRequested (bool requested)
bool	isReceiptRequested () const
void	setReceiptRequested (bool requested)
QString	mucInvitationJid () const
void	setMucInvitationJid (const QString &jid)
QString	mucInvitationPassword () const
void	setMucInvitationPassword (const QString &password)
QString	mucInvitationReason () const
void	setMucInvitationReason (const QString &reason)
QString	receiptId () const
void	setReceiptId (const QString &id)
QDateTime	stamp () const
	Returns the message's timestamp (if any).
void	setStamp (const QDateTime &stamp)
QXmppMessage::State	state () const
void	setState (QXmppMessage::State)
QString	subject () const
void	setSubject (const QString &)
QString	thread () const
	Returns the message's thread.
void	setThread (const QString &)
QXmppMessage::Type	type () const
void	setType (QXmppMessage::Type)
QString	xhtml () const
void	setXhtml (const QString &xhtml)
bool	isMarkable () const
void	setMarkable (const bool)
QString	markedId () const
void	setMarkerId (const QString &)
QString	markedThread () const
void	setMarkedThread (const QString &)
Marker	marker () const
void	setMarker (const Marker)
Public Member Functions inherited from QXmppStanza
	QXmppStanza (const QString &from=QString(), const QString &to=QString())
	QXmppStanza (const QXmppStanza &other)
	Constructs a copy of other.
virtual	~QXmppStanza ()
	Destroys a QXmppStanza.
QXmppStanza &	operator= (const QXmppStanza &other)
	Assigns other to this stanza.
QString	to () const
void	setTo (const QString &)
QString	from () const
	Returns the stanza's sender JID.
void	setFrom (const QString &)
QString	id () const
	Returns the stanza's identifier.
void	setId (const QString &)
QString	lang () const
	Returns the stanza's language.
void	setLang (const QString &)
QXmppStanza::Error	error () const
	Returns the stanza's error.
void	setError (const QXmppStanza::Error &error)
QXmppElementList	extensions () const
void	setExtensions (const QXmppElementList &elements)
QList< QXmppExtendedAddress >	extendedAddresses () const
void	setExtendedAddresses (const QList< QXmppExtendedAddress > &extendedAddresses)

Detailed Description

The QXmppMessage class represents an XMPP message.

Constructor & Destructor Documentation

QXmppMessage::QXmppMessage	(	const QString &	from = QString(),
		const QString &	to = QString(),
		const QString &	body = QString(),
		const QString &	thread = QString()
	)

Constructs a QXmppMessage.

Parameters

from
to
body
thread

Member Function Documentation

QString QXmppMessage::body

(

)

const

Returns the message's body.

bool QXmppMessage::isAttentionRequested

(

)

const

Returns true if the user's attention is requested, as defined by XEP-0224: Attention.

bool QXmppMessage::isMarkable

(

)

const

Returns true if a message is markable, as defined XEP-0333: Chat Markers.

bool QXmppMessage::isReceiptRequested

(

)

const

Returns true if a delivery receipt is requested, as defined by XEP-0184: Message Delivery Receipts.

QString QXmppMessage::markedId

(

)

const

Returns the message's marker id, as defined XEP-0333: Chat Markers.

QString QXmppMessage::markedThread

(

)

const

Returns the message's marker thread, as defined XEP-0333: Chat Markers.

QXmppMessage::Marker QXmppMessage::marker

(

)

const

Returns the message's marker, as defined XEP-0333: Chat Markers.

QString QXmppMessage::mucInvitationJid

(

)

const

Returns the JID for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

QString QXmppMessage::mucInvitationPassword

(

)

const

Returns the password for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

QString QXmppMessage::mucInvitationReason

(

)

const

Returns the reason for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

QString QXmppMessage::receiptId

(

)

const

If this message is a delivery receipt, returns the ID of the original message.

void QXmppMessage::setAttentionRequested

(

bool

requested

)

Sets whether the user's attention is requested, as defined by XEP-0224: Attention.

param requested

void QXmppMessage::setBody

(

const QString &

body

)

Sets the message's body.

Parameters

body

void QXmppMessage::setMarkable

(

const bool

markable

)

Sets if the message is markable, as defined XEP-0333: Chat Markers.

void QXmppMessage::setMarkedThread

(

const QString &

markedThread

)

Sets the message's marked thread, as defined XEP-0333: Chat Markers.

void QXmppMessage::setMarker

(

const Marker

marker

)

Sets the message's marker, as defined XEP-0333: Chat Markers

void QXmppMessage::setMarkerId

(

const QString &

markerId

)

Sets the message's marker id, as defined XEP-0333: Chat Markers.

void QXmppMessage::setMucInvitationJid

(

const QString &

jid

)

Sets the JID for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

void QXmppMessage::setMucInvitationPassword

(

const QString &

password

)

Sets the password for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

void QXmppMessage::setMucInvitationReason

(

const QString &

reason

)

Sets the reason for a multi-user chat direct invitation as defined by XEP-0249: Direct MUC Invitations.

void QXmppMessage::setReceiptId

(

const QString &

id

)

Make this message a delivery receipt for the message with the given id.

void QXmppMessage::setReceiptRequested

(

bool

requested

)

Sets whether a delivery receipt is requested, as defined by XEP-0184: Message Delivery Receipts.

param requested

void QXmppMessage::setStamp

(

const QDateTime &

stamp

)

Sets the message's timestamp.

Parameters

stamp

void QXmppMessage::setState

(

QXmppMessage::State

state

)

Sets the message's chat state.

Parameters

state

void QXmppMessage::setSubject

(

const QString &

subject

)

Sets the message's subject.

Parameters

subject

void QXmppMessage::setThread

(

const QString &

thread

)

Sets the message's thread.

Parameters

thread

void QXmppMessage::setType

(

QXmppMessage::Type

type

)

Sets the message's type.

Parameters

type

void QXmppMessage::setXhtml

(

const QString &

xhtml

)

Sets the message's XHTML body as defined by XEP-0071: XHTML-IM.

QXmppMessage::State QXmppMessage::state

(

)

const

Returns the message's chat state.

QString QXmppMessage::subject

(

)

const

Returns the message's subject.

QXmppMessage::Type QXmppMessage::type

(

)

const

Returns the message's type.

QString QXmppMessage::xhtml

(

)

const

Returns the message's XHTML body as defined by XEP-0071: XHTML-IM.

---

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

• QXmppMessage.h
• QXmppMessage.cpp