OPAL  Version 3.18.8
OpalIM Class Reference

#include <im.h>

Inherits PObject.

Collaboration diagram for OpalIM:

Public Types

typedef uint32_t MessageID
 

Public Member Functions

 OpalIM ()
 

Static Public Member Functions

static MessageID GetNextMessageId ()
 

Data Fields

PString m_conversationId
 Identifier for the conversation of messages. More...
 
PURL m_to
 URL for destination of message. More...
 
OpalTransportAddress m_toAddr
 Physical address for destination of message. More...
 
PURL m_from
 URL for source of message. More...
 
OpalTransportAddress m_fromAddr
 Physical address for source of message. More...
 
PString m_fromName
 Alias (human readable) name for source of message. More...
 
PStringToString m_bodies
 Map of MIME types to body text, e.g. "text/plain", "Hello Bob!". More...
 
PMultiPartList m_bodyParts
 More detailed information on the body data. More...
 
MessageID m_messageId
 

Detailed Description

Class representing an Instant Message event. Whenever something happens with an IM conversation, this encapsulates all the information relevant to the event. For example the text of the instant message would arrive this way, and also status indication such as composition indication.

Member Typedef Documentation

typedef uint32_t OpalIM::MessageID

Constructor & Destructor Documentation

OpalIM::OpalIM ( )

Member Function Documentation

static MessageID OpalIM::GetNextMessageId ( )
static

Field Documentation

PStringToString OpalIM::m_bodies

Map of MIME types to body text, e.g. "text/plain", "Hello Bob!".

PMultiPartList OpalIM::m_bodyParts

More detailed information on the body data.

PString OpalIM::m_conversationId

Identifier for the conversation of messages.

PURL OpalIM::m_from

URL for source of message.

OpalTransportAddress OpalIM::m_fromAddr

Physical address for source of message.

PString OpalIM::m_fromName

Alias (human readable) name for source of message.

MessageID OpalIM::m_messageId

Unique identifier for OpalIM instance for matching multiple simultaneous message states.

PURL OpalIM::m_to

URL for destination of message.

OpalTransportAddress OpalIM::m_toAddr

Physical address for destination of message.


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