Package com.github.twitch4j.chat.events.channel

Class UserStateEvent

java.lang.Object
com.github.philippheuer.events4j.core.domain.Event
com.github.twitch4j.chat.events.TwitchEvent
com.github.twitch4j.chat.events.AbstractChannelEvent
com.github.twitch4j.chat.events.channel.UserStateEvent
All Implemented Interfaces:
com.github.philippheuer.events4j.api.domain.IEvent
public final class UserStateEvent extends AbstractChannelEvent
This event gets called when a user joins a channel or sends a PRIVMSG to a channel.

  • Constructor Details

    • UserStateEvent

      public UserStateEvent(IRCMessageEvent messageEvent)
      Event constructor
      Parameters:
      messageEvent - raw message event

  • Method Details

    • getColor

      public Optional<String> getColor()
      Returns:
      Hexadecimal RGB color code, or empty if it is never set

    • getDisplayName

      public Optional<String> getDisplayName()
      Returns:
      The user's display name, or empty if it is never set

    • isSubscriber

      public boolean isSubscriber()
      Returns:
      true if user is subscribed, false otherwise

    • getSubscriberMonth

      public OptionalInt getSubscriberMonth()
      Returns:
      number of months the user has been a subscriber, or empty if they are not subscribed

    • isBroadcaster

      public boolean isBroadcaster()
      Returns:
      true if user is broadcaster, false otherwise

    • isModerator

      public boolean isModerator()
      Returns:
      true if user is moderator, false otherwise

    • isStaff

      public boolean isStaff()
      Returns:
      true if user is staff, false otherwise

    • isPrimeOrTurbo

      public boolean isPrimeOrTurbo()
      Returns:
      true if user have prime or turbo badge, false otherwise

    • toString

      public String toString()
      Overrides:
      toString in class AbstractChannelEvent

    • getMessageEvent

      public IRCMessageEvent getMessageEvent()
      RAW Message Event

    • getEmoteSets

      public List<String> getEmoteSets()
      List of emote sets.

    • equals

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

    • canEqual

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractChannelEvent