jerklib.events
Interface AwayEvent

All Superinterfaces:

IRCEvent

All Known Implementing Classes:

AwayEventImpl

public interface AwayEvent
extends IRCEvent

This is an event that is fired under three conditions:

• Sending a message to a user who is marked as away.
• User of lib marks self as away.
• User of lib returns from away.

You can determine under which circumstance the event was fired by looking at the AwayEvent.EventType.

Author:

Robert O'Connor

Nested Class Summary

static class

AwayEvent.EventType An enum to determine the type of event that was fired.

Nested classes/interfaces inherited from interface jerklib.events.IRCEvent

IRCEvent.Type

Method Summary

String	getAwayMessage() Returns the away message or an empty String if it was user of lib who caused the event to fire.
AwayEvent.EventType	getEventType() Return the event type that was fired
String	getNick() Get the nick who fired the event.
boolean	isAway() Whether or not subject of event is away.
boolean	isYou() Whether or not it was user of lib that caused this event

Methods inherited from interface jerklib.events.IRCEvent

getRawEventData, getSession, getType

Method Detail

getEventType

AwayEvent.EventType getEventType()

Return the event type that was fired

Returns:

the type of event that was fired.

See Also:

AwayEvent.EventType

isAway

boolean isAway()

Whether or not subject of event is away.

Returns:

if we're away or not.

getAwayMessage

String getAwayMessage()

Returns the away message or an empty String if it was user of lib who caused the event to fire.

Returns:

the away message

isYou

boolean isYou()

Whether or not it was user of lib that caused this event

Returns:

if it was us or not.

getNick

String getNick()

Get the nick who fired the event.

Returns:

the nick of the user who caused the event to fire.