QMailNewInstantMessageHandler Class Reference
[QtMessagingModule]

Detailed Description

The QMailNewInstantMessageHandler class provides a convenient interface for responding to new instant message arrival notifications emitted by the message server.

When a new instant message is retrieved by the message server, the NewInstantMessageArrival::arrived(QDSActionRequest) service request is emitted. If a process registers to handle this request and instantiates a QMailNewInstantMessageHandler object, the handler object will process the service request and emit the newCountChanged() signal.

In response to the newCountChanged() signal, the handler process should invoke the setHandled() slot, to communicate whether or not they have handled the event to the message server. If any handler process reports the event as handled, then the count of new instant message messages will be reset, and those messages will have the QMailMessage::New status flag unset.

Note: if a process instantiates a QMailNewInstantMessageHandler, it will not do anything unless the process is also registered to handle the NewInstantMessageArrival service.

Member Function Documentation

QMailNewInstantMessageHandler::QMailNewInstantMessageHandler ( QObject * parent = 0 )

Constructs a new handler for the NewInstantMessageArrival service, with the specified parent.

QMailMessage::MessageType QMailNewInstantMessageHandler::messageType () const   [virtual]

Returns QMailMessage::Instant, the type of messages handled by QMailNewInstantMessageHandler.

Reimplemented from QMailNewMessageHandler.