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

Class GiftedMultiMonthSubCourtesyEvent

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.GiftedMultiMonthSubCourtesyEvent
All Implemented Interfaces:
com.github.philippheuer.events4j.api.domain.IEvent, MirrorableEvent
@Unofficial public final class GiftedMultiMonthSubCourtesyEvent extends AbstractChannelEvent implements MirrorableEvent
This event occurs when a recipient of a multi-month gift sub enters a new month of the subscription, and shares a re-subscription message, despite no additional monetary transaction accompanying their message.

Webchat shows these events with this accompanying text: N month Gift Subscription courtesy of GIFTER_DISPLAY_NAME has entered month M.

The parameters specific to this event are not officially documented.

  • Constructor Details

    • GiftedMultiMonthSubCourtesyEvent

      public GiftedMultiMonthSubCourtesyEvent(IRCMessageEvent event)
      Event Constructor
      Parameters:
      event - the raw message event

  • Method Details

    • getMessageEvent

      public IRCMessageEvent getMessageEvent()
      Raw message event.
      Specified by:
      getMessageEvent in interface MirrorableEvent
      Returns:
      the raw message event

    • getUser

      public EventUser getUser()
      The gift recipient that is sending this resub message.

    • getMessage

      public String getMessage()
      The user-specified message attached to this notification.

    • getSubscriptionPlan

      public SubscriptionPlan getSubscriptionPlan()
      The tier of the multi-month gifted subscription.

    • isWasAnonymous

      public boolean isWasAnonymous()
      Whether the original multi-month gift was done by an anonymous user.

    • getGifter

      public EventUser getGifter()
      The user that originally gifted the multi-month gift subscription.

    • getGiftMonths

      public Integer getGiftMonths()
      The number of months that were originally gifted as part of the multi-month subscription.

    • getRedeemedMonth

      public Integer getRedeemedMonth()
      The gift month that is being redeemed.

    • getCumulativeMonths

      public Integer getCumulativeMonths()
      The cumulative number of months the user has been subscribed to this channel.

    • toString

      public String toString()
      Overrides:
      toString in class AbstractChannelEvent

    • 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