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

Class GiftSubUpgradeEvent

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.GiftSubUpgradeEvent
All Implemented Interfaces:
com.github.philippheuer.events4j.api.domain.IEvent
public final class GiftSubUpgradeEvent
extends AbstractChannelEvent
Called when a user upgrades to a paid subscription from previously being gifted a subscription.

  • Constructor Summary

    Constructors
    Constructor Description
    GiftSubUpgradeEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser upgradingUser, java.lang.String promoName, java.lang.Integer promoGiftTotal, java.lang.String gifterLogin, java.lang.String gifterName)
    Constructor

  • Method Summary

    Modifier and Type Method Description
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.String getGifterLogin()
    The login of the user who gifted the subscription, if applicable.
    java.lang.String getGifterName()
    The display name of the user who gifted the subscription, if applicable.
    java.lang.Integer getPromoGiftTotal()
    The number of gifts the gifter has given during the promo indicated by getPromoName().
    java.lang.String getPromoName()
    The subscriptions promo, if any, that is ongoing; e.g.
    com.github.twitch4j.common.events.domain.EventUser getUpgradingUser()
    The user that is upgrading their subscription.
    int hashCode()  
    java.lang.String toString()  

    Methods inherited from class com.github.twitch4j.chat.events.AbstractChannelEvent

    ban, getChannel, timeout, unban

    Methods inherited from class com.github.twitch4j.chat.events.TwitchEvent

    getTwitchChat

    Methods inherited from class com.github.philippheuer.events4j.core.domain.Event

    getEventId, getFiredAt, getFiredAtInstant, getServiceMediator, setEventId, setFiredAt, setFiredAtInstant, setServiceMediator

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • GiftSubUpgradeEvent

      public GiftSubUpgradeEvent​(com.github.twitch4j.common.events.domain.EventChannel channel, com.github.twitch4j.common.events.domain.EventUser upgradingUser, java.lang.String promoName, java.lang.Integer promoGiftTotal, java.lang.String gifterLogin, java.lang.String gifterName)
      Constructor
      Parameters:
      channel - the channel where the event took place
      upgradingUser - the user that is upgrading their subscription
      promoName - the ongoing subscriptions promo, if applicable
      promoGiftTotal - the number of gifts the gifter has given during the promo
      gifterLogin - the login of the user who gifted the subscription, if applicable
      gifterName - the display name of the user who gifted the subscription, if applicable

  • Method Details

    • getUpgradingUser

      public com.github.twitch4j.common.events.domain.EventUser getUpgradingUser()
      The user that is upgrading their subscription.

    • getPromoName

      public java.lang.String getPromoName()
      The subscriptions promo, if any, that is ongoing; e.g. Subtember 2018.

    • getPromoGiftTotal

      public java.lang.Integer getPromoGiftTotal()
      The number of gifts the gifter has given during the promo indicated by getPromoName().

    • getGifterLogin

      public java.lang.String getGifterLogin()
      The login of the user who gifted the subscription, if applicable.

    • getGifterName

      public java.lang.String getGifterName()
      The display name of the user who gifted the subscription, if applicable.

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class AbstractChannelEvent

    • canEqual

      protected boolean canEqual​(java.lang.Object other)
      Overrides:
      canEqual in class AbstractChannelEvent

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class AbstractChannelEvent

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class AbstractChannelEvent