Package tv.phantombot.event.irc.message

Class IrcModerationEvent

java.lang.Object
tv.phantombot.event.Event
tv.phantombot.event.irc.IrcEvent
tv.phantombot.event.irc.message.IrcMessageEvent
tv.phantombot.event.irc.message.IrcModerationEvent
public class IrcModerationEvent extends IrcMessageEvent

  • Constructor Details

    • IrcModerationEvent

      public IrcModerationEvent(TwitchSession session, String sender, String message)
      Class constructor.
      Parameters:
      session -
      sender -
      message -

    • IrcModerationEvent

      public IrcModerationEvent(TwitchSession session, String sender, String message, Map<String,String> tags)
      Class constructor.
      Parameters:
      session -
      sender -
      message -
      tags -

    • IrcModerationEvent

      public IrcModerationEvent(TwitchSession session, String sender, String message, Map<String,String> tags, TMIMessage tmimsg)
      Class constructor.
      Parameters:
      session -
      sender -
      message -
      tags -

  • Method Details

    • mono

      public Mono<Boolean> mono()
      Returns a Mono which emits true if a moderation was performed and further processing of this message should be stopped
      Returns:

    • completedMono

      public Mono<Void> completedMono()
      Returns a Mono which emits the onComplete signal once all moderation hooks have run, reguardless of outcome
      Returns:

    • moderated

      public void moderated()
      Emits true from the mono, signaling that moderation has occurred and further processing of this message should be stopped

    • complete

      public void complete()
      Emits false from the mono, signaling that moderation has not occurred in any handlers and the message is safe to consume

    • action

      public IrcModerationEvent.ModerationAction action()
      Provides a IrcModerationEvent.ModerationAction that can be used to coordinate executing only the harshest recommended action returned by the various moderation functions

    • isCommand

      public boolean isCommand()
      Indicates if this message appears to be a command, defined as exclamation point ! followed by any character except for a space
      Returns:
      true if the message appears to be a command

    • tmimsg

      public TMIMessage tmimsg()
      Returns the raw TMIMessage
      Returns:
      The TMIMessage

    • asCommand

      public CommandEvent asCommand()
      Converts this message into a CommandEvent
      Returns:
      null if #isCommand(java.lang.String) returns false; otherwise a CommandEvent