QXmpp  Version:0.9.3
Public Types | Public Member Functions
QXmppMessage Class Reference

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

#include <QXmppMessage.h>

Inheritance diagram for QXmppMessage:
QXmppStanza

List of all members.

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.
QXmppMessageoperator= (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)

Detailed Description

The QXmppMessage class represents an XMPP message.


Member Enumeration Documentation

This enum describes a chat marker as defined by XEP-0333 : Char Markers

This enum describes a chat state as defined by XEP-0085 : Chat State Notifications.

Enumerator:
None 

The message does not contain any chat state information.

Active 

User is actively participating in the chat session.

Inactive 

User has not been actively participating in the chat session.

Gone 

User has effectively ended their participation in the chat session.

Composing 

User is composing a message.

Paused 

User had been composing but now has stopped.


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.

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.

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.

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.

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

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

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

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.

Returns the message's chat state.

QString QXmppMessage::subject ( ) const

Returns the message's subject.

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:
 All Classes Functions Enumerations Enumerator Properties