Package tv.phantombot.event.irc.message

Class IrcModerationEvent.ModerationAction

java.lang.Object
tv.phantombot.event.irc.message.IrcModerationEvent.ModerationAction
Enclosing class:
IrcModerationEvent
public class IrcModerationEvent.ModerationAction extends Object
Determines the harshest action requested by a moderation script

  • Constructor Summary

    Constructors
    Constructor
    Description
    ModerationAction()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    IrcModerationEvent.ModerationActions.Actions
    action()
     
    void
    Ban()
    Attempts to set the current action to Actions.Ban
    void
    Ban(String reason, String warning)
    Attempts to set the current action to Actions.Ban
    void
    ClearChat()
    Attempts to set the current action to Actions.ClearChat
    void
    Delete()
    Attempts to set the current action to Actions.Delete
    void
    Delete(String warning)
    Attempts to set the current action to Actions.Delete
    void
    Purge()
    Attempts to set the current action to Actions.Timeout with a time of 1
    void
    Purge(String reason, String warning)
    Attempts to set the current action to Actions.Timeout with a time of 1
    String
    reason()
     
    int
    time()
     
    void
    Timeout()
    Attempts to set the current action to Actions.Timeout with a time of 600 (10 minutes)
    void
    Timeout(int seconds)
    Attempts to set the current action to Actions.Timeout
    void
    Timeout(int seconds, String reason, String warning)
    Attempts to set the current action to Actions.Timeout
    void
    UnBan()
    Attempts to set the current action to Actions.UnBan
    void
    UnTimeout()
    Attempts to set the current action to Actions.UnTimeout
    String
    warning()
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • ModerationAction

      public ModerationAction()

  • Method Details

    • action

      public IrcModerationEvent.ModerationActions.Actions action()
      Returns:
      The current harshest action

    • time

      public int time()
      Returns:
      If executing Actions.Timeout, the amount of time, in seconds

    • reason

      public String reason()
      Returns:
      The reason string for Actions.Timeout and Actions.Ban

    • warning

      public String warning()
      Returns:
      The warning message to send to chat

    • UnBan

      public void UnBan()
      Attempts to set the current action to Actions.UnBan

    • UnTimeout

      public void UnTimeout()
      Attempts to set the current action to Actions.UnTimeout

    • Delete

      public void Delete()
      Attempts to set the current action to Actions.Delete

    • Delete

      public void Delete(String warning)
      Attempts to set the current action to Actions.Delete
      Parameters:
      warning - A warning message to send to chat; null for no message

    • ClearChat

      public void ClearChat()
      Attempts to set the current action to Actions.ClearChat

    • Purge

      public void Purge()
      Attempts to set the current action to Actions.Timeout with a time of 1

    • Purge

      public void Purge(String reason, String warning)
      Attempts to set the current action to Actions.Timeout with a time of 1
      Parameters:
      reason - A reason message to attach to the Twitch logs; null for no message
      warning - A warning message to send to chat; null for no message

    • Timeout

      public void Timeout()
      Attempts to set the current action to Actions.Timeout with a time of 600 (10 minutes)

    • Timeout

      public void Timeout(int seconds)
      Attempts to set the current action to Actions.Timeout
      Parameters:
      seconds - The number of seconds to timeout the user for

    • Timeout

      public void Timeout(int seconds, String reason, String warning)
      Attempts to set the current action to Actions.Timeout
      Parameters:
      seconds - The number of seconds to timeout the user for
      reason - A reason message to attach to the Twitch logs; null for no message
      warning - A warning message to send to chat; null for no message

    • Ban

      public void Ban()
      Attempts to set the current action to Actions.Ban

    • Ban

      public void Ban(String reason, String warning)
      Attempts to set the current action to Actions.Ban
      Parameters:
      reason - A reason message to attach to the Twitch logs; null for no message
      warning - A warning message to send to chat; null for no message