com.github.agadar.nationstates.event

Class TelegramSentEvent

java.lang.Object

java.util.EventObject

com.github.agadar.nationstates.event.TelegramSentEvent

All Implemented Interfaces:

Serializable

public class TelegramSentEvent
extends EventObject

Event fired when a telegram has been sent.

Author:

Agadar (https://github.com/Agadar/)

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
String	errorMessage Contains a message elaborating on why the telegram failed to be sent, if applicable.
int	positionInQuery The position of the sent telegram in the query.
boolean	queued Whether or not the telegram was successfully queued.
String	recipient Name of the nation the telegram was sent to.

Fields inherited from class java.util.EventObject

source

Constructor Summary

Constructors

Constructor and Description
TelegramSentEvent(Object source, String recipient, boolean queued, String errorMessage, int positionInQuery) Constructs a new TelegramSentEvent.

Method Summary

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

recipient

public final String recipient

Name of the nation the telegram was sent to.

queued

public final boolean queued

Whether or not the telegram was successfully queued.

errorMessage

public final String errorMessage

Contains a message elaborating on why the telegram failed to be sent, if applicable.

positionInQuery

public final int positionInQuery

The position of the sent telegram in the query. Starts at 0 and increments by 1 for each telegram sent.

Constructor Detail

TelegramSentEvent

public TelegramSentEvent(Object source,
                         String recipient,
                         boolean queued,
                         String errorMessage,
                         int positionInQuery)

Constructs a new TelegramSentEvent.

Parameters:

source - the object that fired the event

recipient - the name of the nation the telegram was sent to

queued - whether or not the telegram was successfully queued

errorMessage - a message elaborating on why the telegram failed to be sent, if applicable

positionInQuery - the position of the sent telegram in the query