org.kitteh.irc.client.library.event.helper

Interface ServerMessageEvent

All Superinterfaces:

ClientEvent, ClientLinked

All Known Subinterfaces:

ActorMessageEvent<A>, ChannelUserListChangeEvent, ClientReceiveServerMessageEvent, CtcpEvent, MessageEvent, MonitoredNickStatusEvent, ReplyableEvent

All Known Implementing Classes:

AckEvent, ActorChannelEventBase, ActorChannelMessageEventBase, ActorEventBase, ActorMessageEventBase, ActorPrivateMessageEventBase, CapabilitiesAcknowledgedEvent, CapabilitiesDeletedSupportedEvent, CapabilitiesNewSupportedEvent, CapabilitiesRejectedEvent, CapabilityNegotiationResponseEventBase, CapabilityNegotiationResponseEventWithRequestBase, ChannelCtcpEvent, ChannelEventBase, ChannelInviteEvent, ChannelJoinEvent, ChannelKickEvent, ChannelKnockEvent, ChannelMessageEvent, ChannelModeEvent, ChannelNoticeEvent, ChannelPartEvent, ChannelTagMessageEvent, ChannelTargetedCtcpEvent, ChannelTargetedMessageEvent, ChannelTargetedNoticeEvent, ChannelTargetedTagMessageEvent, ChannelTopicEvent, ClearChatEvent, ClientAwayStatusChangeEvent, ClientBatchEndEvent, ClientBatchEventBase, ClientBatchMessageEvent, ClientBatchStartEvent, ClientReceiveCommandEvent, ClientReceiveNumericEvent, ClientReceiveServerMessageEventBase, FailEvent, GlobalUserStateEvent, ISupportParameterEvent, MonitoredNickEventBase, MonitoredNickListFullEvent, MonitoredNickOfflineEvent, MonitoredNickOnlineEvent, NickRejectedEvent, NoteEvent, PrivateCtcpQueryEvent, PrivateCtcpReplyEvent, PrivateEventBase, PrivateMessageEvent, PrivateNoticeEvent, PrivateTagMessageEvent, RequestedChannelJoinCompleteEvent, RoomStateEvent, ServerMessageEventBase, ServerNoticeEvent, StandardReplyEvent, TargetedUserChannelMessageEventBase, UnexpectedChannelLeaveViaKickEvent, UnexpectedChannelLeaveViaPartEvent, UserAccountStatusEvent, UserAwayMessageEvent, UserHostnameChangeEvent, UserInfoChangeEventBase, UserModeEvent, UserNickChangeEvent, UserNoticeEvent, UserQuitEvent, UserRealnameChangeEvent, UserStateEvent, UserUserStringChangeEvent, WallopsEvent, WarnEvent, WhisperEvent

public interface ServerMessageEvent
extends ClientEvent

Represents an event triggered by a single message from the server.

Method Summary

Modifier and Type	Method and Description
ServerMessage	getSource() Gets the server-sent message that caused this event.
default Optional<MessageTag>	getTag(@NonNull String name) Gets the named tag if present.
default <Tag extends MessageTag> @NonNull Optional<Tag>	getTag(@NonNull String name, @NonNull Class<Tag> clazz) Gets the named message tag if present and if of the specified type.
default @NonNull List<MessageTag>	getTags() Gets the tags for this tag message.

Methods inherited from interface org.kitteh.irc.client.library.element.ClientLinked

getClient

Method Detail

getSource

ServerMessage getSource()

Gets the server-sent message that caused this event.

Returns:

the server-sent message that caused this event

getTags

default @NonNull List<MessageTag> getTags()

Gets the tags for this tag message.

Returns:

a list of tags

getTag

default Optional<MessageTag> getTag(@NonNull String name)

Gets the named tag if present.

Parameters:

name - tag name

Returns:

tag if present

getTag

default <Tag extends MessageTag> @NonNull Optional<Tag> getTag(@NonNull String name,
                                                               @NonNull Class<Tag> clazz)

Gets the named message tag if present and if of the specified type.

Type Parameters:

Tag - message tag type

Parameters:

name - message tag name

clazz - message tag type

Returns:

message tag if present