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

Class GiftSubscriptionsEvent

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

All Implemented Interfaces:

com.github.philippheuer.events4j.api.domain.IEvent, MirrorableEvent

public final class GiftSubscriptionsEvent
extends AbstractChannelEvent
implements MirrorableEvent

This event gets called when a user gifts x subscriptions to *random* users in chat.

This event will be called simultaneously with the chat announcement, not necessarily when the user presses the subscription button.

Constructor Summary

Constructors

Constructor	Description
GiftSubscriptionsEvent(IRCMessageEvent event, EventChannel channel, EventUser user, String subscriptionPlan, int count, int totalCount, String giftId)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
int	getCount()	X subscriptions gifted
String	getGiftId()	A unique identifier that links the community gift event to each individual recipient gifted event.
IRCMessageEvent	getMessageEvent()	Raw Message Event
String	getSubscriptionPlan()	Deprecated. in favor of getTier()
SubscriptionPlan	getTier()
int	getTotalCount()	X subscriptions gifted totally
EventUser	getUser()	Event Target User
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

GiftSubscriptionsEvent

@Internal
public GiftSubscriptionsEvent(IRCMessageEvent event,
 EventChannel channel,
 EventUser user,
 String subscriptionPlan,
 int count,
 int totalCount,
 String giftId)

Event Constructor

Parameters:

event - The raw message event

channel - The channel that this event originates from.

user - The user that gifted the subscriptions

subscriptionPlan - The subscription plan

count - The total amount of subs gifted

totalCount - The amount the user gifted in total (all time)

Method Details

getSubscriptionPlan

@Deprecated
@ScheduledForRemoval(inVersion="2.0.0")
public String getSubscriptionPlan()

Deprecated.

in favor of getTier()

Returns:

the raw subscription plan

getTier

public SubscriptionPlan getTier()

Returns:

the tier of the subscription that was gifted

getMessageEvent

public IRCMessageEvent getMessageEvent()

Raw Message Event

Specified by:

getMessageEvent in interface MirrorableEvent

Returns:

the raw message event

getUser

public EventUser getUser()

Event Target User

getCount

public int getCount()

X subscriptions gifted

getTotalCount

public int getTotalCount()

X subscriptions gifted totally

getGiftId

public String getGiftId()

A unique identifier that links the community gift event to each individual recipient gifted event.

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