com.genesyslab.ail.event
Interface InteractionChatEvent

All Superinterfaces:
ObjectEvent, java.io.Serializable

public interface InteractionChatEvent
extends ObjectEvent

An event reporting a new message in a chat session. When a party sends a new message, it will be notified to all the listeners with this event.

See Also:
InteractionChatListener

Nested Class Summary
static class InteractionChatEvent.Type
          Constants for possible types of InteractionChatEvent
 
Method Summary
 java.util.Date getDate()
          Returns the date when this event was sent.
 InteractionChatEvent.Type getEventType()
          Returns the type of this event.
 InteractionChat getInteractionChat()
          Returns the InteractionChat to which this event is related.
 int getNumber()
          Returns the index of this event in the range [0..n] where 0 is the first event since the session creation and n the last event received.
 ChatParty getParty()
          Returns the party which has generated this event.
 java.lang.String getText()
          Returns the event's text message for event of type.
 boolean treatAsSystem()
          Returns true if this message was generated by the system.
 
Methods inherited from interface com.genesyslab.ail.event.ObjectEvent
getSource
 

Method Detail

getNumber

int getNumber()
Returns the index of this event in the range [0..n] where 0 is the first event since the session creation and n the last event received.

Returns:
the event number as int.

getEventType

InteractionChatEvent.Type getEventType()
Returns the type of this event.

Returns:
a type as InteractionChatEvent.Type.

getDate

java.util.Date getDate()
Returns the date when this event was sent.

Returns:
a date as Date.

getParty

ChatParty getParty()
Returns the party which has generated this event.

Returns:
a party as ChatParty.

treatAsSystem

boolean treatAsSystem()
Returns true if this message was generated by the system.


getText

java.lang.String getText()
Returns the event's text message for event of type.

Returns:
a text as String.

getInteractionChat

InteractionChat getInteractionChat()
Returns the InteractionChat to which this event is related. This method returns the same as getSource().

Returns:
a chat interaction as InteractionChat.