public class UserListEvent extends Event implements GenericChannelEvent
Shortly after joining a channel, the IRC server sends a list of all users in that channel. The PircBotX collects this information and dispatched this event as soon as it has the full list.
To obtain the nick of each user in the channel, call the
UserHostmask.getNick()
method on each User object in getUsers()
User
,
Channel.getUsers()
Constructor and Description |
---|
UserListEvent(PircBotX bot,
Channel channel,
com.google.common.collect.ImmutableSortedSet<User> users,
boolean complete) |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object o) |
Channel |
getChannel()
The channel that the user list is from.
|
com.google.common.collect.ImmutableSortedSet<User> |
getUsers()
An immutable Set of Users belonging to this channel.
|
int |
hashCode() |
boolean |
isComplete()
True if from a WHO response meaning login, hostmask, mode, etc was given,
false if from a NAMES response meaning only nick was given
|
void |
respond(String response)
Respond with a message to the channel that the userlist was from
|
String |
toString() |
compareTo, getBot, getId, getTimestamp
getBot, getTimestamp
compareTo
public void respond(String response)
respond
in interface GenericEvent
respond
in class Event
response
- The response to send@Generated(value="lombok") public com.google.common.collect.ImmutableSortedSet<User> getUsers()
@Generated(value="lombok") public boolean isComplete()
@Generated(value="lombok") public Channel getChannel()
getChannel
in interface GenericChannelEvent
Copyright © 2010–2020 Leon Blakey. All rights reserved.