Package | Description |
---|---|
org.pircbotx |
Core PircBotX classes
|
Modifier and Type | Method and Description |
---|---|
Configuration.Builder |
Configuration.Builder.addAutoJoinChannel(String channel)
Add a channel to join on connect
|
Configuration.Builder |
Configuration.Builder.addAutoJoinChannel(String channel,
String key)
Utility method for
|
Configuration.Builder |
Configuration.Builder.addAutoJoinChannels(Iterable<String> channels) |
Configuration.Builder |
Configuration.Builder.addCapHandler(CapHandler handler)
Add a cap handler
|
Configuration.Builder |
Configuration.Builder.addCapHandlers(Iterable<CapHandler> handlers)
Add a collection of cap handlers
|
Configuration.Builder |
Configuration.Builder.addListener(Listener listener)
Add a listener to the current ListenerManager
|
Configuration.Builder |
Configuration.Builder.addListeners(Iterable<Listener> listeners)
Add a collection of listeners to the current ListenerManager
|
Configuration.Builder |
Configuration.Builder.addServer(Configuration.ServerEntry serverEntry) |
Configuration.Builder |
Configuration.Builder.addServer(String server) |
Configuration.Builder |
Configuration.Builder.addServer(String server,
int port) |
Configuration.Builder |
Configuration.Builder.addServers(Iterable<Configuration.ServerEntry> serverEnteries) |
static Configuration.Builder |
ReplayServer.generateConfig() |
Configuration.Builder |
Configuration.Builder.setAutoNickChange(boolean autoNickChange)
Enable or disable automatic nick changing if a nick is in use by
adding a number to the end, default false which will throw a
IrcException if the nick is already in use on the server |
Configuration.Builder |
Configuration.Builder.setAutoReconnect(boolean autoReconnect)
Enable or disable automatic reconnecting, default false.
|
Configuration.Builder |
Configuration.Builder.setAutoReconnectAttempts(int autoReconnectAttempts)
Number of times to attempt to reconnect, default 5.
|
Configuration.Builder |
Configuration.Builder.setAutoReconnectDelay(Delay autoReconnectDelay)
Delay in milliseconds between reconnect attempts, default 0.
|
Configuration.Builder |
Configuration.Builder.setAutoSplitMessage(boolean autoSplitMessage)
Enable or disable automatic message splitting to fit
getMaxLineLength() to prevent the IRC server from possibly
truncating or rejecting the line, default true. |
Configuration.Builder |
Configuration.Builder.setBotFactory(Configuration.BotFactory botFactory)
The
Configuration.BotFactory to use |
Configuration.Builder |
Configuration.Builder.setCapEnabled(boolean capEnabled)
Enable or disable CAP handling, defaults true.
|
Configuration.Builder |
Configuration.Builder.setChannelPrefixes(String channelPrefixes)
Allowed channel prefix characters, default
#&+! |
Configuration.Builder |
Configuration.Builder.setDccAcceptTimeout(int dccAcceptTimeout)
Timeout for user to accept a sent DCC request, defaults to
getSocketTimeout() |
Configuration.Builder |
Configuration.Builder.setDccFilenameQuotes(boolean dccFilenameQuotes)
If true sends filenames in quotes, otherwise uses underscores,
default enabled.
|
Configuration.Builder |
Configuration.Builder.setDccLocalAddress(InetAddress dccLocalAddress)
The local address to bind DCC connections to, defaults to null (which
will be figured out at runtime)
|
Configuration.Builder |
Configuration.Builder.setDccPassiveRequest(boolean dccPassiveRequest)
Send DCC requests as passive/reverse requests if not specified
otherwise, default false
|
Configuration.Builder |
Configuration.Builder.setDccPorts(List<Integer> dccPorts)
Ports to allow DCC incoming connections, recommended to set multiple
as DCC connections will be rejected if no free port can be found
|
Configuration.Builder |
Configuration.Builder.setDccPublicAddress(InetAddress dccPublicAddress)
The public address advertised to other users, defaults to null (which
will be figured out at runtime)
|
Configuration.Builder |
Configuration.Builder.setDccResumeAcceptTimeout(int dccResumeAcceptTimeout)
Timeout for a user to accept a resumed DCC request, defaults to
getDccResumeAcceptTimeout() |
Configuration.Builder |
Configuration.Builder.setDccTransferBufferSize(int dccTransferBufferSize)
Size of the DCC file transfer buffer, default 1024 bytes
|
Configuration.Builder |
Configuration.Builder.setEncoding(Charset encoding)
Charset encoding to use for connection, defaults to
Charset.defaultCharset() |
Configuration.Builder |
Configuration.Builder.setFinger(String finger)
CTCP finger response
|
Configuration.Builder |
Configuration.Builder.setIdentServerEnabled(boolean identServerEnabled)
Enable or disable use of an existing
IdentServer , default
false. |
Configuration.Builder |
Configuration.Builder.setListenerManager(ListenerManager listenerManager)
Sets a new ListenerManager.
|
Configuration.Builder |
Configuration.Builder.setLocalAddress(InetAddress localAddress)
Address to bind to when connecting to IRC server, default null
|
Configuration.Builder |
Configuration.Builder.setLocale(Locale locale)
Locale to use for connection, defaults to
Locale.getDefault() |
Configuration.Builder |
Configuration.Builder.setLogin(String login)
The login to be used for the IRC connection (nick!login@host),
default PircBotX
|
Configuration.Builder |
Configuration.Builder.setMaxLineLength(int maxLineLength)
Maximum line length of IRC server, defaults 512 characters
|
Configuration.Builder |
Configuration.Builder.setMessageDelay(Delay messageDelay)
Millisecond delay between sending messages, default 1000 milliseconds
|
Configuration.Builder |
Configuration.Builder.setName(String name)
The nick to be used for the IRC connection (nick!login@host), must
not be blank
|
Configuration.Builder |
Configuration.Builder.setNickservCustomMessage(String nickservCustomMessage)
Some irc servers require a custom identify string.
|
Configuration.Builder |
Configuration.Builder.setNickservDelayJoin(boolean nickservDelayJoin)
Delay joining channels until were identified to nickserv, default
false
|
Configuration.Builder |
Configuration.Builder.setNickservNick(String nickservNick)
The nick of the nickserv service account, default "nickserv".
|
Configuration.Builder |
Configuration.Builder.setNickservOnSuccess(String nickservOnSuccess)
Case-insensitive message a user with
setNickservNick(java.lang.String) in its hostmask will
always contain when we have successfully identified, defaults to "you
are now" which which matches all of the following known server
responses:
ircd-seven (freenode) - You are now identified for PircBotX
Unreal (swiftirc) - Password accepted - you are now
recognized.
InspIRCd (mozilla) - You are now logged in as PircBotX
|
Configuration.Builder |
Configuration.Builder.setNickservPassword(String nickservPassword)
Password to authenticate against NICKSERV, default null (will not try
to identify)
|
Configuration.Builder |
Configuration.Builder.setOnJoinWhoEnabled(boolean onJoinWhoEnabled)
Enable or disable sending "WHO #channel" upon joining a channel and
rely only on the NAMES response
|
Configuration.Builder |
Configuration.Builder.setRealName(String realName)
The realName/fullname used for WHOIS info, defaults to version
|
Configuration.Builder |
Configuration.Builder.setServer(String hostname)
Deprecated.
Use
addServer(java.lang.String) ,
will be removed in future releases |
Configuration.Builder |
Configuration.Builder.setServer(String hostname,
int port)
Deprecated.
Use
addServer(java.lang.String, int) ,
will be removed in future releases |
Configuration.Builder |
Configuration.Builder.setServerHostname(String hostname)
Deprecated.
Use
addServer(java.lang.String) ,
will be removed in future releases |
Configuration.Builder |
Configuration.Builder.setServerPassword(String serverPassword)
Password for IRC server, default null
|
Configuration.Builder |
Configuration.Builder.setServerPort(int port)
Deprecated.
Use
addServer(java.lang.String, int) ,
will be removed in future releases |
Configuration.Builder |
Configuration.Builder.setServers(List<Configuration.ServerEntry> servers)
List of servers to connect to, easily add with the addServer methods
|
Configuration.Builder |
Configuration.Builder.setShutdownHookEnabled(boolean shutdownHookEnabled)
Enable or disable creating a JVM shutdown hook which will properly
QUIT the IRC server and shutdown the bot, default true
|
Configuration.Builder |
Configuration.Builder.setSnapshotsEnabled(boolean snapshotsEnabled)
Enable creation of snapshots, default true.
|
Configuration.Builder |
Configuration.Builder.setSocketConnectTimeout(int socketConnectTimeout)
Milliseconds to wait to connect to an IRC server address before
trying the next address, default
getSocketTimeout() |
Configuration.Builder |
Configuration.Builder.setSocketFactory(SocketFactory socketFactory)
Socket factory for connections, defaults to
SocketFactory.getDefault() |
Configuration.Builder |
Configuration.Builder.setSocketTimeout(int socketTimeout)
Milliseconds to wait with no data from the IRC server before sending
a PING request to check if the socket is still alive, default 5
minutes (1000x60x5=300,000 milliseconds)
|
Configuration.Builder |
Configuration.Builder.setUserLevelPrefixes(String userLevelPrefixes)
Supported channel prefixes that restrict a sent message to users with
this mode, eg
PRIVMSG +#channel :hello will only send a
message to voiced or higher users, default +@%&~! |
Configuration.Builder |
Configuration.Builder.setUserModeHideRealHost(boolean userModeHideRealHost)
Sets mode +x on the bot, to hide the real hostname, default = false
|
Configuration.Builder |
Configuration.Builder.setVersion(String version)
CTCP version response.
|
Configuration.Builder |
Configuration.Builder.setWebIrcAddress(InetAddress webIrcAddress)
IP address of WEBIRC connection, must be set if WEBIRC is enabled
|
Configuration.Builder |
Configuration.Builder.setWebIrcEnabled(boolean webIrcEnabled)
Enable or disable sending WEBIRC line on connect, default disabled
|
Configuration.Builder |
Configuration.Builder.setWebIrcHostname(String webIrcHostname)
Hostname of WEBIRC connection, must not be blank if WEBIRC is enabled
|
Configuration.Builder |
Configuration.Builder.setWebIrcPassword(String webIrcPassword)
Password of WEBIRC connection, must not be blank if WEBIRC is enabled
|
Configuration.Builder |
Configuration.Builder.setWebIrcUsername(String webIrcUsername)
Username of WEBIRC connection, must not be blank if WEBIRC is enabled
|
Modifier and Type | Method and Description |
---|---|
static void |
ReplayServer.replay(Configuration.Builder config,
InputStream input,
String title) |
static void |
ReplayServer.replayFile(File file,
Configuration.Builder config) |
Constructor and Description |
---|
Builder(Configuration.Builder otherBuilder)
Copy values from another builder.
|
Copyright © 2010–2020 Leon Blakey. All rights reserved.