Package | Description |
---|---|
org.pircbotx |
Core PircBotX classes
|
org.pircbotx.dcc | |
org.pircbotx.exception |
Custom PircBotX exceptions
|
org.pircbotx.hooks.events |
All supported events of PircBotX
|
org.pircbotx.hooks.types |
Generic Interfaces for groups of events that do generally the same thing
|
org.pircbotx.snapshot |
Modifier and Type | Class and Description |
---|---|
class |
UserChannelDao<U extends User,C extends Channel>
Model that creates and tracks Users and Channel and maintains relationships.
|
class |
UserChannelMap<U extends User,C extends Channel>
A many to many map of users to channels.
|
Modifier and Type | Method and Description |
---|---|
User |
Configuration.BotFactory.createUser(UserHostmask userHostmask) |
User |
InputParser.createUserIfNull(User otherUser,
UserHostmask hostmask) |
User |
UserChannelDao.getUserBot()
Gets the bots own user object.
|
User |
PircBotX.getUserBot()
Gets the bots own user object.
|
Modifier and Type | Method and Description |
---|---|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getHalfOps()
Get all users with Half Operator status in this channel.
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getNormalUsers()
Get all users that don't have any special status in this channel.
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getOps()
Get all opped users in this channel.
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getOwners()
Get all users with Owner status in this channel.
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getSuperOps()
Get all users with Super Operator status in this channel.
|
UserChannelDao<User,Channel> |
PircBotX.getUserChannelDao()
User-Channel mapper
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getUsers()
Get all users in this channel.
|
com.google.common.collect.ImmutableSortedSet<User> |
Channel.getVoices()
Get all voiced users in this channel.
|
Modifier and Type | Method and Description |
---|---|
int |
UserHostmask.compareTo(User other)
|
boolean |
UserChannelMap.containsUser(User user) |
ReceiveChat |
Configuration.BotFactory.createReceiveChat(PircBotX bot,
User user,
Socket socket) |
ReceiveFileTransfer |
Configuration.BotFactory.createReceiveFileTransfer(PircBotX bot,
Socket socket,
User user,
File file,
long startPosition,
long fileSize) |
SendChat |
Configuration.BotFactory.createSendChat(PircBotX bot,
User user,
Socket socket) |
SendFileTransfer |
Configuration.BotFactory.createSendFileTransfer(PircBotX bot,
Socket socket,
User user,
File file,
long startPosition) |
User |
InputParser.createUserIfNull(User otherUser,
UserHostmask hostmask) |
com.google.common.collect.ImmutableSortedSet<UserLevel> |
Channel.getUserLevels(User user)
Get all levels the user holds in this channel.
|
abstract void |
ChannelModeHandler.handleMode(PircBotX bot,
Channel channel,
UserHostmask sourceHostmask,
User sourceUser,
com.google.common.collect.PeekingIterator<String> params,
boolean adding,
boolean dispatchEvent) |
boolean |
Channel.hasVoice(User user)
Checks if the given user has Voice in this channel.
|
boolean |
Channel.isHalfOp(User user)
Checks if the given user is a Half Operator in this channel.
|
boolean |
Channel.isOp(User user)
Checks if the given user is an Operator in this channel
|
boolean |
Channel.isOwner(User user)
Checks if the given user is an Owner in this channel.
|
boolean |
Channel.isSuperOp(User user)
Checks if the given user is a Super Operator in this channel.
|
void |
InputParser.processMode(UserHostmask userHostmask,
User user,
String target,
String mode)
Called when the mode of a channel is set.
|
void |
InputParser.processUserStatus(Channel chan,
User user,
String prefix) |
Modifier and Type | Method and Description |
---|---|
User |
FileTransfer.getUser() |
User |
Chat.getUser() |
Modifier and Type | Method and Description |
---|---|
boolean |
DccHandler.processDcc(UserHostmask userHostmask,
User user,
String request) |
SendChat |
DccHandler.sendChat(User receiver)
Send a chat request using
Configuration.isDccPassiveRequest() |
SendChat |
DccHandler.sendChat(User receiver,
boolean passive)
Send a chat request using passive parameter
|
SendFileTransfer |
DccHandler.sendFile(File file,
User receiver)
Send file using
Configuration.isDccPassiveRequest() |
SendFileTransfer |
DccHandler.sendFile(File file,
User receiver,
boolean passive)
Send file using
Configuration.isDccPassiveRequest() |
Constructor and Description |
---|
FileTransfer(Configuration configuration,
Socket socket,
User user,
File file,
long startPosition,
long fileSize) |
ReceiveChat(User user,
Socket socket,
Charset encoding) |
ReceiveFileTransfer(Configuration configuration,
Socket socket,
User user,
File file,
long startPosition,
long fileSize) |
SendChat(User user,
Socket socket,
Charset encoding) |
SendFileTransfer(Configuration configuration,
Socket socket,
User user,
File file,
long startPosition) |
Modifier and Type | Method and Description |
---|---|
User |
DccException.getUser() |
Constructor and Description |
---|
DccException(DccException.Reason reason,
User user,
String detail) |
DccException(DccException.Reason reason,
User user,
String detail,
Throwable cause) |
Modifier and Type | Method and Description |
---|---|
User |
VoiceEvent.getRecipient()
The nick of the user that got 'voiced'.
|
User |
UserModeEvent.getRecipient()
The user that the mode operation applies to.
|
User |
SuperOpEvent.getRecipient()
The nick of the user that got 'voiced'.
|
User |
OwnerEvent.getRecipient()
The user that received the owner status.
|
User |
OpEvent.getRecipient()
The user that received the Operator status
|
User |
KickEvent.getRecipient()
The unfortunate recipient of the kick.
|
User |
HalfOpEvent.getRecipient()
The user that received the half-op
|
User |
VoiceEvent.getUser()
The user that performed the mode change.
|
User |
VersionEvent.getUser() |
User |
UserModeEvent.getUser()
The user that set the mode.
|
User |
TimeEvent.getUser()
The user that sent the TIME request.
|
User |
SuperOpEvent.getUser()
The user that performed the mode change.
|
User |
SetTopicProtectionEvent.getUser()
The user that performed the mode change.
|
User |
SetSecretEvent.getUser() |
User |
SetPrivateEvent.getUser() |
User |
SetNoExternalMessagesEvent.getUser() |
User |
SetModeratedEvent.getUser() |
User |
SetInviteOnlyEvent.getUser() |
User |
SetChannelLimitEvent.getUser() |
User |
SetChannelKeyEvent.getUser() |
User |
SetChannelBanEvent.getUser() |
User |
RemoveTopicProtectionEvent.getUser() |
User |
RemoveSecretEvent.getUser() |
User |
RemovePrivateEvent.getUser() |
User |
RemoveNoExternalMessagesEvent.getUser() |
User |
RemoveModeratedEvent.getUser() |
User |
RemoveInviteOnlyEvent.getUser() |
User |
RemoveChannelLimitEvent.getUser() |
User |
RemoveChannelKeyEvent.getUser() |
User |
RemoveChannelBanEvent.getUser()
The user that performed the mode change.
|
User |
PrivateMessageEvent.getUser()
The user who sent the private message.
|
User |
PingEvent.getUser()
The user that sent the PING request.
|
User |
OwnerEvent.getUser()
The user that performed the mode change.
|
User |
OpEvent.getUser()
The user that performed the mode change
|
User |
NoticeEvent.getUser()
The user that sent the notice.
|
User |
NickChangeEvent.getUser()
The user that changed their nick.
|
User |
ModeEvent.getUser()
The user that set the mode.
|
User |
MessageEvent.getUser()
The user who sent the message.
|
User |
KickEvent.getUser()
The user who performed the kick.
|
User |
JoinEvent.getUser()
The user who joined the channel.
|
User |
InviteEvent.getUser()
The user that sent the invite.
|
User |
IncomingFileTransferEvent.getUser() |
User |
IncomingChatRequestEvent.getUser() |
User |
HalfOpEvent.getUser()
The user that performed the mode change.
|
User |
FingerEvent.getUser()
The user that sent the FINGER request.
|
User |
ActionEvent.getUser()
The user that sent the action.
|
User |
UserModeEvent.getUserHostmask()
The user hostmask that set the mode.
|
Modifier and Type | Method and Description |
---|---|
com.google.common.collect.ImmutableSortedSet<User> |
UserListEvent.getUsers()
An immutable Set of Users belonging to this channel.
|
Constructor and Description |
---|
ActionEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
Channel channel,
String channelSource,
String action,
com.google.common.collect.ImmutableMap<String,String> tags) |
FingerEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
Channel channel) |
HalfOpEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
boolean isHalfOp) |
IncomingChatRequestEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
InetAddress address,
int port,
String token,
boolean passive) |
IncomingFileTransferEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
String rawFilename,
String safeFilename,
InetAddress address,
int port,
long filesize,
String token,
boolean passive) |
InviteEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
String channel) |
JoinEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
KickEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
String reason) |
MessageEvent(PircBotX bot,
Channel channel,
String channelSource,
UserHostmask userHostmask,
User user,
String message,
com.google.common.collect.ImmutableMap<String,String> tags) |
ModeEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
String mode,
com.google.common.collect.ImmutableList<String> modeParsed) |
NickChangeEvent(PircBotX bot,
String oldNick,
String newNick,
UserHostmask userHostmask,
User user) |
NoticeEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
Channel channel,
String channelSource,
String notice,
com.google.common.collect.ImmutableMap<String,String> tags) |
OpEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
boolean isOp) |
OwnerEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
boolean isOwner) |
PingEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
Channel channel,
String pingValue) |
PrivateMessageEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
String message,
com.google.common.collect.ImmutableMap<String,String> tags) |
RemoveChannelBanEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask hostmask) |
RemoveChannelKeyEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
String key) |
RemoveChannelLimitEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemoveInviteOnlyEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemoveModeratedEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemoveNoExternalMessagesEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemovePrivateEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemoveSecretEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
RemoveTopicProtectionEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetChannelBanEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask banHostmask) |
SetChannelKeyEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
String key) |
SetChannelLimitEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
int limit) |
SetInviteOnlyEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetModeratedEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetNoExternalMessagesEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetPrivateEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetSecretEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SetTopicProtectionEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
SuperOpEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
boolean isSuperOp) |
TimeEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user) |
UserModeEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
String mode) |
VersionEvent(PircBotX bot,
UserHostmask userHostmask,
User user,
Channel channel) |
VoiceEvent(PircBotX bot,
Channel channel,
UserHostmask userHostmask,
User user,
UserHostmask recipientHostmask,
User recipient,
boolean hasVoice) |
Constructor and Description |
---|
UserListEvent(PircBotX bot,
Channel channel,
com.google.common.collect.ImmutableSortedSet<User> users,
boolean complete) |
Modifier and Type | Method and Description |
---|---|
User |
GenericUserModeEvent.getRecipient()
The recipient user that this event applies to.
|
User |
GenericUserEvent.getUser()
The source user that generated the event.
|
Modifier and Type | Class and Description |
---|---|
class |
UserSnapshot
A snapshot of a user in time.
|
Modifier and Type | Method and Description |
---|---|
User |
UserSnapshot.getGeneratedFrom() |
Constructor and Description |
---|
UserSnapshot(User user) |
Copyright © 2010–2020 Leon Blakey. All rights reserved.