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

Class ExtendSubscriptionEvent

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

All Implemented Interfaces:

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

public final class ExtendSubscriptionEvent
extends AbstractChannelEvent

Called when a user extends their existing subscription into a future month.

See Also:

• Official Announcement

Constructor Summary

Constructors

Constructor	Description
ExtendSubscriptionEvent(EventChannel channel, EventUser user, SubscriptionPlan subPlan, int cumulativeMonths, Month benefitEndMonth)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Month	getBenefitEndMonth()	The new month that the subscription will end on.
int	getCumulativeMonths()	The total number of months the user has subscribed.
SubscriptionPlan	getSubPlan()	The type of subscription plan being used.
EventUser	getUser()	The user extending 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

Constructor Details

ExtendSubscriptionEvent

public ExtendSubscriptionEvent(EventChannel channel,
 EventUser user,
 SubscriptionPlan subPlan,
 int cumulativeMonths,
 Month benefitEndMonth)

Event Constructor

Parameters:

channel - The channel that this event originates from.

user - The user extending their subscription.

subPlan - The type of subscription plan being used.

cumulativeMonths - The total number of months the user has subscribed.

benefitEndMonth - The new month that the subscription will end on.

Method Details

getUser

public EventUser getUser()

The user extending their subscription.

getSubPlan

public SubscriptionPlan getSubPlan()

The type of subscription plan being used.

getCumulativeMonths

public int getCumulativeMonths()

The total number of months the user has subscribed.

getBenefitEndMonth

public Month getBenefitEndMonth()

The new month that the subscription will end on.

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