#include <events.h>
Inheritance diagram for ICQ2000::MessageEvent:

Public Types | |
| enum | MessageType { Normal, URL, SMS, SMS_Receipt, AuthReq, AuthAck, AwayMessage, EmailEx, UserAdd, Email, WebPager } |
| enum of the type of the message | |
| enum | DeliveryFailureReason { Failed, Failed_NotConnected, Failed_ClientNotCapable, Failed_Denied, Failed_Ignored, Failed_Occupied, Failed_DND, Failed_SMTP } |
Public Methods | |
| MessageEvent (ContactRef c) | |
| Constructor for a MessageEvent. | |
| virtual | ~MessageEvent () |
| Destructor for MessageEvent. | |
| virtual MessageType | getType () const=0 |
| get the type of the MessageEvent | |
| ContactRef | getContact () |
| get the contact related to the event | |
| bool | isFinished () const |
| get if a message event is finished. | |
| bool | isDelivered () const |
| get if a message event was delivered. | |
| bool | isDirect () const |
| get if a message event was sent direct. | |
| void | setFinished (bool f) |
| set whether the message has been finished. | |
| void | setDelivered (bool f) |
| set whether the message has been delivered. | |
| void | setDirect (bool f) |
| set whether the message has been sent direct. | |
| DeliveryFailureReason | getDeliveryFailureReason () const |
| get the reason for delivery failure. | |
| void | setDeliveryFailureReason (DeliveryFailureReason d) |
| set the reason for delivery failure. | |
Protected Attributes | |
| ContactRef | m_contact |
| the contact related to the MessageEvent | |
| bool | m_finished |
| whether the event is finished | |
| bool | m_delivered |
| whether the event was delivered | |
| bool | m_direct |
| whether the event was sent direct | |
| DeliveryFailureReason | m_failure_reason |
MessageEvents are used for messages, URLs, SMSs, Authorisation request/responses and away messages.
|
|
Constructor for a MessageEvent.
|
|
|
get the contact related to the event
|
|
|
get the reason for delivery failure. Defined when getFinished == false and getDelivered == false too. This is used in the message ack'ing system.
|
|
|
get the type of the MessageEvent
Implemented in ICQ2000::NormalMessageEvent, ICQ2000::URLMessageEvent, ICQ2000::SMSMessageEvent, ICQ2000::SMSReceiptEvent, ICQ2000::AwayMessageEvent, ICQ2000::AuthReqEvent, ICQ2000::AuthAckEvent, ICQ2000::EmailExEvent, ICQ2000::WebPagerEvent, ICQ2000::UserAddEvent, and ICQ2000::EmailMessageEvent. |
|
|
get if a message event was delivered. This is used in the message ack'ing system.
|
|
|
get if a message event was sent direct. This is used in the message ack'ing system.
|
|
|
get if a message event is finished. This is used in the message ack'ing system.
|
|
|
set whether the message has been delivered.
|
|
|
set the reason for delivery failure. Used to indicate the failure reason when a client marks a message as not accepted (by setDeliverd(false) in the messaged callback).
|
|
|
set whether the message has been sent direct. This is used internally by the library and is of no interest to the client.
|
|
|
set whether the message has been finished. This is used internally by the library and is of no interest to the client.
|
1.2.16