Package com.github.twitch4j.chat.events

Class IRCEventHandler

java.lang.Object
com.github.twitch4j.chat.events.IRCEventHandler
@Internal public class IRCEventHandler extends Object
IRC Event Handler

Listens for any irc triggered events and created the corresponding events for the EventDispatcher.

  • Constructor Details

    • IRCEventHandler

      @Internal public IRCEventHandler(TwitchChat twitchChat)
      Constructor
      Parameters:
      twitchChat - The Twitch Chat instance

  • Method Details

    • onAnnouncement

      @Unofficial public boolean onAnnouncement(IRCMessageEvent event)

    • onChannelMessage

      public boolean onChannelMessage(IRCMessageEvent event)
      ChatChannel Message Event
      Parameters:
      event - IRCMessageEvent

    • onWhisper

      public boolean onWhisper(IRCMessageEvent event)
      Whisper Event
      Parameters:
      event - IRCMessageEvent

    • onBitsBadgeTier

      public boolean onBitsBadgeTier(IRCMessageEvent event)
      ChatChannel Bits Badge Earned Event Parser
      Parameters:
      event - the IRCMessageEvent to be checked

    • onChannelCheer

      public boolean onChannelCheer(IRCMessageEvent event)
      ChatChannel Cheer (Bits) Event
      Parameters:
      event - IRCMessageEvent

    • onDirectCheer

      @Unofficial @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onDirectCheer(IRCMessageEvent event)
      Deprecated.
      ChatChannel Direct Cheer (Currency) Event
      Parameters:
      event - IRCMessageEvent

    • onChannelSubscription

      public boolean onChannelSubscription(IRCMessageEvent event)
      ChatChannel Subscription Event
      Parameters:
      event - IRCMessageEvent

    • onGiftReceived

      @Unofficial public boolean onGiftReceived(IRCMessageEvent event)
      ChatChannel Prime Community Gift Event Parser: user receives a gift from a prime member
      Parameters:
      event - the IRCMessageEvent to be checked

    • onPayForward

      public boolean onPayForward(IRCMessageEvent event)
      ChatChannel Pay Forward Event Parser: user pays forward a gift they previously received
      Parameters:
      event - the IRCMessageEvent to be checked

    • onCharityDonation

      @Unofficial public boolean onCharityDonation(IRCMessageEvent event)

    • onRaid

      public boolean onRaid(IRCMessageEvent event)
      ChatChannel Raid Event (receiving)
      Parameters:
      event - IRCMessageEvent

    • onUnraid

      public boolean onUnraid(IRCMessageEvent event)
      ChatChannel Unraid Parser: raid cancellation
      Parameters:
      event - the IRCMessageEvent to be checked

    • onRewardGift

      public boolean onRewardGift(IRCMessageEvent event)
      ChatChannel Reward Gift Event Parser: monetary event triggered emotes to be shared
      Parameters:
      event - the IRCMessageEvent to be checked

    • onRitual

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onRitual(IRCMessageEvent event)
      Deprecated.
      no longer sent by twitch.
      ChatChannel Ritual Event Parser: celebration of a shared viewer milestone
      Parameters:
      event - the IRCMessageEvent to be checked
      See Also:

    • onClearChat

      public boolean onClearChat(IRCMessageEvent event)
      ChatChannel clearing chat, timeouting or banning user Event
      Parameters:
      event - IRCMessageEvent

    • onClearMsg

      public boolean onClearMsg(IRCMessageEvent event)
      A single message was deleted in a channel by a moderator
      Parameters:
      event - IRCMessageEvent
      See Also:

    • onNames

      public boolean onNames(IRCMessageEvent event)
      Names list is received upon initial channel join
      Parameters:
      event - IRCMessageEvent

    • onChannnelClientJoinEvent

      public boolean onChannnelClientJoinEvent(IRCMessageEvent event)
      User Joins ChatChannel Event
      Parameters:
      event - IRCMessageEvent

    • onChannnelClientLeaveEvent

      public boolean onChannnelClientLeaveEvent(IRCMessageEvent event)
      User Leaves ChatChannel Event
      Parameters:
      event - IRCMessageEvent

    • onChannelModChange

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public boolean onChannelModChange(IRCMessageEvent event)
      Deprecated.
      Mod Status Change Event
      Parameters:
      event - IRCMessageEvent

    • onNoticeEvent

      public boolean onNoticeEvent(IRCMessageEvent event)

    • onHostOnEvent

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onHostOnEvent(IRCMessageEvent event)
      Deprecated.

    • onHostOffEvent

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onHostOffEvent(IRCMessageEvent event)
      Deprecated.

    • onInboundHostEvent

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onInboundHostEvent(IRCMessageEvent event)
      Deprecated.

    • onListModsEvent

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onListModsEvent(IRCMessageEvent event)
      Deprecated.

    • onListVipsEvent

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onListVipsEvent(IRCMessageEvent event)
      Deprecated.

    • onChannelState

      public boolean onChannelState(IRCMessageEvent event)

    • onMessageDeleteResponse

      @Deprecated @ScheduledForRemoval(inVersion="1.17.0") public void onMessageDeleteResponse(IRCMessageEvent event)
      Deprecated.

    • onUserState

      public boolean onUserState(IRCMessageEvent event)

    • onGlobalUserState

      public boolean onGlobalUserState(IRCMessageEvent event)

    • getTwitchChat

      public TwitchChat getTwitchChat()
      Twitch Client

    • getEventManager

      public com.github.philippheuer.events4j.core.EventManager getEventManager()
      Event Manager