net.java.sip.communicator.service.protocol.event
Class ChatRoomMessageDeliveryFailedEvent

java.lang.Object
  java.util.EventObject
      net.java.sip.communicator.service.protocol.event.ChatRoomMessageDeliveryFailedEvent

All Implemented Interfaces:

Serializable

public class ChatRoomMessageDeliveryFailedEvent
extends EventObject

ChatRoomMessageDeliveredEvents confirm successful delivery of an instant message.

Author:

Emil Ivov, Yana Stamcheva

See Also:

Serialized Form

Field Summary

static int	INTERNAL_ERROR Set when delivery fails for implementation specific reasons.
static int	NETWORK_FAILURE Set when delivery fails due to a failure in network communications or a transport error.
static int	OFFLINE_MESSAGES_NOT_SUPPORTED Set when delivery fails because we're trying to send a message to a contact that is currently offline and the server does not support offline messages.
static int	PROVIDER_NOT_REGISTERED Set to indicate that delivery has failed because the provider was not registered.
static int	UNKNOWN_ERROR Set when no other error code can describe the exception that occurred.

Fields inherited from class java.util.EventObject

source

Constructor Summary

ChatRoomMessageDeliveryFailedEvent(ChatRoom source, ChatRoomMember to, int errorCode, String reason, Date timestamp, Message message)
Creates a ChatRoomMessageDeliveryFailedEvent indicating failure of delivery of a message to the specified ChatRoomMember in the specified ChatRoom.

Method Summary

ChatRoomMember	getDestinationChatRoomMember() Returns a reference to the ChatRoomMember that the source (failed) Message was sent to.
int	getErrorCode() Returns an error code descibing the reason for the failure of the message delivery.
Message	getMessage() Returns the received message.
String	getReason() Returns the reason of the delivery failure.
ChatRoom	getSourceChatRoom() Returns the ChatRoom that triggered this event.
Date	getTimestamp() A timestamp indicating the exact date when the event ocurred (in this case it is the moment when it was determined that message delivery has failed).

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

UNKNOWN_ERROR

public static final int UNKNOWN_ERROR

Set when no other error code can describe the exception that occurred.

See Also:

Constant Field Values

NETWORK_FAILURE

public static final int NETWORK_FAILURE

Set when delivery fails due to a failure in network communications or a transport error.

See Also:

Constant Field Values

PROVIDER_NOT_REGISTERED

public static final int PROVIDER_NOT_REGISTERED

Set to indicate that delivery has failed because the provider was not registered.

See Also:

Constant Field Values

INTERNAL_ERROR

public static final int INTERNAL_ERROR

Set when delivery fails for implementation specific reasons.

See Also:

Constant Field Values

OFFLINE_MESSAGES_NOT_SUPPORTED

public static final int OFFLINE_MESSAGES_NOT_SUPPORTED

Set when delivery fails because we're trying to send a message to a contact that is currently offline and the server does not support offline messages.

See Also:

Constant Field Values

Constructor Detail

ChatRoomMessageDeliveryFailedEvent

public ChatRoomMessageDeliveryFailedEvent(ChatRoom source,
                                          ChatRoomMember to,
                                          int errorCode,
                                          String reason,
                                          Date timestamp,
                                          Message message)

Creates a ChatRoomMessageDeliveryFailedEvent indicating failure of delivery of a message to the specified ChatRoomMember in the specified ChatRoom.

Parameters:

source - the ChatRoom in which the message was sent

to - the ChatRoomMember that this message was sent to.

errorCode - an errorCode indicating the reason of the failure.

reason - the reason of the failure

timestamp - the exacte Date when it was determined that delivery had failed.

message - the received Message.

Method Detail

getDestinationChatRoomMember

public ChatRoomMember getDestinationChatRoomMember()

Returns a reference to the ChatRoomMember that the source (failed) Message was sent to.

Returns:

a reference to the ChatRoomMember that the source failed Message was sent to.

getMessage

public Message getMessage()

Returns the received message.

Returns:

the Message that triggered this event.

getErrorCode

public int getErrorCode()

Returns an error code descibing the reason for the failure of the message delivery.

Returns:

an error code descibing the reason for the failure of the message delivery.

getReason

public String getReason()

Returns the reason of the delivery failure.

Returns:

the reason of the delivery failure

getTimestamp

public Date getTimestamp()

A timestamp indicating the exact date when the event ocurred (in this case it is the moment when it was determined that message delivery has failed).

Returns:

a Date indicating when the event ocurred.

getSourceChatRoom

public ChatRoom getSourceChatRoom()

Returns the ChatRoom that triggered this event.

Returns:

the ChatRoom that triggered this event.