#include <messageeventfilter.h>
Inherits MessageFilter.
Inheritance diagram for MessageEventFilter:
Public Member Functions | |
MessageEventFilter (MessageSession *parent, int defaultEvents=MessageEventOffline|MessageEventDelivered|MessageEventDisplayed|MessageEventComposing) | |
virtual | ~MessageEventFilter () |
void | raiseMessageEvent (MessageEventType event) |
void | registerMessageEventHandler (MessageEventHandler *meh) |
void | removeMessageEventHandler () |
virtual void | decorate (Tag *tag) |
virtual void | filter (Stanza *stanza) |
This implementation of Message Events is fully transparent to the user of the class. If the remote entity does not request message events, MessageEventFilter will not send any, even if the user requests it. (This is required by the protocol specification.)
Definition at line 37 of file messageeventfilter.h.
MessageEventFilter | ( | MessageSession * | parent, | |
int | defaultEvents = MessageEventOffline|MessageEventDelivered|MessageEventDisplayed|MessageEventComposing | |||
) |
Contstructs a new Message Event filter for a MessageSession.
parent | The MessageSession to decorate. | |
defaultEvents | Bit-wise ORed MessageEventType's which shall be requested for every message sent. Default: all. |
Definition at line 22 of file messageeventfilter.cpp.
~MessageEventFilter | ( | ) | [virtual] |
Virtual destructor.
Definition at line 28 of file messageeventfilter.cpp.
void raiseMessageEvent | ( | MessageEventType | event | ) |
Use this function to raise an event as defined in JEP-0022.
event | The event to raise. |
Definition at line 72 of file messageeventfilter.cpp.
void registerMessageEventHandler | ( | MessageEventHandler * | meh | ) |
The MessageEventHandler registered here will receive Message Events according to JEP-0022.
meh | The MessageEventHandler to register. |
Definition at line 135 of file messageeventfilter.cpp.
void removeMessageEventHandler | ( | ) |
This function clears the internal pointer to the MessageEventHandler. Message Events will not be delivered anymore after calling this function until another MessageEventHandler is registered.
Definition at line 140 of file messageeventfilter.cpp.
void decorate | ( | Tag * | tag | ) | [virtual] |
This function receives a message right before it is sent out (there may be other filters which get to see the message after this filter, though).
tag | The tag to decorate. It contains the message to be sent. |
Implements MessageFilter.
Definition at line 116 of file messageeventfilter.cpp.
void filter | ( | Stanza * | stanza | ) | [virtual] |
This function receives a message stanza right after it was received (there may be other filters which got to see the stanza before this filter, though).
stanza | The complete message stanza. |
Implements MessageFilter.
Definition at line 32 of file messageeventfilter.cpp.