PTLib  Version 2.10.4
XMPP::Message Class Reference

#include <xmpp.h>

Inheritance diagram for XMPP::Message:
XMPP::Stanza PXML PXMLBase PObject

List of all members.

Public Types

enum  MessageType {
  Normal, Chat, Error, GroupChat,
  HeadLine, Unknown = 999
}

Public Member Functions

 Message ()
 Construct a new empty message.
 Message (PXML &pdu)
 Construct a message from a (received) xml PDU.
 Message (PXML *pdu)
virtual PBoolean IsValid () const
virtual MessageType GetType (PString *typeName=0) const
virtual PString GetLanguage () const
virtual PString GetSubject (const PString &lang=PString::Empty())
 Get the subject for the specified language.
virtual PString GetBody (const PString &lang=PString::Empty())
virtual PString GetThread ()
virtual PXMLElementGetSubjectElement (const PString &lang=PString::Empty())
virtual PXMLElementGetBodyElement (const PString &lang=PString::Empty())
virtual void SetType (MessageType type)
virtual void SetType (const PString &type)
virtual void SetLanguage (const PString &lang)
virtual void SetSubject (const PString &subj, const PString &lang=PString::Empty())
virtual void SetBody (const PString &body, const PString &lang=PString::Empty())
virtual void SetThread (const PString &thrd)

Static Public Member Functions

static const PCaselessStringTypeTag ()
 Various constant strings.
static const PCaselessStringSubjectTag ()
static const PCaselessStringBodyTag ()
static const PCaselessStringThreadTag ()
static PBoolean IsValid (const PXML *pdu)

Member Enumeration Documentation

Enumerator:
Normal 
Chat 
Error 
GroupChat 
HeadLine 
Unknown 

Constructor & Destructor Documentation

Construct a new empty message.

Construct a message from a (received) xml PDU.

The root of the pdu MUST be a message stanza. NOTE: the root of the pdu is cloned.


Member Function Documentation

static const PCaselessString& XMPP::Message::BodyTag ( ) [static]
virtual PString XMPP::Message::GetBody ( const PString lang = PString::Empty()) [virtual]
virtual PXMLElement* XMPP::Message::GetBodyElement ( const PString lang = PString::Empty()) [virtual]
virtual PString XMPP::Message::GetLanguage ( ) const [virtual]
virtual PString XMPP::Message::GetSubject ( const PString lang = PString::Empty()) [virtual]

Get the subject for the specified language.

The default subject (if any) is returned in case no language is specified or a matching one cannot be found

virtual PXMLElement* XMPP::Message::GetSubjectElement ( const PString lang = PString::Empty()) [virtual]
virtual PString XMPP::Message::GetThread ( ) [virtual]
virtual MessageType XMPP::Message::GetType ( PString typeName = 0) const [virtual]
virtual PBoolean XMPP::Message::IsValid ( ) const [virtual]

Implements XMPP::Stanza.

static PBoolean XMPP::Message::IsValid ( const PXML pdu) [static]
virtual void XMPP::Message::SetBody ( const PString body,
const PString lang = PString::Empty() 
) [virtual]
virtual void XMPP::Message::SetLanguage ( const PString lang) [virtual]
virtual void XMPP::Message::SetSubject ( const PString subj,
const PString lang = PString::Empty() 
) [virtual]
virtual void XMPP::Message::SetThread ( const PString thrd) [virtual]
virtual void XMPP::Message::SetType ( MessageType  type) [virtual]
virtual void XMPP::Message::SetType ( const PString type) [virtual]
static const PCaselessString& XMPP::Message::SubjectTag ( ) [static]
static const PCaselessString& XMPP::Message::ThreadTag ( ) [static]
static const PCaselessString& XMPP::Message::TypeTag ( ) [static]

Various constant strings.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines