Package com.earth2me.essentials.messaging

Enum IMessageRecipient.MessageResponse

java.lang.Object

java.lang.Enum<IMessageRecipient.MessageResponse>

com.earth2me.essentials.messaging.IMessageRecipient.MessageResponse

All Implemented Interfaces:

Serializable, Comparable<IMessageRecipient.MessageResponse>

Enclosing interface:

IMessageRecipient

public static enum IMessageRecipient.MessageResponse
extends Enum<IMessageRecipient.MessageResponse>

Represents a response for sending or receiving a message when using IMessageRecipient.sendMessage(IMessageRecipient, String) or IMessageRecipient.onReceiveMessage(IMessageRecipient, String).

Enum Constant Summary

Enum Constants

Enum Constant	Description
EVENT_CANCELLED	States that the message was NOT received as a result of the message pre-send event being cancelled.
MESSAGES_IGNORED	States that the message was NOT received as a result of the receiver ignoring all messages.
SENDER_IGNORED	States that the message was NOT received as a result of the sender being ignored by the recipient.
SUCCESS	States that the message was received and assumed readable by the receiver.
SUCCESS_BUT_AFK	States that the message was received, but the receiver was away, assuming the message was not read.
UNREACHABLE	States that the message was NOT received as a result of the recipient being unreachable.

Method Summary

Modifier and Type	Method	Description
boolean	isSuccess()	Returns whether this response is a success.
static IMessageRecipient.MessageResponse	valueOf(String name)	Returns the enum constant of this type with the specified name.
static IMessageRecipient.MessageResponse[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final IMessageRecipient.MessageResponse SUCCESS

States that the message was received and assumed readable by the receiver.

SUCCESS_BUT_AFK

public static final IMessageRecipient.MessageResponse SUCCESS_BUT_AFK

States that the message was received, but the receiver was away, assuming the message was not read.

MESSAGES_IGNORED

public static final IMessageRecipient.MessageResponse MESSAGES_IGNORED

States that the message was NOT received as a result of the receiver ignoring all messages.

SENDER_IGNORED

public static final IMessageRecipient.MessageResponse SENDER_IGNORED

States that the message was NOT received as a result of the sender being ignored by the recipient.

UNREACHABLE

public static final IMessageRecipient.MessageResponse UNREACHABLE

States that the message was NOT received as a result of the recipient being unreachable.

EVENT_CANCELLED

public static final IMessageRecipient.MessageResponse EVENT_CANCELLED

States that the message was NOT received as a result of the message pre-send event being cancelled.

Method Details

values

public static IMessageRecipient.MessageResponse[] values()

Returns an array containing the constants of this enum type, in the order they are declared.

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static IMessageRecipient.MessageResponse valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

isSuccess

public boolean isSuccess()

Returns whether this response is a success. In other words equal to SUCCESS or SUCCESS_BUT_AFK

Returns:

whether the response is a success