Package com.github.twitch4j.eventsub.events

Class ChannelChatNotificationEvent

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.ChannelChatNotificationEvent
public class ChannelChatNotificationEvent extends ChannelChatUserEvent

  • Constructor Details

    • ChannelChatNotificationEvent

      public ChannelChatNotificationEvent()

  • Method Details

    • getPermissions

      @Nullable public @Nullable Set<CommandPermission> getPermissions()
      Returns:
      getBadges() as CommandPermission, if getBadges() is not null.

    • isChatterAnonymous

      public Boolean isChatterAnonymous()
      Whether the chatter is anonymous.

    • getColor

      public String getColor()
      The color of the user's name in the chat room.

    • getBadges

      public List<Badge> getBadges()
      The user's visible badges in the chat room.

    • getSystemMessage

      public String getSystemMessage()
      The message Twitch shows in the chat room for this notice.

    • getMessageId

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

    • getMessage

      public Message getMessage()
      The structured chat message.

    • getNoticeType

      public NoticeType getNoticeType()
      The type of notice.

    • 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.

    • getSub

      @Nullable public @Nullable Subscription getSub()
      Information about the sub event. Null if getNoticeType() is not NoticeType.SUB.

    • getSharedChatSub

      @Nullable public @Nullable Subscription getSharedChatSub()
      Information about the sub event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_SUB. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getResub

      @Nullable public @Nullable Resubscription getResub()
      Information about the resub event. Null if getNoticeType() is not NoticeType.RESUB.

    • getSharedChatResub

      @Nullable public @Nullable Resubscription getSharedChatResub()
      Information about the resub event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_RESUB. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getSubGift

      @Nullable public @Nullable SubGift getSubGift()
      Information about the gift sub event. Null if getNoticeType() is not NoticeType.SUB_GIFT.

    • getSharedChatSubGift

      @Nullable public @Nullable SubGift getSharedChatSubGift()
      Information about the gift sub event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_SUB_GIFT. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getCommunitySubGift

      @Nullable public @Nullable CommunitySubGift getCommunitySubGift()
      Information about the community gift sub event. Null if getNoticeType() is not NoticeType.COMMUNITY_SUB_GIFT.

    • getSharedChatCommunitySubGift

      @Nullable public @Nullable CommunitySubGift getSharedChatCommunitySubGift()
      Information about the community gift sub event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_COMMUNITY_SUB_GIFT. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getGiftPaidUpgrade

      @Nullable public @Nullable GiftPaidUpgrade getGiftPaidUpgrade()
      Information about the community gift paid upgrade event. Null if getNoticeType() is not NoticeType.GIFT_PAID_UPGRADE.

    • getSharedChatGiftPaidUpgrade

      @Nullable public @Nullable GiftPaidUpgrade getSharedChatGiftPaidUpgrade()
      Information about the community gift paid upgrade event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_GIFT_PAID_UPGRADE. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getPrimePaidUpgrade

      @Nullable public @Nullable PrimePaidUpgrade getPrimePaidUpgrade()
      Information about the Prime gift paid upgrade event. Null if getNoticeType() is not NoticeType.PRIME_PAID_UPGRADE.

    • getSharedChatPrimePaidUpgrade

      @Nullable public @Nullable PrimePaidUpgrade getSharedChatPrimePaidUpgrade()
      Information about the Prime gift paid upgrade event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_PRIME_PAID_UPGRADE. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getRaid

      @Nullable public @Nullable Raid getRaid()
      Information about the raid event. Null if getNoticeType() is not NoticeType.RAID.

    • getSharedChatRaid

      @Nullable public @Nullable Raid getSharedChatRaid()
      Information about the raid event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_RAID. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getUnraid

      @Nullable public @Nullable Unraid getUnraid()
      Information about the unraid event. Null if getNoticeType() is not NoticeType.UNRAID.

    • getPayItForward

      @Nullable public @Nullable GiftPayForward getPayItForward()
      Information about the pay it forward event. Null if getNoticeType() is not NoticeType.PAY_IT_FORWARD.

    • getSharedChatPayItForward

      @Nullable public @Nullable GiftPayForward getSharedChatPayItForward()
      Information about the pay it forward event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_PAY_IT_FORWARD. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getAnnouncement

      @Nullable public @Nullable Announcement getAnnouncement()
      Information about the announcement event. Null if getNoticeType() is not NoticeType.ANNOUNCEMENT.

    • getSharedChatAnnouncement

      @Nullable public @Nullable Announcement getSharedChatAnnouncement()
      Information about the announcement event. Null if getNoticeType() is not NoticeType.SHARED_CHAT_ANNOUNCEMENT. This field is for a notice that happened for a channel in a shared chat session other than the broadcaster in the subscription condition.

    • getCharityDonation

      @Nullable public @Nullable CharityDonation getCharityDonation()
      Information about the charity donation event. Null if getNoticeType() is not NoticeType.CHARITY_DONATION.

    • getBitsBadgeTier

      @Nullable public @Nullable BitsBadge getBitsBadgeTier()
      Information about the bits badge tier event. Null if getNoticeType() is not NoticeType.BITS_BADGE_TIER.

    • 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