Package com.github.twitch4j.eventsub.events

Class ChannelChatMessageEvent

java.lang.Object
com.github.twitch4j.eventsub.events.EventSubEvent
com.github.twitch4j.eventsub.events.EventSubChannelEvent
com.github.twitch4j.eventsub.events.ChannelChatUserEvent
com.github.twitch4j.eventsub.events.ChannelChatMessageEvent
public class ChannelChatMessageEvent extends ChannelChatUserEvent

  • Constructor Details

    • ChannelChatMessageEvent

      public ChannelChatMessageEvent()

  • Method Details

    • getMessageId

      public String getMessageId()
      A UUID that identifies the message.

    • getMessage

      public Message getMessage()
      The structured chat message.

    • getColor

      public String getColor()
      The color of the user’s name in the chat room. This is a hexadecimal RGB color code with a "#" prefix. This tag may be empty if it is never set.

    • getBadges

      public List<Badge> getBadges()
      The chatting user's visible badges.

    • getMessageType

      @NotNull public @NotNull MessageType getMessageType()
      The type of message.

    • getCheer

      @Nullable public @Nullable Cheer getCheer()
      Metadata if this message is a cheer.

    • getReply

      @Nullable public @Nullable Reply getReply()
      Metadata if this message is a reply.

    • getChannelPointsCustomRewardId

      @Nullable public @Nullable String getChannelPointsCustomRewardId()
      The ID of a channel points custom reward that was redeemed.

    • getChannelPointsAnimationId

      @Nullable public @Nullable String getChannelPointsAnimationId()
      An ID for the type of animation selected as part of a "Message Effects" redemption.
      See Also:

    • getSourceBroadcasterUserId

      @Nullable public @Nullable String getSourceBroadcasterUserId()
      The broadcaster user ID of the channel the message was sent from.

      Is null when the message 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 user name of the broadcaster of the channel the message was sent from.

      Is null when the message 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 login of the broadcaster of the channel the message was sent from.

      Is null when the message 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.

    • getSourceMessageId

      @Nullable public @Nullable String getSourceMessageId()
      The UUID that identifies the source message from the channel the message was sent from.

      Is null when the message 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.

    • getSourceBadges

      @Nullable public @Nullable List<Badge> getSourceBadges()
      The list of chat badges for the chatter in the channel the message was sent from.

      Is null when the message 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.

    • toString

      public String toString()
      Overrides:
      toString in class ChannelChatUserEvent

    • equals

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

    • canEqual

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

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class ChannelChatUserEvent