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, MirrorableEvent

public final class GiftSubUpgradeEvent
extends AbstractChannelEvent
implements MirrorableEvent

Called when a user upgrades to a paid subscription from previously being gifted a subscription.

Constructor Summary

Constructors

Constructor	Description
GiftSubUpgradeEvent(IRCMessageEvent event, EventChannel channel, EventUser upgradingUser, String promoName, Integer promoGiftTotal, String gifterLogin, String gifterName)	Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getGifterLogin()	The login of the user who gifted the subscription, if applicable.
String	getGifterName()	The display name of the user who gifted the subscription, if applicable.
IRCMessageEvent	getMessageEvent()	Raw Message Event
Integer	getPromoGiftTotal()	The number of gifts the gifter has given during the promo indicated by getPromoName().
String	getPromoName()	The subscriptions promo, if any, that is ongoing; e.g.
EventUser	getUpgradingUser()	The user that is upgrading their subscription.
int	hashCode()
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

Methods inherited from interface com.github.twitch4j.chat.events.channel.MirrorableEvent

getSourceBadgeInfo, getSourceBadges, getSourceChannelId, getSourceMessageId, getSourceNoticeType, isMirrored

Constructor Details

GiftSubUpgradeEvent

@Internal
public GiftSubUpgradeEvent(IRCMessageEvent event,
 EventChannel channel,
 EventUser upgradingUser,
 String promoName,
 Integer promoGiftTotal,
 String gifterLogin,
 String gifterName)

Constructor

Parameters:

event - the raw message event

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

getMessageEvent

public IRCMessageEvent getMessageEvent()

Raw Message Event

Specified by:

getMessageEvent in interface MirrorableEvent

Returns:

the raw message event

getUpgradingUser

public EventUser getUpgradingUser()

The user that is upgrading their subscription.

getPromoName

public String getPromoName()

The subscriptions promo, if any, that is ongoing; e.g. Subtember 2018.

getPromoGiftTotal

public Integer getPromoGiftTotal()

The number of gifts the gifter has given during the promo indicated by getPromoName().

getGifterLogin

public String getGifterLogin()

The login of the user who gifted the subscription, if applicable.

getGifterName

public String getGifterName()

The display name of the user who gifted the subscription, if applicable.

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

toString

public String toString()

Overrides:

toString in class AbstractChannelEvent