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

Interface ChannelUserListChangeEvent

All Superinterfaces:

ClientEvent, ClientLinked, ServerMessageEvent

All Known Implementing Classes:

ChannelJoinEvent, ChannelKickEvent, ChannelPartEvent, RequestedChannelJoinCompleteEvent, UnexpectedChannelLeaveViaKickEvent, UnexpectedChannelLeaveViaPartEvent, UserQuitEvent

public interface ChannelUserListChangeEvent
extends ServerMessageEvent

A Channel is gaining or losing a User

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ChannelUserListChangeEvent.Change Describes the change occurring.

Method Summary

Modifier and Type	Method and Description
@NonNull Optional<Channel>	getAffectedChannel() Gets the channel affected or empty if affecting all channels the user is present in.
@NonNull ChannelUserListChangeEvent.Change	getChange() Gets the type of change occurring.
@NonNull User	getUser() Gets the current user affected.

Methods inherited from interface org.kitteh.irc.client.library.event.helper.ServerMessageEvent

getSource, getTag, getTag, getTags

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

getClient

Method Detail

getAffectedChannel

@NonNull Optional<Channel> getAffectedChannel()

Gets the channel affected or empty if affecting all channels the user is present in.

Returns:

channel or empty if all channels affected

getChange

@NonNull ChannelUserListChangeEvent.Change getChange()

Gets the type of change occurring.

Returns:

type of change

getUser

@NonNull User getUser()

Gets the current user affected.

Returns:

user