Deprecated API

Contents

• Classes
• Enum Classes
• Fields
• Methods
• Constructors
• Enum Constants

Deprecated Classes

Class	Description
com.github.twitch4j.chat.events.channel.ChannelModEvent	Twitch intends to remove this event.
com.github.twitch4j.chat.events.channel.DirectCheerEvent	in favor of ChannelMessageEvent.getElevatedChatPayment()
com.github.twitch4j.chat.events.channel.HostOffEvent	Twitch is removing host mode on October 3, 2022
com.github.twitch4j.chat.events.channel.HostOnEvent	Twitch is removing host mode on October 3, 2022
com.github.twitch4j.chat.events.channel.InboundHostEvent	Twitch is removing host mode on October 3, 2022
com.github.twitch4j.chat.events.channel.ListModsEvent	Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getModerators
com.github.twitch4j.chat.events.channel.ListVipsEvent	Twitch will decommission this event on February 18, 2023; migrate to TwitchHelix#getChannelVips
com.github.twitch4j.chat.events.channel.MessageDeleteError	With chat commands decommissioned, this event is no longer fired; migrate to TwitchHelix#deleteChatMessages.
com.github.twitch4j.chat.events.channel.MessageDeleteSuccess	With chat commands decommissioned, this event is no longer fired; migrate to TwitchHelix#deleteChatMessages.
com.github.twitch4j.chat.events.channel.RitualEvent	no longer sent by twitch.
com.github.twitch4j.chat.events.roomstate.BroadcasterLanguageEvent
com.github.twitch4j.chat.util.ChatCrowdChant	Will be disabled on 2022-02-02

Deprecated Enum Classes

Enum Class	Description
com.github.twitch4j.chat.enums.AnnouncementColor	in favor of AnnouncementColor
com.github.twitch4j.chat.enums.SubscriptionPlan

Deprecated Fields

Field	Description
com.github.twitch4j.chat.TwitchChatBuilder.ircWhisperBucket	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatBuilder.whisperRateLimit	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatConnectionPool.automaticallyPartOnBan	use removeChannelOnJoinFailure via advancedConfiguration instead.

Deprecated Methods

Method	Description
com.github.twitch4j.chat.events.AbstractChannelEvent.ban(String, String)	Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#banUser
com.github.twitch4j.chat.events.AbstractChannelEvent.timeout(String, Duration, String)	Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#banUser
com.github.twitch4j.chat.events.AbstractChannelEvent.unban(String)	Twitch decommissioned this method on February 18, 2023; migrate to TwitchHelix#unbanUser
com.github.twitch4j.chat.events.channel.ChannelMessageEvent.getChantInfo()	Will be disabled on 2022-02-02
com.github.twitch4j.chat.events.channel.DirectCheerEvent.getBits()	direct cheer values are not easily translatable into bit amounts, especially for non-USD currencies.
com.github.twitch4j.chat.events.channel.IRCMessageEvent.getRawTags()	in favor of IRCMessageEvent.getEscapedTags()
com.github.twitch4j.chat.events.channel.IRCMessageEvent.getTags()	in favor of IRCMessageEvent.getTagValue(String) or IRCMessageEvent.getEscapedTags()
com.github.twitch4j.chat.events.channel.IRCMessageEvent.isValid()	MessageParser.parse(String) yields null for invalid messages
com.github.twitch4j.chat.events.channel.IRCMessageEvent.parseClientName(String)	This method is no longer used by twitch4j
com.github.twitch4j.chat.events.channel.IRCMessageEvent.parseTags(String)	This method is no longer used by twitch4j
com.github.twitch4j.chat.events.channel.ModAnnouncementEvent.getColor()	in favor of ModAnnouncementEvent.getAccentColor()
com.github.twitch4j.chat.events.channel.SubscriptionEvent.getSubscriptionPlanName()	will be removed in favor of .getSubPlan()
com.github.twitch4j.chat.events.channel.UserBanEvent.getReason()
com.github.twitch4j.chat.events.IRCEventHandler.onChannelModChange(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onDirectCheer(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onHostOffEvent(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onHostOnEvent(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onInboundHostEvent(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onListModsEvent(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onListVipsEvent(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onMessageDeleteResponse(IRCMessageEvent)
com.github.twitch4j.chat.events.IRCEventHandler.onRitual(IRCMessageEvent)	no longer sent by twitch.
com.github.twitch4j.chat.ITwitchChat.ban(String, String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#banUser
com.github.twitch4j.chat.ITwitchChat.clearChat(String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#deleteChatMessages
com.github.twitch4j.chat.ITwitchChat.delete(String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#deleteChatMessages
com.github.twitch4j.chat.ITwitchChat.sendAnnouncement(String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#sendChatAnnouncement
com.github.twitch4j.chat.ITwitchChat.setEmoteOnly(String, boolean)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.ITwitchChat.setFollowersOnly(String, Duration)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.ITwitchChat.setSlowMode(String, int)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.ITwitchChat.setSubscribersOnly(String, boolean)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.ITwitchChat.setUniqueChat(String, boolean)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.ITwitchChat.timeout(String, String, Duration, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#banUser
com.github.twitch4j.chat.ITwitchChat.unban(String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#unbanUser
com.github.twitch4j.chat.TwitchChat.getConnectionState()	use TwitchChat.getState() instead
com.github.twitch4j.chat.TwitchChat.getCurrentChannels()	use getChannels() instead
com.github.twitch4j.chat.TwitchChat.sendPrivateMessage(String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#sendWhisper
com.github.twitch4j.chat.TwitchChatBuilder.getIrcWhisperBucket()	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatBuilder.getWhisperRateLimit()	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatBuilder.withIrcWhisperBucket(Bucket)	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatBuilder.withOutboundCommandFilter(BiPredicate<TwitchChat, String>)
com.github.twitch4j.chat.TwitchChatBuilder.withWhisperRateLimit(Bandwidth[])	Twitch will decommission whispers over IRC on February 18, 2023; please migrate to TwitchHelix#sendWhisper and TwitchLimitRegistry#setLimit
com.github.twitch4j.chat.TwitchChatConnectionPool.sendPrivateMessage(String, String, String)	Twitch will decommission this method on February 18, 2023; migrate to TwitchHelix#updateChatSettings
com.github.twitch4j.chat.TwitchChatConnectionPool.TwitchChatConnectionPoolBuilder.automaticallyPartOnBan(boolean)	use removeChannelOnJoinFailure via advancedConfiguration instead.
com.github.twitch4j.chat.util.ChatCrowdChant.participate(ITwitchChat)	Will be disabled on 2022-02-02
com.github.twitch4j.chat.util.TwitchChatLimitHelper.createBucket(Bandwidth)	in favor of BucketUtils
com.github.twitch4j.chat.util.TwitchChatLimitHelper.createBucket(Bandwidth...)	in favor of BucketUtils
com.github.twitch4j.chat.util.TwitchChatLimitHelper.createBucket(Iterable<Bandwidth>)	in favor of BucketUtils

Deprecated Constructors

Constructor	Description
com.github.twitch4j.chat.events.channel.ChannelStateEvent(EventChannel, ChannelStateEvent.ChannelState, Object)	unused by Twitch4J
com.github.twitch4j.chat.events.channel.DirectCheerEvent(IRCMessageEvent)	This experiment is no longer running.
com.github.twitch4j.chat.events.channel.IRCMessageEvent(String, Map<String, String>, Map<String, String>, Collection<String>)	Use MessageParser.parse(String, Map, Map, Collection) to create IRCMessageEvent instances

Deprecated Enum Constants

Enum Constant	Description
com.github.twitch4j.chat.enums.NoticeTag.BAD_BAN_GLOBAL_MOD
com.github.twitch4j.chat.enums.NoticeTag.BAD_TIMEOUT_GLOBAL_MOD
com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState.BROADCAST_LANG	has not been sent since 2019-03-08.
com.github.twitch4j.chat.events.channel.ChannelStateEvent.ChannelState.RITUALS	Twitch replaced this feature with the "user introduction" feature