Index

A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

AbstractChannelEvent - Class in com.github.twitch4j.chat.events
This event is a base for events that originate from a channel
AbstractChannelEvent() - Constructor for class com.github.twitch4j.chat.events.AbstractChannelEvent
 
AbstractChannelEvent(EventChannel) - Constructor for class com.github.twitch4j.chat.events.AbstractChannelEvent
Event Constructor
AbstractChannelMessageEvent - Class in com.github.twitch4j.chat.events
 
AbstractChannelMessageEvent(EventChannel, IRCMessageEvent, EventUser, String, Set<CommandPermission>) - Constructor for class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
AGGRESSIVE - Enum constant in enum class com.github.twitch4j.chat.flag.FlagType
Aggressive language - Hostility towards other people, often associated with bullying.
ALREADY_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is already banned in this channel.
ALREADY_EMOTE_ONLY_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is not in emote-only mode.
ALREADY_EMOTE_ONLY_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is already in emote-only mode.
ALREADY_R9K_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is not in r9k mode.
ALREADY_R9K_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is already in r9k mode.
ALREADY_SUBS_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is not in subscribers-only mode.
ALREADY_SUBS_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is already in subscribers-only mode.
AnnouncementColor - Enum Class in com.github.twitch4j.chat.enums
 
AUTH_BANDWIDTH_ID - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
 
authRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for AUTH
authRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Custom RateLimit for AUTH
authRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
autoJoinOwnChannel - Variable in class com.github.twitch4j.chat.TwitchChat
Whether one's own channel should automatically be joined
automaticallyPartOnBan - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Deprecated.
use removeChannelOnJoinFailure via advancedConfiguration instead.
automaticallyPartOnBan(boolean) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
Deprecated.
AutoModFlag - Class in com.github.twitch4j.chat.flag
Represents a region of a chat message that was flagged by AutoMod.
AutoModFlag.AutoModFlagBuilder - Class in com.github.twitch4j.chat.flag
 

B

BAD_BAN_ADMIN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban admin <user>.
BAD_BAN_ANON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban anonymous users.
BAD_BAN_BROADCASTER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban the broadcaster.
BAD_BAN_GLOBAL_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Deprecated.
BAD_BAN_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban moderator <user> unless you are the owner of this channel.
BAD_BAN_SELF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban yourself.
BAD_BAN_STAFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot ban a staff <user>.
BAD_COMMERCIAL_ERROR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Failed to start commercial.
BAD_DELETE_MESSAGE_BROADCASTER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot delete the broadcaster's messages.
BAD_DELETE_MESSAGE_ERROR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Failed to delete message.
BAD_DELETE_MESSAGE_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot delete messages from another moderator <user>.
BAD_HOST_ERROR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
There was a problem hosting <channel>.
BAD_HOST_HOSTING - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel is already hosting <channel>.
BAD_HOST_RATE_EXCEEDED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Host target cannot be changed more than <number> times every half hour.
BAD_HOST_REJECTED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel is unable to be hosted.
BAD_HOST_SELF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
A channel cannot host itself.
BAD_MARKER_CLIENT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Sorry, /marker is not available through this client.
BAD_MOD_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is banned in this channel.
BAD_MOD_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is already a moderator of this channel.
BAD_SLOW_DURATION - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot set slow delay to more than <number> seconds.
BAD_TIMEOUT_ADMIN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout admin <user>.
BAD_TIMEOUT_ANON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout anonymous users.
BAD_TIMEOUT_BROADCASTER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout the broadcaster.
BAD_TIMEOUT_DURATION - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot time a user out for more than <seconds>.
BAD_TIMEOUT_GLOBAL_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Deprecated.
BAD_TIMEOUT_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout moderator <user> unless you are the owner of this channel.
BAD_TIMEOUT_SELF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout yourself.
BAD_TIMEOUT_STAFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot timeout staff <user>.
BAD_UNBAN_NO_BAN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is not banned from this channel.
BAD_UNHOST_ERROR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
There was a problem exiting host mode.
BAD_UNMOD_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is not a moderator of this channel.
BAD_UNVIP_GRANTEE_NOT_VIP - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is not a VIP of this channel.
BAD_VIP_ACHIEVEMENT_INCOMPLETE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Unable to add VIP.
BAD_VIP_GRANTEE_ALREADY_VIP - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is already a VIP of this channel.
BAD_VIP_GRANTEE_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is banned in this channel.
BAD_VIP_MAX_VIPS_REACHED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Unable to add VIP.
ban(String, String) - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
Deprecated.
Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#banUser
ban(String, String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#banUser
BAN_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is now banned from this channel.
BitsBadgeEarnedEvent - Class in com.github.twitch4j.chat.events.channel
Called when a user earns a new bits badge tier.
BitsBadgeEarnedEvent(EventChannel, EventUser, int) - Constructor for class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
Event Constructor
BLUE - Enum constant in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 
botOwnerIds - Variable in class com.github.twitch4j.chat.TwitchChat
Bot Owner IDs
botOwnerIds - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
User IDs of Bot Owners for applying CommandPermission.OWNER
BROADCAST_LANG - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
Deprecated.
BroadcasterLanguageEvent - Class in com.github.twitch4j.chat.events.roomstate
Deprecated.
BroadcasterLanguageEvent(EventChannel, Locale) - Constructor for class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
Constructor
bucketByChannelName - Variable in class com.github.twitch4j.chat.TwitchChat
Cache of per-channel message buckets
build() - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
 
build() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Twitch API Client (Helix)
build() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
builder() - Static method in class com.github.twitch4j.chat.flag.AutoModFlag
 
builder() - Static method in class com.github.twitch4j.chat.TwitchChatBuilder
Initialize the builder
builder() - Static method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 

C

canEqual(Object) - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ClearChatEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.FollowEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.HostOffEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteError
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteSuccess
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.RaidCancellationEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.CommandEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.EmoteOnlyEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.Robot9000Event
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.roomstate.SubscribersOnlyEvent
 
canEqual(Object) - Method in class com.github.twitch4j.chat.events.TwitchEvent
 
CHANNEL - Enum constant in enum class com.github.twitch4j.chat.enums.CommandSource
 
CHANNEL_SUSPENDED - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason
The channel was suspended, so further chat messages cannot be received.
channelIdToChannelName - Variable in class com.github.twitch4j.chat.TwitchChat
Cache: ChannelId to ChannelName
ChannelJoinEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user joins a channel.
ChannelJoinEvent(EventChannel, EventUser) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
Event Constructor
ChannelJoinFailureEvent - Class in com.github.twitch4j.chat.events.channel
A chat instance failed to join (or stay joined to) a channel AND removeChannelOnJoinFailure was enabled, resulting in removal from the instance's current channels.
ChannelJoinFailureEvent(String, ChannelJoinFailureEvent.Reason) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
 
ChannelJoinFailureEvent.Reason - Enum Class in com.github.twitch4j.chat.events.channel
 
ChannelLeaveEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user leaves the channel.
ChannelLeaveEvent(EventChannel, EventUser) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
Event Constructor
ChannelMessageActionEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when an action message (/me text) is received in a channel.
ChannelMessageActionEvent(EventChannel, IRCMessageEvent, EventUser, String, Set<CommandPermission>) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelMessageActionEvent
Event Constructor
ChannelMessageEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a message is received in a channel.
ChannelMessageEvent(EventChannel, IRCMessageEvent, EventUser, String, Set<CommandPermission>) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
Event Constructor
ChannelModEvent - Class in com.github.twitch4j.chat.events.channel
ChannelModEvent(EventChannel, EventUser, boolean) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
Event Constructor
channelNameToChannelId - Variable in class com.github.twitch4j.chat.TwitchChat
Cache: ChannelName to ChannelId
ChannelNoticeEvent - Class in com.github.twitch4j.chat.events.channel
ChatChannel Notice Event
ChannelNoticeEvent(EventChannel, String, String) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
Channel Notice Event
ChannelStateEvent - Class in com.github.twitch4j.chat.events.channel
 
ChannelStateEvent(EventChannel, ChannelStateEvent.ChannelState, Object) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelStateEvent
Event Constructor
ChannelStateEvent(EventChannel, Map<ChannelStateEvent.ChannelState, Object>) - Constructor for class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
ChannelStateEvent.ChannelState - Enum Class in com.github.twitch4j.chat.events.channel
 
ChannelStatesEvent - Class in com.github.twitch4j.chat.events.roomstate
Abstract Channel State Event
ChannelStatesEvent(EventChannel, boolean) - Constructor for class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
CHANT_MSG_ID_TAG_NAME - Static variable in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
 
CharityDonationEvent - Class in com.github.twitch4j.chat.events.channel
 
CharityDonationEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
chatAccount - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Provides a chat account to be used when constructing a new TwitchChat instance.
chatAccount(Supplier<OAuth2Credential>) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
ChatConnectionStateEvent - Class in com.github.twitch4j.chat.events
Chat Connection Event
ChatConnectionStateEvent(WebsocketConnectionState, WebsocketConnectionState, TwitchChat) - Constructor for class com.github.twitch4j.chat.events.ChatConnectionStateEvent
 
ChatCrowdChant - Class in com.github.twitch4j.chat.util
ChatCrowdChant(String, String, boolean, String) - Constructor for class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
 
chatJoinTimeout - Variable in class com.github.twitch4j.chat.TwitchChat
Minimum milliseconds to wait after a join attempt
chatQueueSize - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Size of the ChatQueue
chatQueueTimeout - Variable in class com.github.twitch4j.chat.TwitchChat
Time to wait for an item on the chat queue before continuing to next iteration If set too high your thread will be late check to shutdown
chatRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for ChatMessages
chatRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Custom RateLimit for ChatMessages
chatRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
CheerEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user receives bits.
CheerEvent() - Constructor for class com.github.twitch4j.chat.events.channel.CheerEvent
 
CheerEvent(IRCMessageEvent, EventChannel, EventUser, String, Integer, int, int, List<AutoModFlag>) - Constructor for class com.github.twitch4j.chat.events.channel.CheerEvent
Event Constructor
clearChat(String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#deleteChatMessages
ClearChatEvent - Class in com.github.twitch4j.chat.events.channel
 
ClearChatEvent(EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.ClearChatEvent
Event Constructor
clearScores() - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
 
close() - Method in interface com.github.twitch4j.chat.ITwitchChat
 
close() - Method in class com.github.twitch4j.chat.TwitchChat
Close
CMDS_AVAILABLE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Commands available to you in this room (use /help <command> for details): <list of commands>
COLOR_CHANGED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your color has been changed.
com.github.twitch4j.chat - package com.github.twitch4j.chat
 
com.github.twitch4j.chat.enums - package com.github.twitch4j.chat.enums
 
com.github.twitch4j.chat.events - package com.github.twitch4j.chat.events
 
com.github.twitch4j.chat.events.channel - package com.github.twitch4j.chat.events.channel
 
com.github.twitch4j.chat.events.roomstate - package com.github.twitch4j.chat.events.roomstate
 
com.github.twitch4j.chat.flag - package com.github.twitch4j.chat.flag
 
com.github.twitch4j.chat.util - package com.github.twitch4j.chat.util
 
CommandEvent - Class in com.github.twitch4j.chat.events
This event gets called when a message is received in a channel.
CommandEvent(CommandSource, String, EventUser, String, String, Set<CommandPermission>) - Constructor for class com.github.twitch4j.chat.events.CommandEvent
Event Constructor
commandPrefixes - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Command Handlers
commandPrefixes - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
IRC Command Handlers
CommandSource - Enum Class in com.github.twitch4j.chat.enums
 
COMMERCIAL_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Initiating <number> second commercial break.
connect() - Method in class com.github.twitch4j.chat.TwitchChat
Connecting to IRC-WS
CONNECTED - Enum constant in enum class com.github.twitch4j.chat.enums.TMIConnectionState
 
CONNECTING - Enum constant in enum class com.github.twitch4j.chat.enums.TMIConnectionState
 
connectionBackoffStrategy(IBackoffStrategy) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
consumeLines(String, Consumer<String>) - Static method in class com.github.twitch4j.chat.util.MessageParser
 
createBucket(Bandwidth) - Static method in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Deprecated.
in favor of BucketUtils
createBucket(Bandwidth...) - Static method in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Deprecated.
in favor of BucketUtils
createBucket(Iterable<Bandwidth>) - Static method in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Deprecated.
in favor of BucketUtils
createConnection() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
currentChannels - Variable in class com.github.twitch4j.chat.TwitchChat
Current Channels

D

delete(String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#deleteChatMessages
DELETE_MESSAGE_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The message from <user> is now deleted.
DeleteMessageEvent - Class in com.github.twitch4j.chat.events.channel
Fired when a single message was deleted over IRC by a moderator via /delete <target-msg-id>
DeleteMessageEvent(EventChannel, String, String, String, boolean) - Constructor for class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
 
DirectCheerEvent - Class in com.github.twitch4j.chat.events.channel
DirectCheerEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
This experiment is no longer running.
disconnect() - Method in class com.github.twitch4j.chat.TwitchChat
Disconnecting from IRC-WS
DISCONNECTED - Enum constant in enum class com.github.twitch4j.chat.enums.TMIConnectionState
 
DISCONNECTING - Enum constant in enum class com.github.twitch4j.chat.enums.TMIConnectionState
 
disposeConnection(TwitchChat) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
DonationEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user receives a donation from any source.
DonationEvent(EventChannel, EventUser, String, Currency, Double, String) - Constructor for class com.github.twitch4j.chat.events.channel.DonationEvent
Event Constructor

E

EMOTE - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
 
EMOTE_ONLY_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is no longer in emote-only mode.
EMOTE_ONLY_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in emote-only mode.
EmoteOnlyEvent - Class in com.github.twitch4j.chat.events.roomstate
Emote Only State Event
EmoteOnlyEvent(EventChannel, boolean) - Constructor for class com.github.twitch4j.chat.events.roomstate.EmoteOnlyEvent
Constructor
enableMembershipEvents - Variable in class com.github.twitch4j.chat.TwitchChat
Whether JOIN/PART events should be enabled
endIndex(int) - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
The index where the flagged item ends.
equals(Object) - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ClearChatEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.FollowEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.HostOffEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteError
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteSuccess
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.RaidCancellationEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.CommandEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.EmoteOnlyEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.Robot9000Event
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.roomstate.SubscribersOnlyEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.events.TwitchEvent
 
equals(Object) - Method in class com.github.twitch4j.chat.flag.AutoModFlag
 
equals(Object) - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
 
ExtendSubscriptionEvent - Class in com.github.twitch4j.chat.events.channel
Called when a user extends their existing subscription into a future month.
ExtendSubscriptionEvent(EventChannel, EventUser, SubscriptionPlan, int, Month) - Constructor for class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
Event Constructor

F

FDGT_TEST_SOCKET_SERVER - Static variable in class com.github.twitch4j.chat.TwitchChat
ThirdParty WebSocket Server for Testing
FlagParser - Class in com.github.twitch4j.chat.flag
 
FlagType - Enum Class in com.github.twitch4j.chat.flag
The AutoMod moderation categories.
FOLLOWERS - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
 
FOLLOWERS_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is no longer in followers-only mode.
FOLLOWERS_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in <duration> followers-only mode.
FOLLOWERS_ONZERO - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in followers-only mode.
FollowersOnlyEvent - Class in com.github.twitch4j.chat.events.roomstate
Followers Only State Event
FollowersOnlyEvent(EventChannel, long) - Constructor for class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
FollowersOnlyEvent(EventChannel, long, TimeUnit) - Constructor for class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
FollowEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a channel gets a new follower.
FollowEvent(EventChannel, EventUser) - Constructor for class com.github.twitch4j.chat.events.channel.FollowEvent
Event Constructor
fromString(String) - Static method in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 

G

getAmount() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getAmount() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
getAmount() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
Donation Amount
getAnnouncer() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
The user that made the announcement.
getAuthRateLimit() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for AUTH
getBadgeInfo() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getBadges() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getBadges() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getBaseUrl() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
A custom websocket url for TwitchChat to connect to.
getBenefitEndMonth() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
The new month that the subscription will end on.
getBits() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
Amount of Bits
getBits() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
direct cheer values are not easily translatable into bit amounts, especially for non-USD currencies.
getBitsThreshold() - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
The tier of the bits badge the user just earned; e.g.
getBotOwnerIds() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
User IDs of Bot Owners for applying CommandPermission.OWNER
getChannel() - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
Event Channel
getChannel() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Get ChatChannel
getChannel() - Method in interface com.github.twitch4j.chat.events.channel.ReplyableEvent
 
getChannelId() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Channel Id
getChannelIdToChannelName() - Method in interface com.github.twitch4j.chat.ITwitchChat
 
getChannelIdToChannelName() - Method in class com.github.twitch4j.chat.TwitchChat
 
getChannelIdToChannelName() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Note: this map does not dynamically update unlike TwitchChat.getChannelIdToChannelName()
getChannelName() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
The name of the channel that the chat instance was unable to join.
getChannelName() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getChannelNameToChannelId() - Method in interface com.github.twitch4j.chat.ITwitchChat
 
getChannelNameToChannelId() - Method in class com.github.twitch4j.chat.TwitchChat
 
getChannelNameToChannelId() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Note: this map does not dynamically update unlike TwitchChat.getChannelNameToChannelId()
getChannels() - Method in interface com.github.twitch4j.chat.ITwitchChat
Returns a set of all currently joined channels (without # prefix)
getChannels() - Method in class com.github.twitch4j.chat.TwitchChat
 
getChannels() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
getChantInfo() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
getCharityName() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getChatAccount() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
IRC User Id
getChatJoinTimeout() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
The amount of milliseconds to wait after queuing a JOIN before classifying the attempt as a failure.
getChatQueueSize() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Size of the ChatQueue
getChatQueueTimeout() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Millisecond wait time for taking items off chat queue.
getChatRateLimit() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for ChatMessages
getCheer() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
The parsed direct cheer payment information.
getCheererTier() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getClientId() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Client Id
getClientName() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getClientPermissions() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getClientSecret() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Client Secret
getColor() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
getColor() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
The color accent for the announcement.
getColor() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
getCommand() - Method in class com.github.twitch4j.chat.events.CommandEvent
Command
getCommandPrefix() - Method in class com.github.twitch4j.chat.events.CommandEvent
Command Prefix
getCommandPrefixes() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
IRC Command Handlers
getCommandType() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Message Type
getConnection() - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
The chat instance whose connection status changed.
getConnectionBackoffStrategy() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebSocket Connection Backoff Strategy
getConnectionState() - Method in class com.github.twitch4j.chat.TwitchChat
Deprecated.
getCount() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
X subscriptions gifted
getCredentialManager() - Method in class com.github.twitch4j.chat.TwitchChat
CredentialManager
getCredentialManager() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Credential Manager
getCumulativeMonths() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
The total number of months the user has subscribed.
getCumulativeMonths() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The cumulative number of months the user has been subscribed to this channel.
getCurrency() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
getCurrency() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
Donation Currency
getCurrentChannels() - Method in class com.github.twitch4j.chat.TwitchChat
Deprecated.
use getChannels() instead
getCustomRewardId() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
getDefaultEventHandler() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
EventManager
getDisplayName() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
getDisplayName() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
getDomain() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The domain of the rewards being gifted (e.g.
getDuration() - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
Duration in Minutes
getElevatedChatPayment() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
Hype Chat Contribution
getEmoteSets() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
getEmoteSets() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
List of emote sets.
getEndIndex() - Method in class com.github.twitch4j.chat.flag.AutoModFlag
The index where the flagged item ends.
getEscapedTags() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Tags
getEventManager() - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Event Manager
getEventManager() - Method in interface com.github.twitch4j.chat.ITwitchChat
 
getEventManager() - Method in class com.github.twitch4j.chat.TwitchChat
EventManager
getEventManager() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Event Manager
getFlags() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
getFlags() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
Regions of CheerEvent.getMessage() that were flagged by AutoMod (Unofficial)
getFlags() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
AutoMod Message Flag Indicators, relevant for PRIVMSG and USERNOTICE
getFlags() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
The regions of SubscriptionEvent.getMessage() that were flagged by AutoMod (Unofficial)
getGifted() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Was this sub gifted?
getGiftedBy() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
User that gifted the sub
getGifter() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The user that originally gifted the multi-month gift subscription.
getGifter() - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
The user giving the gift.
getGifterLogin() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
The login of the user who gifted the subscription, if applicable.
getGifterName() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
The display name of the user who gifted the subscription, if applicable.
getGiftMonths() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The number of months that were originally gifted as part of the multi-month subscription.
getGiftMonths() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
The number of months gifted as part of a single, multi-month gift
getGiftName() - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
The name of the gift package.
getHosterName() - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
Display name of the user that just hosted your channel.
getHostTarget() - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
Login name of the channel that was hosted (i.e., the user passed in chatAccount).
getHypeChatLevel() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
getIrcAuthBucket() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for auths
getIrcJoinBucket() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for joins
getIrcMessageBucket() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for messages
getIrcWhisperBucket() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
getJoinRateLimit() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for JOIN/PART
getLanguage() - Method in class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
Language
getLatency() - Method in interface com.github.twitch4j.chat.ITwitchChat
 
getLatency() - Method in class com.github.twitch4j.chat.TwitchChat
 
getLatency() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
getMaxJoinRetries() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
The maximum number of retries to make for joining each channel, with exponential backoff.
getMessage() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
Message
getMessage() - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
Message Content
getMessage() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
Message
getMessage() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
The message that was deleted.
getMessage() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
Donation Message
getMessage() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The user-specified message attached to this notification.
getMessage() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getMessage() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
The message being announced.
getMessage() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Subscription Message
getMessageEvent() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
RAW Message Event
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
Raw IRC Message Event
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
Raw message event.
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
Raw Message Event
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
The raw message event.
getMessageEvent() - Method in interface com.github.twitch4j.chat.events.channel.ReplyableEvent
 
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Raw IRC Message Event
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
RAW Message Event
getMessageEvent() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getMessageId() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
The message UUID that is used for deletion by a moderator or a chat reply (from Tags)
getMessageId() - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
The id for the parent message in the Crowd Chant.
getMilestoneCategory() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getMilestoneUniqueId() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getMilestoneValue() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getModerators() - Method in class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
The login names of the moderators of this channel.
getMonetaryValue() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
getMonths() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Cumulative months subscribed
getMsgId() - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
Message Id
getMsgId() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
UUID of the message that was deleted.
getMultiMonthDuration() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
The number of subscription months just purchased.
getMultiMonthTenure() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
The length of multi-month subscription tenure that has already been served.
getNonce() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
Nonce
getNonce() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getPayload() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getPerChannelRateLimit() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for Messages per Channel
getPermissions() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
Permissions of the user
getPermissions() - Method in class com.github.twitch4j.chat.events.CommandEvent
Permissions of the user
getPredictedChoiceIndex() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getPredictedChoiceTitle() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getPreviousState() - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
The previous state of the websocket.
getPriorGifter() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
The previous user that gifted to this one, if not anonymous.
getPromoGiftTotal() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
The number of gifts the gifter has given during the promo indicated by GiftSubUpgradeEvent.getPromoName().
getPromoName() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
The subscriptions promo, if any, that is ongoing; e.g.
getProxyConfig() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Proxy Configuration
getRaider() - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
Event User who initiated the raid
getRawMessage() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
RAW Message
getRawTag(String) - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getRawTags() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Deprecated.
getRawTagString(String) - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getReason() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
The inferred reason for the join failure.
getReason() - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
Deprecated.
getReason() - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
Reason for Punishment
getRecipient() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
The user that is receiving this gift, if it is not for the community at-large.
getRecipientName() - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
The display name of the user receiving the gift.
getRedeemedMonth() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The gift month that is being redeemed.
getReplyInfo() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
Information regarding the parent message being replied to, if applicable.
getRequestFromSubscription(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
getRequestQueueSize() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
HTTP Request Queue Size
getRitualName() - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
The name of the ritual this notice is for.
getScheduledThreadPoolExecutor() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Scheduler Thread Pool Executor
getScores() - Method in class com.github.twitch4j.chat.flag.AutoModFlag
Scores for the various FlagTypes for this region of the message.
getSelectedCount() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The number of gifted rewards as part of the primary selection.
getSource() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
Donation Source
getSource() - Method in class com.github.twitch4j.chat.events.CommandEvent
Source: channel / privateMessage
getSourceId() - Method in class com.github.twitch4j.chat.events.CommandEvent
Source Id: channelName or userName
getStartIndex() - Method in class com.github.twitch4j.chat.flag.AutoModFlag
The index in the message where the flagged item starts.
getState() - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
The updated state of the websocket.
getState() - Method in class com.github.twitch4j.chat.TwitchChat
 
getState(ChannelStateEvent.ChannelState) - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
getStates() - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
getSubPlan() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
The type of subscription plan being used.
getSubPlan() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Subscription Plan, in enum form
getSubscriberMonth() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
getSubscriberMonths() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
The exact number of months the user has been a subscriber, or zero if not subscribed
getSubscriberMonths() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
The exact number of months the user has been a subscriber, or zero if not subscribed
getSubscriberMonths() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getSubscriptionPlan() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The tier of the multi-month gifted subscription.
getSubscriptionPlan() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
The Subscription
getSubscriptionPlan() - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
The new subscription plan of the user.
getSubscriptionPlan() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Subscription Plan
getSubscriptionPlanName() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Deprecated.
will be removed in favor of .getSubPlan()
getSubscriptionSize(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
getSubscriptionTier() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
The tier at which the user is subscribed (prime is treated as 1), or zero if not subscribed
getSubscriptionTier() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
The tier at which the user is subscribed (prime is treated as 1), or zero if not subscribed
getSubscriptionTier() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getSubStreak() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Consecutive months subscribed
getSystemMessage() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getSystemMessage() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
getSystemMessage() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getTags() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
getTagValue(String) - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Gets a optional tag from the irc message
getTargetChannel() - Method in class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
Event Target ChatChannel
getTargetUser() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Get Target User
getTargetUserId() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Gets the Target User Id (from Tags)
getText() - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
The text being chanted.
getTime() - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
Time in seconds
getTime() - Method in class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
Time in seconds
getTime(TimeUnit) - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
getTotalCount() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
X subscriptions gifted totally
getTotalRewardCount() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The total number of rewards being gifted (e.g.
getTriggerAmount() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The number of instances of the trigger (e.g.
getTriggerType() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The type of monetary event that triggered the reward gift (e.g., "SUBGIFT", "CHEER").
getTwitchChat() - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Twitch Client
getTwitchChat() - Method in class com.github.twitch4j.chat.events.TwitchEvent
Get TwitchChat
getType() - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
The parsed value of ChannelNoticeEvent.getMsgId().
getUpgradingUser() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
The user that is upgrading their subscription.
getUser() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
The user that earned the bits badge.
getUser() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getUser() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
Event Target User
getUser() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
The user extending their subscription.
getUser() - Method in class com.github.twitch4j.chat.events.channel.FollowEvent
User
getUser() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
The gift recipient that is sending this resub message.
getUser() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
Event Target User
getUser() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Get User
getUser() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
The user that is paying forward their gift.
getUser() - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
The user that is upgrading their subscription.
getUser() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
The user that triggered this event.
getUser() - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
The user involved in the ritual.
getUser() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Event Target User
getUser() - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
Event Target User
getUser() - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
Event Target User
getUser() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
getUser() - Method in class com.github.twitch4j.chat.events.CommandEvent
User
getUserChatColor() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getUserDisplayName() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
getUserId() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getUserId() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
getUserId() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Gets the User Id (from Tags)
getUserLogin() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getUserName() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
getUserName() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
The login name of the user whose message was deleted.
getUserName() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Gets the User Name (from Tags)
getViewers() - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
Number of viewers in the raid
getVips() - Method in class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
The login names of the VIPs of this channel.
getWebsocketConnection() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebsocketConnection
getWhisperRateLimit() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
getWsCloseDelay() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Websocket Close Delay in ms (0 = minimum)
getWsPingPeriod() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebSocket RFC Ping Period in ms (0 = disabled)
GiftedMultiMonthSubCourtesyEvent - Class in com.github.twitch4j.chat.events.channel
This event occurs when a recipient of a multi-month gift sub enters a new month of the subscription, and shares a re-subscription message, despite no additional monetary transaction accompanying their message.
GiftedMultiMonthSubCourtesyEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
Event Constructor
GiftSubscriptionsEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user gifts x subscriptions to *random* users in chat.
GiftSubscriptionsEvent(EventChannel, EventUser, String, Integer, Integer) - Constructor for class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
Event Constructor
GiftSubUpgradeEvent - Class in com.github.twitch4j.chat.events.channel
Called when a user upgrades to a paid subscription from previously being gifted a subscription.
GiftSubUpgradeEvent(EventChannel, EventUser, String, Integer, String, String) - Constructor for class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
Constructor
GlobalUserStateEvent - Class in com.github.twitch4j.chat.events.channel
 
GlobalUserStateEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
GREEN - Enum constant in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 

H

handleDuplicateSubscription(TwitchChat, TwitchChat, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
handleSubscription(TwitchChat, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
handleUnsubscription(TwitchChat, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
hashCode() - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ClearChatEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.FollowEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.HostOffEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteError
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteSuccess
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.RaidCancellationEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.CommandEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.EmoteOnlyEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.Robot9000Event
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.roomstate.SubscribersOnlyEvent
 
hashCode() - Method in class com.github.twitch4j.chat.events.TwitchEvent
 
hashCode() - Method in class com.github.twitch4j.chat.flag.AutoModFlag
 
hashCode() - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
 
HOST_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Exited host mode.
HOST_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Now hosting <channel>.
HOST_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is now hosting you.
HOST_SUCCESS_VIEWERS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is now hosting you for up to <number> viewers.
HOST_TARGET_WENT_OFFLINE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<channel> has gone offline.
HostOffEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
Twitch is removing host mode on October 3, 2022
HostOffEvent(EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.HostOffEvent
Deprecated.
Event Constructor
HostOnEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
Twitch is removing host mode on October 3, 2022
HostOnEvent(EventChannel, EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
Event Constructor
HOSTS_REMAINING - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<number> host commands remaining this half hour.

I

IDENTITY - Enum constant in enum class com.github.twitch4j.chat.flag.FlagType
Identity language - Words referring to race, religion, gender, orientation, disability, or similar.
identityProvider - Variable in class com.github.twitch4j.chat.TwitchChat
Twitch Identity Provider
InboundHostEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
Twitch is removing host mode on October 3, 2022
InboundHostEvent(String, String) - Constructor for class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
 
INVALID_USER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Invalid username: <user>
ircAuthBucket - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Auth Bucket
ircAuthBucket - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for auths
ircCommandQueue - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Command Queue
IRCEventHandler - Class in com.github.twitch4j.chat.events
IRC Event Handler
IRCEventHandler(TwitchChat) - Constructor for class com.github.twitch4j.chat.events.IRCEventHandler
Constructor
ircJoinBucket - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Join Bucket
ircJoinBucket - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for joins
ircMessageBucket - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Message Bucket
ircMessageBucket - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for messages
IRCMessageEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when we receive a raw irc message.
IRCMessageEvent(String, Map<String, CharSequence>, CharSequence, String, String, CharSequence, String, Map<String, String>, Map<String, String>, Collection<String>) - Constructor for class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
IRCMessageEvent(String, Map<String, String>, Map<String, String>, Collection<String>) - Constructor for class com.github.twitch4j.chat.events.channel.IRCMessageEvent
ircWhisperBucket - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Whisper Bucket
ircWhisperBucket - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
isActive() - Method in class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
isAutoJoinOwnChannel() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether one's own channel should automatically be joined
isBroadcaster() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
isChannelJoined(String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Check if Chat is currently in a channel
isChannelJoined(String) - Method in class com.github.twitch4j.chat.TwitchChat
 
isChannelJoined(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
isCommunityPayForward() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
isDesignatedFirstMessage() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
isEnableMembershipEvents() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether JOIN/PART events should be enabled for the TwitchChat instance.
isHighlightedMessage() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
isInitiator() - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
Whether this message initiated a crowd chat.
isMod() - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
Is Moderator?
isModerator() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
isNewChatter() - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
 
isPrimeOrTurbo() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
isPrimeOrTurbo() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
isRemoveChannelOnJoinFailure() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether join failures should result in removal from current channels.
isSendCredentialToThirdPartyHost() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether the OAuth2Credential password should be sent when the baseUrl does not match the official twitch websocket server, thus bypassing a security check in the library.
isSkipSubsModeMessage() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
isStaff() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
isStaff() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
isSubscriber() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
issueJoin(String, int) - Method in class com.github.twitch4j.chat.TwitchChat
 
isUserIntroduction() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
isValid() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Deprecated.
MessageParser.parse(String) yields null for invalid messages
isVerifyChatAccountOnReconnect() - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether the TwitchChatBuilder.getChatAccount() should be validated on reconnection failures.
isWasAnonymous() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
Whether the original multi-month gift was done by an anonymous user.
isWatchStreak() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
ITwitchChat - Interface in com.github.twitch4j.chat
 

J

JOIN_BANDWIDTH_ID - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
 
joinAttemptsByChannelName - Variable in class com.github.twitch4j.chat.TwitchChat
Cache of recent number of join attempts for each channel
joinChannel(String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Joins a channel
joinChannel(String) - Method in class com.github.twitch4j.chat.TwitchChat
Joining the channel
joinChannel(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
joinRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for JOIN/PART
joinRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Custom RateLimit for JOIN/PART
joinRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 

K

KNOWN_MESSAGE_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Known bots
KNOWN_WHISPER_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Known bots

L

leaveChannel(String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Parts from a channel
leaveChannel(String) - Method in class com.github.twitch4j.chat.TwitchChat
leaving the channel
leaveChannel(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
ListModsEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getModerators
ListModsEvent(EventChannel, List<String>) - Constructor for class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
Event Constructor
ListVipsEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getChannelVips
ListVipsEvent(EventChannel, List<String>) - Constructor for class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
Event Constructor

M

maxJoinRetries - Variable in class com.github.twitch4j.chat.TwitchChat
The maximum number of attempts to make for joining each channel
MESSAGE_BANDWIDTH_ID - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
 
MessageDeleteError - Class in com.github.twitch4j.chat.events.channel
Deprecated.
With chat commands decommissioned, this event is no longer fired; migrate to TwitchHelix#deleteChatMessages.
MessageDeleteError(EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.MessageDeleteError
Deprecated.
Event Constructor
MessageDeleteSuccess - Class in com.github.twitch4j.chat.events.channel
Deprecated.
With chat commands decommissioned, this event is no longer fired; migrate to TwitchHelix#deleteChatMessages.
MessageDeleteSuccess(EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.MessageDeleteSuccess
Deprecated.
Event Constructor
MessageParser - Class in com.github.twitch4j.chat.util
 
MOD_MESSAGE_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Users sending commands or messages to channels in which they have Moderator or Operator status
MOD_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You have added <user> as a moderator of this channel.
ModAnnouncementEvent - Class in com.github.twitch4j.chat.events.channel
Fired when the broadcaster or a moderator publishes an accented message via /announce.
ModAnnouncementEvent(IRCMessageEvent, EventChannel, EventUser, String, AnnouncementColor) - Constructor for class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
Event Constructor
MSG_BAD_CHARACTERS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message was not sent because it contained too many characters that could not be processed.
MSG_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You are permanently banned from talking in <channel>.
MSG_BANNED_EMAIL_ALIAS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message was not sent because your email address is banned from this channel.
MSG_CHANNEL_BLOCKED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message was not sent because your account is not in good standing in this channel.
MSG_CHANNEL_SUSPENDED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel has been suspended.
MSG_DUPLICATE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message was not sent because it is identical to the previous one you sent, less than 30 seconds ago.
MSG_EMOTEONLY - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in emote only mode.
MSG_FACEBOOK - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You must use Facebook Connect to send messages to this channel.
MSG_FOLLOWERSONLY - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in <duration> followers-only mode.
MSG_FOLLOWERSONLY_FOLLOWED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in <duration1> followers-only mode.
MSG_FOLLOWERSONLY_ZERO - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in followers-only mode.
MSG_R9K - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in r9k mode and the message you attempted to send is not unique.
MSG_RATELIMIT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message was not sent because you are sending messages too quickly.
MSG_REJECTED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Hey! Your message is being checked by mods and has not been sent.
MSG_REJECTED_MANDATORY - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your message wasn't posted due to conflicts with the channel's moderation settings.
MSG_REQUIRES_VERIFIED_PHONE_NUMBER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
A verified phone number is required to chat in this channel.
MSG_ROOM_NOT_FOUND - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The room was not found.
MSG_SLOWMODE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in slow mode and you are sending messages too quickly.
MSG_SUBSONLY - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is in subscribers only mode.
MSG_SUSPENDED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your account has been suspended.
MSG_TIMEDOUT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You are banned from talking in <channel> for <number> more seconds.
MSG_VERIFIED_EMAIL - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room requires a verified email address to chat.

N

NO_HELP - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
No help available.
NO_MODS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
There are no moderators of this channel.
NO_PERMISSION - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You don’t have permission to perform that action.
NO_VIPS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel does not have any VIPs.
NONCE_TAG_NAME - Static variable in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
NONE - Enum constant in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
NOT_HOSTING - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
No channel is currently being hosted.
NoticeTag - Enum Class in com.github.twitch4j.chat.enums
The documented possible values of ChannelNoticeEvent.getMsgId().

O

onAnnouncement(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onBitsBadgeTier(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Bits Badge Earned Event Parser
onChannelCheer(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Cheer (Bits) Event
onChannelMessage(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Message Event
onChannelModChange(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onChannelState(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onChannelSubscription(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Subscription Event
onChannnelClientJoinEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
User Joins ChatChannel Event
onChannnelClientLeaveEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
User Leaves ChatChannel Event
onCharityDonation(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onClearChat(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel clearing chat, timeouting or banning user Event
onClearMsg(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
A single message was deleted in a channel by a moderator
onConnected() - Method in class com.github.twitch4j.chat.TwitchChat
 
onDirectCheer(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onDisconnecting() - Method in class com.github.twitch4j.chat.TwitchChat
 
onGiftReceived(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Prime Community Gift Event Parser: user receives a gift from a prime member
onGlobalUserState(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onHostOffEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onHostOnEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onInboundHostEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onListModsEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onListVipsEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onMessageDeleteResponse(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
onNames(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Names list is received upon initial channel join
onNoticeEvent(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onPayForward(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Pay Forward Event Parser: user pays forward a gift they previously received
onRaid(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Raid Event (receiving)
onRewardGift(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Reward Gift Event Parser: monetary event triggered emotes to be shared
onRitual(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Deprecated.
no longer sent by twitch.
onTextMessage(String) - Method in class com.github.twitch4j.chat.TwitchChat
 
onUnraid(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
ChatChannel Unraid Parser: raid cancellation
onUserState(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
 
onWhisper(IRCMessageEvent) - Method in class com.github.twitch4j.chat.events.IRCEventHandler
Whisper Event
ORANGE - Enum constant in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 
ordinalName() - Method in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 

P

parse(String) - Static method in class com.github.twitch4j.chat.util.MessageParser
 
parse(String, Map<String, String>, Map<String, String>, Collection<String>) - Static method in class com.github.twitch4j.chat.util.MessageParser
 
parse(IRCMessageEvent) - Static method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
Attempts to parse the ChatCrowdChant information from a chat event.
parse(String) - Static method in enum class com.github.twitch4j.chat.enums.NoticeTag
Attempts to parse the msgId to an enum value.
parse(String) - Static method in enum class com.github.twitch4j.chat.flag.FlagType
 
parseClientName(String) - Static method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Deprecated.
This method is no longer used by twitch4j
parseColor(String) - Static method in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 
parseFlags(IRCMessageEvent) - Static method in class com.github.twitch4j.chat.flag.FlagParser
 
parseFlags(String) - Static method in class com.github.twitch4j.chat.flag.FlagParser
 
parseTags(char[], Map<String, CharSequence>) - Static method in class com.github.twitch4j.chat.util.MessageParser
 
parseTags(String) - Static method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
Deprecated.
This method is no longer used by twitch4j
parseValue() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
participate(ITwitchChat) - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
PayForwardEvent - Class in com.github.twitch4j.chat.events.channel
Calls when a user pays forward a gift.
PayForwardEvent(EventChannel, EventUser, EventUser, EventUser) - Constructor for class com.github.twitch4j.chat.events.channel.PayForwardEvent
Event Constructor
perChannelRateLimit - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Per-Channel Message Limit
perChannelRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for Messages per Channel
perChannelRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Custom RateLimit for Messages per Channel
perChannelRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
PRIMARY - Enum constant in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 
PrimeGiftReceivedEvent - Class in com.github.twitch4j.chat.events.channel
Called when a user receives a gift from a Prime member.
PrimeGiftReceivedEvent(EventChannel, EventUser, String, String) - Constructor for class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
Event Constructor
PrimeSubUpgradeEvent - Class in com.github.twitch4j.chat.events.channel
Called when a user upgrades from a prime sub to a tiered subscription.
PrimeSubUpgradeEvent(EventChannel, EventUser, SubscriptionPlan) - Constructor for class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
Constructor
PRIVATE_MESSAGE - Enum constant in enum class com.github.twitch4j.chat.enums.CommandSource
 
PROFANITY - Enum constant in enum class com.github.twitch4j.chat.flag.FlagType
Profanity - Expletives, curse words, and vulgarity.
PURPLE - Enum constant in enum class com.github.twitch4j.chat.enums.AnnouncementColor
 

Q

queueThread - Variable in class com.github.twitch4j.chat.TwitchChat
IRC Command Queue Thread

R

R9K - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
 
R9K_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is no longer in r9k mode.
R9K_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in r9k mode.
RAID_ERROR_ALREADY_RAIDING - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You already have a raid in progress.
RAID_ERROR_FORBIDDEN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot raid this channel.
RAID_ERROR_SELF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
A channel cannot raid itself.
RAID_ERROR_TOO_MANY_VIEWERS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Sorry, you have more viewers than the maximum currently supported by raids right now.
RAID_ERROR_UNEXPECTED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
There was a problem raiding <channel>.
RAID_NOTICE_MATURE - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel is intended for mature audiences.
RAID_NOTICE_RESTRICTED_CHAT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This channel has follower or subscriber only chat.
RaidCancellationEvent - Class in com.github.twitch4j.chat.events.channel
Called when a channel cancels an outstanding raid.
RaidCancellationEvent(EventChannel) - Constructor for class com.github.twitch4j.chat.events.channel.RaidCancellationEvent
Event Constructor
RaidEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user receives a raid.
RaidEvent(EventChannel, EventUser, Integer) - Constructor for class com.github.twitch4j.chat.events.channel.RaidEvent
 
reconnect() - Method in class com.github.twitch4j.chat.TwitchChat
Reconnecting to IRC-WS
RECONNECTING - Enum constant in enum class com.github.twitch4j.chat.enums.TMIConnectionState
 
removeChannelOnJoinFailure - Variable in class com.github.twitch4j.chat.TwitchChat
Whether join failures should result in removal from current channels
reply(ITwitchChat, String) - Method in interface com.github.twitch4j.chat.events.channel.ReplyableEvent
Sends a reply to this chat message.
reply(ITwitchChat, String) - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Replies to this sub event, if a message was included when the subscription was shared.
ReplyableEvent - Interface in com.github.twitch4j.chat.events.channel
 
REQUIRED_THREAD_COUNT - Static variable in class com.github.twitch4j.chat.TwitchChat
 
respondToUser(String) - Method in class com.github.twitch4j.chat.events.CommandEvent
Respond to the command origin (channel or private)
RETRIES_EXHAUSTED - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason
The chat instance was unable to join the channel, exhausting maxJoinRetries.
RewardGiftEvent - Class in com.github.twitch4j.chat.events.channel
Called when a monetary event (e.g.
RewardGiftEvent(EventChannel, EventUser, String, String, Integer, Integer, Integer) - Constructor for class com.github.twitch4j.chat.events.channel.RewardGiftEvent
Event Constructor
RitualEvent - Class in com.github.twitch4j.chat.events.channel
Deprecated.
no longer sent by twitch.
RitualEvent(EventChannel, EventUser, String) - Constructor for class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
Event Constructor
RITUALS - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
Deprecated.
Robot9000Event - Class in com.github.twitch4j.chat.events.roomstate
R9K State Event
Robot9000Event(EventChannel, boolean) - Constructor for class com.github.twitch4j.chat.events.roomstate.Robot9000Event
Constructor
ROOM_MODS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The moderators of this channel are: <list of users>

S

score(FlagType, Integer) - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
 
scores(Map<? extends FlagType, ? extends Integer>) - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
 
self() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
sendActionMessage(String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Sends an action message (/me) in a joined channel.
sendAnnouncement(String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#sendChatAnnouncement
sendCommand(String, String...) - Method in class com.github.twitch4j.chat.TwitchChat
Send IRC Command
sendCredentialToThirdPartyHost - Variable in class com.github.twitch4j.chat.TwitchChat
Whether the OAuth2Credential password should be sent when the baseUrl does not match the official twitch websocket server, thus bypassing a security check in the library.
sendMessage(String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Sends a message in a joined channel.
sendMessage(String, String, Map<String, Object>) - Method in interface com.github.twitch4j.chat.ITwitchChat
Sends a message to the channel while including the specified message tags.
sendMessage(String, String, Map<String, Object>) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
 
sendMessage(String, String, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Sends a message from the TwitchChat identified either to a channel or directly on the socket.
sendMessage(String, String, String, Map<String, Object>) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Sends a message from the identified TwitchChat instance with the specified tags.
sendMessage(String, String, String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Sends a message to the channel while including an optional nonce and/or reply parent.
sendMessage(String, String, String, String, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Sends a message from the identified TwitchChat instance with an optional nonce or reply parent.
sendMessage(String, String, Map<String, Object>) - Method in class com.github.twitch4j.chat.TwitchChat
 
sendPrivateMessage(String, String) - Method in class com.github.twitch4j.chat.TwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#sendWhisper
sendPrivateMessage(String, String, String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
sendRaw(String) - Method in class com.github.twitch4j.chat.TwitchChat
Send raw irc command
setBotOwnerIds(Collection<String>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
User IDs of Bot Owners for applying CommandPermission.OWNER
setCommandPrefixes(Set<String>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
IRC Command Handlers
setEmoteOnly(String, boolean) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
setFollowersOnly(String, Duration) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
setSlowMode(String, int) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
setSubscribersOnly(String, boolean) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
setUniqueChat(String, boolean) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
SEXUAL - Enum constant in enum class com.github.twitch4j.chat.flag.FlagType
Sexually explicit language - Words or phrases referring to sexual acts, sexual content, and body parts.
SLOW - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
 
SLOW_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is no longer in slow mode.
SLOW_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in slow mode.
SlowModeEvent - Class in com.github.twitch4j.chat.events.roomstate
Slow Mode State Event
SlowModeEvent(EventChannel, long) - Constructor for class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
Constructor
startIndex(int) - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
The index in the message where the flagged item starts.
stopQueueThread - Variable in class com.github.twitch4j.chat.TwitchChat
Command Queue Thread stop flag
SUBS_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is no longer in subscribers-only mode.
SUBS_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
This room is now in subscribers-only mode.
subscribe(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Joins a channel.
SUBSCRIBERS - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
 
SubscribersOnlyEvent - Class in com.github.twitch4j.chat.events.roomstate
Subscribers Only State Event
SubscribersOnlyEvent(EventChannel, boolean) - Constructor for class com.github.twitch4j.chat.events.roomstate.SubscribersOnlyEvent
Constructor
SubscriptionEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user gets a new subscriber or a user resubscribes.
SubscriptionEvent(IRCMessageEvent, EventChannel, EventUser, String, Optional<String>, Integer, Boolean, EventUser, Integer, Integer, Integer, Integer, List<AutoModFlag>) - Constructor for class com.github.twitch4j.chat.events.channel.SubscriptionEvent
Event Constructor
SubscriptionPlan - Enum Class in com.github.twitch4j.chat.enums
Deprecated.

T

taskExecutor - Variable in class com.github.twitch4j.chat.TwitchChat
Thread Pool Executor
TIER1 - Enum constant in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
TIER2 - Enum constant in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
TIER3 - Enum constant in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
timeout(String, String, Duration, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#banUser
timeout(String, Duration, String) - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
Deprecated.
Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#banUser
TIMEOUT_NO_TIMEOUT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is not timed out from this channel.
TIMEOUT_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> has been timed out for <duration> seconds.
TMIConnectionState - Enum Class in com.github.twitch4j.chat.enums
 
TOS_BAN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The community has closed channel <channel> due to Terms of Service violations.
toString() - Method in enum class com.github.twitch4j.chat.enums.NoticeTag
 
toString() - Method in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
 
toString() - Method in class com.github.twitch4j.chat.events.AbstractChannelMessageEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.BitsBadgeEarnedEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelLeaveEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelMessageEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelModEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelNoticeEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ChannelStateEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.CharityDonationEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.CheerEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ClearChatEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.DirectCheerEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.DonationEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ExtendSubscriptionEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.FollowEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.GiftedMultiMonthSubCourtesyEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.GiftSubscriptionsEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.GiftSubUpgradeEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.GlobalUserStateEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.HostOffEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.HostOnEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.InboundHostEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.IRCMessageEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ListModsEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ListVipsEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteError
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.MessageDeleteSuccess
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ModAnnouncementEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.PrimeGiftReceivedEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.PrimeSubUpgradeEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.RaidCancellationEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.RaidEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.RewardGiftEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.RitualEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.channel.SubscriptionEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.UserBanEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.UserStateEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
 
toString() - Method in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
toString() - Method in class com.github.twitch4j.chat.events.ChatConnectionStateEvent
 
toString() - Method in class com.github.twitch4j.chat.events.CommandEvent
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
Deprecated.
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.ChannelStatesEvent
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.EmoteOnlyEvent
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.FollowersOnlyEvent
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.Robot9000Event
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.SlowModeEvent
 
toString() - Method in class com.github.twitch4j.chat.events.roomstate.SubscribersOnlyEvent
 
toString() - Method in class com.github.twitch4j.chat.events.TwitchEvent
 
toString() - Method in class com.github.twitch4j.chat.flag.AutoModFlag.AutoModFlagBuilder
 
toString() - Method in class com.github.twitch4j.chat.flag.AutoModFlag
 
toString() - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
toString() - Method in class com.github.twitch4j.chat.util.ChatCrowdChant
Deprecated.
 
TURBO_ONLY_COLOR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Only turbo users can specify an arbitrary hex color.
TWITCH_PRIME - Enum constant in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
 
TWITCH_WEB_SOCKET_SERVER - Static variable in class com.github.twitch4j.chat.TwitchChat
Twitch's official WebSocket Server
TwitchChat - Class in com.github.twitch4j.chat
 
TwitchChat(WebsocketConnection, EventManager, CredentialManager, OAuth2Credential, String, boolean, Collection<String>, Integer, Bucket, Bucket, Bucket, Bucket, ScheduledThreadPoolExecutor, long, ProxyConfig, boolean, boolean, Collection<String>, boolean, int, long, int, IBackoffStrategy, Bandwidth, boolean, int, BiPredicate<TwitchChat, String>) - Constructor for class com.github.twitch4j.chat.TwitchChat
Constructor
TwitchChatBuilder - Class in com.github.twitch4j.chat
Twitch Chat
TwitchChatConnectionPool - Class in com.github.twitch4j.chat
A pool for TwitchChat connections.
TwitchChatConnectionPool(TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<?, ?>) - Constructor for class com.github.twitch4j.chat.TwitchChatConnectionPool
 
TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C extends TwitchChatConnectionPool,B extends TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder<C,B>> - Class in com.github.twitch4j.chat
 
TwitchChatConnectionPoolBuilder() - Constructor for class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
TwitchChatLimitHelper - Class in com.github.twitch4j.chat.util
Utility class for retrieving standard rate limits for TwitchChat
TwitchEvent - Class in com.github.twitch4j.chat.events
 
TwitchEvent() - Constructor for class com.github.twitch4j.chat.events.TwitchEvent
Constructor
TwitchEvent(String, Instant) - Constructor for class com.github.twitch4j.chat.events.TwitchEvent
Constructor

U

unban(String) - Method in class com.github.twitch4j.chat.events.AbstractChannelEvent
Deprecated.
Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#unbanUser
unban(String, String) - Method in interface com.github.twitch4j.chat.ITwitchChat
Deprecated.
Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#unbanUser
UNBAN_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is no longer banned from this channel.
UNMOD_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You have removed <user> as a moderator of this channel.
UNRAID_ERROR_NO_ACTIVE_RAID - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You do not have an active raid.
UNRAID_ERROR_UNEXPECTED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
There was a problem stopping the raid.
UNRAID_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The raid has been cancelled.
UNRECOGNIZED_CMD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Unrecognized command: <command>
unsubscribe(String) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool
Parts from a channel.
UNSUPPORTED_CHATROOMS_CMD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The command <command> cannot be used in a chatroom.
UNTIMEOUT_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is permanently banned.
UNTIMEOUT_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
<user> is no longer timed out in this channel.
UNVIP_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You have removed <user> as a VIP of this channel.
USAGE_BAN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/ban <username> [reason]” Permanently prevent a user from chatting.
USAGE_CLEAR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/clear” Clear chat history for all users in this room.
USAGE_COLOR - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/color <color>” Change your username color.
USAGE_COMMERCIAL - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/commercial [length]” Triggers a commercial.
USAGE_DISCONNECT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/disconnect” Reconnects to chat.
USAGE_EMOTE_ONLY_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/emoteonlyoff” Disables emote-only mode.
USAGE_EMOTE_ONLY_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/emoteonly” Enables emote-only mode (only emoticons may be used in chat).
USAGE_FOLLOWERS_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/followersoff” Disables followers-only mode.
USAGE_FOLLOWERS_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/followers” Enables followers-only mode (only users who have followed for “duration” may chat).
USAGE_HELP - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/help” Lists the commands available to you in this room.
USAGE_HOST - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/host <channel>” Host another channel.
USAGE_MARKER - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/marker <optional comment>” Adds a stream marker (with an optional comment, max 140 characters) at the current timestamp.
USAGE_ME - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/me <message>” Send an “emote” message in the third person.
USAGE_MOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/mod <username>” Grant mod status to a user.
USAGE_MODS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/mods” Lists the moderators of this channel.
USAGE_R9K_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/r9kbetaoff” Disables r9k mode.
USAGE_R9K_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/r9kbeta” Enables r9k mode.
USAGE_RAID - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/raid <channel>” Raid another channel.
USAGE_SLOW_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/slowoff” Disables slow mode.
USAGE_SLOW_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/slow [duration]” Enables slow mode (limit how often users may send messages).
USAGE_SUBS_OFF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/subscribersoff” Disables subscribers-only mode.
USAGE_SUBS_ON - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/subscribers” Enables subscribers-only mode (only subscribers may chat in this channel).
USAGE_TIMEOUT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/timeout <username> [duration][time unit] [reason]"Temporarily prevent a user from chatting.
USAGE_UNBAN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/unban <username>” Removes a ban on a user.
USAGE_UNHOST - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/unhost” Stop hosting another channel.
USAGE_UNMOD - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/unmod <username>” Revoke mod status from a user.
USAGE_UNRAID - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/unraid” Cancel the Raid.
USAGE_UNTIMEOUT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/untimeout <username>” Removes a timeout on a user.
USAGE_VIP - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/vip <username>” Grant VIP status to a user.
USAGE_VIPS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: “/vips” Lists the VIPs of this channel.
USER_AUTH_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Authentication rate for users
USER_BANNED - Enum constant in enum class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason
The chat user was banned from an initially successfully joined channel.
USER_JOIN_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Join rate for users
USER_MESSAGE_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Users sending commands or messages to channels in which they do not have Moderator or Operator status
USER_WHISPER_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Users (not bots)
UserBanEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user gets banned.
UserBanEvent(EventChannel, EventUser, String) - Constructor for class com.github.twitch4j.chat.events.channel.UserBanEvent
Event Constructor
USERNOTICE_ID - Static variable in class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
UserStateEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user joins a channel or sends a PRIVMSG to a channel.
UserStateEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.UserStateEvent
Event constructor
UserTimeoutEvent - Class in com.github.twitch4j.chat.events.channel
This event gets called when a user get a timeout.
UserTimeoutEvent(EventChannel, EventUser, Integer, String) - Constructor for class com.github.twitch4j.chat.events.channel.UserTimeoutEvent
Event Constructor

V

validateOnConnect - Variable in class com.github.twitch4j.chat.TwitchChat
Whether OAuth token status should be checked on reconnect
valueOf(String) - Static method in enum class com.github.twitch4j.chat.enums.AnnouncementColor
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.enums.CommandSource
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.enums.NoticeTag
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.enums.TMIConnectionState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
Returns the enum constant of this class with the specified name.
valueOf(String) - Static method in enum class com.github.twitch4j.chat.flag.FlagType
Returns the enum constant of this class with the specified name.
values() - Static method in enum class com.github.twitch4j.chat.enums.AnnouncementColor
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.enums.CommandSource
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.enums.NoticeTag
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.enums.SubscriptionPlan
Deprecated.
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.enums.TMIConnectionState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.events.channel.ChannelJoinFailureEvent.Reason
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState
Returns an array containing the constants of this enum class, in the order they are declared.
values() - Static method in enum class com.github.twitch4j.chat.flag.FlagType
Returns an array containing the constants of this enum class, in the order they are declared.
VERIFIED_AUTH_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Authentication rate for verified bots
VERIFIED_JOIN_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Join rate for verified bots
VERIFIED_MESSAGE_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Verified bots
VERIFIED_WHISPER_LIMIT - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
Verified bots
ViewerMilestoneEvent - Class in com.github.twitch4j.chat.events.channel
 
ViewerMilestoneEvent(IRCMessageEvent) - Constructor for class com.github.twitch4j.chat.events.channel.ViewerMilestoneEvent
 
VIP_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You have added <user> as a VIP of this channel.
VIPS_SUCCESS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
The VIPs of this channel are: <list of users>.

W

wasActionMessage() - Method in class com.github.twitch4j.chat.events.channel.DeleteMessageEvent
Whether the deleted message was an action event (/me).
wasPriorGifterAnonymous() - Method in class com.github.twitch4j.chat.events.channel.PayForwardEvent
 
WHISPER_BANNED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You have been banned from sending whispers.
WHISPER_BANNED_RECIPIENT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
That user has been banned from receiving whispers.
WHISPER_INVALID_ARGS - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Usage: <login> <message>
WHISPER_INVALID_LOGIN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
No user matching that login.
WHISPER_INVALID_SELF - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You cannot whisper to yourself.
WHISPER_LIMIT_PER_MIN - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You are sending whispers too fast.
WHISPER_LIMIT_PER_SEC - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
You are sending whispers too fast.
WHISPER_MINUTE_BANDWIDTH_ID - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
 
WHISPER_RESTRICTED - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
Your settings prevent you from sending this whisper.
WHISPER_RESTRICTED_RECIPIENT - Enum constant in enum class com.github.twitch4j.chat.enums.NoticeTag
That user's settings prevent them from receiving this whisper.
WHISPER_SECOND_BANDWIDTH_ID - Static variable in class com.github.twitch4j.chat.util.TwitchChatLimitHelper
 
whisperRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
whisperRateLimit - Variable in class com.github.twitch4j.chat.TwitchChatConnectionPool
Custom RateLimit for Whispers
whisperRateLimit(Bandwidth[]) - Method in class com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder
 
withAuthRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for AUTH
withAutoJoinOwnChannel(boolean) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether one's own channel should automatically be joined
withBaseUrl(String) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
A custom websocket url for TwitchChat to connect to.
withBotOwnerId(String) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
With a Bot Owner's User ID
withBotOwnerIds(Collection<String>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
With multiple Bot Owner User IDs
withChatAccount(OAuth2Credential) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
IRC User Id
withChatJoinTimeout(long) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
The amount of milliseconds to wait after queuing a JOIN before classifying the attempt as a failure.
withChatQueueSize(Integer) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Size of the ChatQueue
withChatQueueTimeout(long) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Millisecond wait time for taking items off chat queue.
withChatRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for ChatMessages
withClientId(String) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Client Id
withClientSecret(String) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Client Secret
withCommandTrigger(String) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
With a CommandTrigger
withCommandTriggers(Collection<String>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
With multiple CommandTriggers
withConnectionBackoffStrategy(IBackoffStrategy) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebSocket Connection Backoff Strategy
withCredentialManager(CredentialManager) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Credential Manager
withDefaultEventHandler(Class<? extends IEventHandler>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
EventManager
withEnableMembershipEvents(boolean) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether JOIN/PART events should be enabled for the TwitchChat instance.
withEventManager(EventManager) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Event Manager
withIrcAuthBucket(Bucket) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for auths
withIrcJoinBucket(Bucket) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for joins
withIrcMessageBucket(Bucket) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Shared bucket for messages
withIrcWhisperBucket(Bucket) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
withJoinRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for JOIN/PART
withMaxJoinRetries(int) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
The maximum number of retries to make for joining each channel, with exponential backoff.
withOutboundCommandFilter(BiPredicate<TwitchChat, String>) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
withPerChannelRateLimit(Bandwidth) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Custom RateLimit for Messages per Channel
withProxyConfig(ProxyConfig) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Proxy Configuration
withRemoveChannelOnJoinFailure(boolean) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether join failures should result in removal from current channels.
withRequestQueueSize(Integer) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
HTTP Request Queue Size
withScheduledThreadPoolExecutor(ScheduledThreadPoolExecutor) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Scheduler Thread Pool Executor
withSendCredentialToThirdPartyHost(boolean) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether the OAuth2Credential password should be sent when the baseUrl does not match the official twitch websocket server, thus bypassing a security check in the library.
withVerifyChatAccountOnReconnect(boolean) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Whether the TwitchChatBuilder.getChatAccount() should be validated on reconnection failures.
withWebsocketConnection(WebsocketConnection) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebsocketConnection
withWhisperRateLimit(Bandwidth[]) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Deprecated.
Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
withWsCloseDelay(int) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
Websocket Close Delay in ms (0 = minimum)
withWsPingPeriod(int) - Method in class com.github.twitch4j.chat.TwitchChatBuilder
WebSocket RFC Ping Period in ms (0 = disabled)
A B C D E F G H I J K L M N O P Q R S T U V W 
All Classes and Interfaces|All Packages|Constant Field Values