Package com.github.twitch4j.eventsub.events

Class ChannelModerateEvent

java.lang.Object
com.github.twitch4j.eventsub.events.EventSubEvent
com.github.twitch4j.eventsub.events.EventSubChannelEvent
com.github.twitch4j.eventsub.events.EventSubModeratorEvent
com.github.twitch4j.eventsub.events.ChannelModerateEvent
All Implemented Interfaces:
ModeratorEvent
public class ChannelModerateEvent extends EventSubModeratorEvent

  • Constructor Details

    • ChannelModerateEvent

      public ChannelModerateEvent()

  • Method Details

    • getSourceBroadcasterUserId

      @Nullable public @Nullable String getSourceBroadcasterUserId()
      The channel ID in which the action originally occurred. Is null when the moderator action happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.

    • getSourceBroadcasterUserLogin

      @Nullable public @Nullable String getSourceBroadcasterUserLogin()
      The channel login name in which the action originally occurred. Is null when the moderator action happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.

    • getSourceBroadcasterUserName

      @Nullable public @Nullable String getSourceBroadcasterUserName()
      The channel display name in which the action originally occurred. Is null when the moderator action happens in the same channel as the broadcaster. Is not null when in a shared chat session, and the action happens in the channel of a participant other than the broadcaster.

    • getAction

      @NotNull public @NotNull Action getAction()
      The action performed.

      Note that the following actions do not have any associated metadata: Action.CLEAR, Action.EMOTEONLY, Action.EMOTEONLYOFF, Action.FOLLOWERSOFF, Action.SLOWOFF, Action.SUBSCRIBERS, Action.SUBSCRIBERSOFF, Action.UNIQUECHAT, and Action.UNIQUECHATOFF.

    • getFollowers

      @Nullable public @Nullable FollowersMode getFollowers()
      Metadata associated with the followers command.

      This is only populated when getAction() is Action.FOLLOWERS.

    • getSlow

      @Nullable public @Nullable SlowMode getSlow()
      Metadata associated with the slow command.

      This is only populated when getAction() is Action.SLOW.

    • getVip

      @Nullable public @Nullable UserTarget getVip()
      Metadata associated with the vip command.

      This is only populated when getAction() is Action.VIP.

    • getUnvip

      @Nullable public @Nullable UserTarget getUnvip()
      Metadata associated with the unvip command.

      This is only populated when getAction() is Action.UNVIP.

    • getMod

      @Nullable public @Nullable UserTarget getMod()
      Metadata associated with the mod command.

      This is only populated when getAction() is Action.MOD.

    • getUnmod

      @Nullable public @Nullable UserTarget getUnmod()
      Metadata associated with the unmod command.

      This is only populated when getAction() is Action.UNMOD.

    • getBan

      @Nullable public @Nullable BanTarget getBan()
      Metadata associated with the ban command.

      This is only populated when getAction() is Action.BAN.

    • getSharedChatBan

      @Nullable public @Nullable BanTarget getSharedChatBan()
      Metadata associated with the ban command. This field is for an action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

      This is only populated when getAction() is Action.SHARED_CHAT_BAN.

    • getUnban

      @Nullable public @Nullable UserTarget getUnban()
      Metadata associated with the unban command.

      This is only populated when getAction() is Action.UNBAN.

    • getSharedChatUnban

      @Nullable public @Nullable UserTarget getSharedChatUnban()
      Metadata associated with the unban command. This field is for an action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

      This is only populated when getAction() is Action.SHARED_CHAT_UNBAN.

    • getTimeout

      @Nullable public @Nullable TimeoutTarget getTimeout()
      Metadata associated with the timeout command.

      This is only populated when getAction() is Action.TIMEOUT.

    • getSharedChatTimeout

      @Nullable public @Nullable TimeoutTarget getSharedChatTimeout()
      Metadata associated with the timeout command. This field is for an action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

      This is only populated when getAction() is Action.SHARED_CHAT_TIMEOUT.

    • getUntimeout

      @Nullable public @Nullable UserTarget getUntimeout()
      Metadata associated with the untimeout command.

      This is only populated when getAction() is Action.UNTIMEOUT.

    • getSharedChatUntimeout

      @Nullable public @Nullable UserTarget getSharedChatUntimeout()
      Metadata associated with the untimeout command. This field is for an action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

      This is only populated when getAction() is Action.SHARED_CHAT_UNTIMEOUT.

    • getRaid

      @Nullable public @Nullable RaidTarget getRaid()
      Metadata associated with the raid command.

      This is only populated when getAction() is Action.RAID.

    • getUnraid

      @Nullable public @Nullable UserTarget getUnraid()
      Metadata associated with the unraid command.

      This is only populated when getAction() is Action.UNRAID.

    • getDelete

      @Nullable public @Nullable DeleteTarget getDelete()
      Metadata associated with the delete command.

      This is only populated when getAction() is Action.DELETE.

    • getSharedChatDelete

      @Nullable public @Nullable DeleteTarget getSharedChatDelete()
      Metadata associated with the delete command. This field is for an action that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

      This is only populated when getAction() is Action.SHARED_CHAT_DELETE.

    • getAutomodTerms

      @Nullable public @Nullable AutomodTerms getAutomodTerms()
      Metadata associated with automod terms changes.

      This is only populated when getAction() is Action.ADD_BLOCKED_TERM or Action.ADD_PERMITTED_TERM or Action.DELETE_BLOCKED_TERM or Action.DELETE_PERMITTED_TERM.

    • getUnbanRequest

      @Nullable public @Nullable UnbanRequest getUnbanRequest()
      Metadata associated with actioning an unban request.

      This is only populated when getAction() is Action.APPROVE_UNBAN_REQUEST or Action.DENY_UNBAN_REQUEST.

    • getWarn

      @Nullable public @Nullable Warning getWarn()
      Metadata associated with the warn command.

      This is only populated when getAction() is Action.WARN.

    • toString

      public String toString()
      Overrides:
      toString in class EventSubModeratorEvent

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class EventSubModeratorEvent

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class EventSubModeratorEvent

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class EventSubModeratorEvent