All Classes and Interfaces
Class
Description
An abstract processor of TMI messages
Allows a custom
DataType to attach a reference to a UpdatableRecordAllows
RecordListener.loadEnd(org.jooq.RecordContext) to detect an UpdatableRecord which needs to call
AttachableDataType.attach(org.jooq.UpdatableRecord, int) on some of it's valuesCommon message data for
AutomodMessageHold and AutomodMessageUpdate.Automod terms data in an EventSub payload.
Ban data in an EventSub payload.
Gets the authentication process started by requesting capabilities and sending NICK/PASS
Provides an implementation of
Properties where the key is case-insensitive and thread-safeA specified channel receives a follow.
A moderator command has been executed.
A viewer has redeemed a custom channel points reward on the specified channel
The status of the redemption
Basic information about the reward that was redeemed, at the time it was redeemed.
A broadcaster updates their channel properties e.g., category, title, mature flag, broadcast, or language.
Handles the CLEARCHAT TMI Command
Handles the CLEARMSG TMI Command
An
AddressResolverGroup that uses a CompositeInetNameResolver to service DNS queriesA composite
AddressResolver that resolves a host name against a sequence of AddressResolversA bot module which is a core module
Provides access to the database in a key-value store style
Manages a JDBC-compatible, SQL-based, data storage method
Deprecated, for removal: This API element is subject to removal in a future version.
No replacement planned
Message delete data in an EventSub payload.
Helper to handle digesting a string
Communicates with the Discord API.
Enum list of our connection states.
The type of reaction, either a "add" or "remove".
Has all of the methods to work with Discord4J.
Converts duration strings into a
DurationThis is a helper class to parse emojis.
Represents an emote in its most basic form
Contains emotes for the different categories local, shared and global from an
emote provider.
This Event is emitted from the emotesHandler after it updated the emotes cache.
Base class for all events that are sent via
EventBusSends events to downstream subscribers
Detects if an operating system specific
EventLoopGroup is availableManages EventSub subscriptions
An EventSub event related to automod
An EventSub event related to a message held by automod
A message is held by automod.
A message held by automod has updated its status.
An EventSub event related to a channel
A specified channel receives a follow.
A specified channel receives a follow.
A viewer has redeemed a custom channel points reward on the specified channel
EventSub notifications related to channel points
EventSub notifications related to channel points redemptions
A broadcaster updates their channel properties e.g., category, title, mature flag, broadcast, or language.
EventSub WebSocket is disconnected
An EventSub event
Internal event allowing event implementation classes to subscribe to incoming EventSub notifications
Internal event subclass denoting an EventSub event notification
Internal event subclass denoting an EventSub revocation notification
Internal event subclass denoting an EventSub webhook callback verification notification
A Prediction started on a specified channel.
A Prediction ended on a specified channel.
EventSub notifications related to predictions
A Prediction was locked on a specified channel.
Users participated in a Prediction on a specified channel.
The Revocation event signals that a subscription has been revoked.
An event related to a stream
A broadcaster has stopped a stream
A broadcaster has started a stream
EventSub Subscription Data
The status of an EventSub subscription
Abstract base class for EventSub Subscription Types
A test event for development
EventSub Transport Data
EventSub WebSocket is connected and ready to propose subscriptions
Error handler for
EventBusProvides an interface to a shared
ScheduledExecutorServiceHandles backoff timing using an exponentially increasing duration strategy.
Follower mode data in an EventSub payload.
Periodically checks the API for new followers
Deprecated, for removal: This API element is subject to removal in a future version.
To be replaced
Handles the GLOBALUSERSTATE TMI Command
Deprecated, for removal: This API element is subject to removal in a future version.
Use
MySQLStore2 insteadProvides a
Datastore2 driver for H2 database v2.xStart of the Helix API.
Colors to be used with
Helix.sendChatAnnouncement(java.lang.String,java.lang.String,java.lang.String)The status of a custom reward redemption
The status to set the prediction to for
Helix.endPredictionAsync(String, PredictionStatus, String))Provides an easy interface to calculating an HMAC-SHA256
Represents an Authentication Handler for an
HttpHandlerProvides a
HttpAuthenticationHandler that implements HTTP Basic authentication, as well as allowing the same format to be provided in a
cookiePerforms HTTP requests
The request parameters and response data from a
HttpClient requestProvides a
HttpAuthenticationHandler that allows all requestsDetects Non-SSL HTTP connections and activates the SSL Redirect handler, when SSL is enabled
Deprecated, for removal: This API element is subject to removal in a future version.
Please use
HttpClient insteadRepresents a handler for HTTP requests
Deprecated, for removal: This API element is subject to removal in a future version.
Please use
HttpClient insteadProcesses HTTP requests and passes successful ones to the appropriate registered final handler
Provides a
HttpAuthenticationHandler that implements password and token-based authentication
The token must be in one of the following locations to succeed: - The header webauth - The query parameter webauth
The password must be in the header password to succeedRedirects HTTP requests to HTTPS, when SSL is enabled
Provides a HTTP 1.1 server with WebSocket support
The list of users present in TMI is updated
Possible actions
Handles the JOIN IRC command
Provides access to File I/O from JS
A Java event has occurred
A key/value pair in the database
Interface which marks a class as a receiver of events posted by
EventBusFilters log data
Provides a
Datastore2 driver for MariaDB v11.xA cheermote in a
MessageFragment.Chat Message data in an EventSub payload.
An emote in a
MessageFragment.A message fragment in
MessageData.A mention in a
MessageFragment.A lightweight standalone JDBC connection pool manager.
Thrown in
MiniConnectionPoolManager.getConnection() or MiniConnectionPoolManager.getValidConnection() when no free connection becomes available within timeout
seconds.A bot module written in Java
A record in
ModuleVersionTable denoting the version of a Module for version trackingStores the current version of
Modules for upgrade trackingDeprecated, for removal: This API element is subject to removal in a future version.
Use
MySQLStore2 insteadProvides a
Datastore2 driver for MySQL database v8.xHandles the NOTICE TMI Command
An extension of
JSONException to explicitly indicate that HttpClientResponse identified the response
body as not JSON, due to the first character not being a {Handles the 001 numeric message and starts the process of joining the channel
Handles the numeric 353 IRC command
Represents a panel user and should be managed through
PanelUserHandlerUser types
Panel user management for the web panel and websocketMessages for use as responses to the web panel
Panel user web panel and websocket permissionStores panel login information
Handles the PART IRC command
Provides pattern matchers to JS, where Java RegEx is required
An interface representing a single class that implements both a PING supplier and a PONG predicate.
Handles the IRC PING command
A Prediction started on a specified channel.
A Prediction ended on a specified channel.
The status of the Channel Points Prediction.
A Prediction was locked on a specified channel.
Describes a potential outcome for a Prediction.
The color for the outcome.
Users participated in a Prediction on a specified channel.
Handles the PRIVMSG IRC command and tracks moderators via IRCv3 item.tags()
The properties in
CaselessProperties have been loaded and are now availableThe properties in
CaselessProperties have been reloaded and amy contain new valuesRaid data in an EventSub payload.
Handles the TMI RECONNECT command
Abstract class which simplifies setup and usage of
Record1 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record2 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record3 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record4 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record5 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record6 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record7 on an UpdateableRecordImplAbstract class which simplifies setup and usage of
Record8 on an UpdateableRecordImplProvides methods which perform common reflection operations
Provides the version of the bot
DO NOT EDIT.
Provides a method to log a request stream
Restarts the bot, if configured appropriately
Handles notification that a webhook has been revoked.
Supplier and Predicate for RFC6455 PING/PONG frames
Provides Rollbar exception reporting
Handles the ROOMSTATE TMI Command
A record in
SectionVariableValueTableStores data in the
DataStore formatGenerates a SelfSigned X.509 Certificate
Taken from https://stackoverflow.com/questions/1615871/creating-an-x509-certificate-in-java-without-bouncycastle Original code and modifications
by: Mike B, vbence, and Clark Hobbie
The bot has started the shutdown sequence and will exit in approximately 5 seconds
Slow mode data in an EventSub payload.
Deprecated, for removal: This API element is subject to removal in a future version.
Use
MySQLStore2 insteadProvides a
Datastore2 driver for SQLite database v3.xThe specified broadcaster stops a stream.
The specified broadcaster starts a stream.
Stream types
An exception which indicates that the specified table does not exist; or that the table cache may be stale
Stores the DDL version of managed Datastore2 tables
A record in
TableVersion denoting the DDL version of a managed Datastore2 tableTest type for development.
Provides testing data
Timeout data in an EventSub payload.
An IRCv3 formatted message from TMI
The type of message
Supplier and Predicate for TMI PING/PONG commands
Captures and redirects slash commands to Helix
Describes a user who participated in a Channel Points Prediction.
Deprecated, for removal: This API element is subject to removal in a future version.
Please use
Helix instead.An update to the Twitch broadcaster type of the caster
TwitchCache Class
This class keeps track of certain Twitch information such as if the channel is online or not and sends events to the JS side to indicate when the
channel has gone off or online.
A client for the Twitch Message Interface
One of the Twitch OAuth tokens has been re-authorized from the
/oauth page on the bots webserverA user that is tracked by
ViewerCache has changed their login nameHandle Validate requests of the OAUTH2 token from Twitch.
Unban request data in an EventSub payload.
Catches exceptions which have not been caught elsewhere
User data in an EventSub payload.
Deprecated, for removal: This API element is subject to removal in a future version.
Please use
ViewerCache instead.Handles the USERNOTICE TMI Command
Handles the USERSTATE TMI command
Contains information about a specific viewer in a
ViewerCacheMaintains a list of viewers, Twitch viewer permissions, and username lookups
Deprecated, for removal: This API element is subject to removal in a future version.
Please use
ViewerCache instead.Processes WebSocket frames and passes successful ones to the appropriate registered final handler
Handles the WHISPER TMI Command
Handles rate limiting using a window which resets a period of time after the first token is used
Handles rate limiting using a window which resets a period of time after the first token is used, and where the limit can switch between two values
Represents an Authentication Handler for a
WsHandlerProvides a WebSocket client
Enables support for permessage-deflate; server_no_context_takeover; client_no_context_takeover
Represents a handler for WebSocket client frames
Represents a handler for WebSocket frames
Provides a
WsAuthenticationHandler that allows all requestsPings the remote endpoint periodically; closes the socket if a PONG is not received after a defined number of PING attempts
Provides a
WsAuthenticationHandler that implements A Write/ReadOnly token-based authentication where all clients share the same tokensProcesses WebSocket frames and passes successful ones to the appropriate registered final handler
Communicates with YouTube via the version 3 API