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

Class PayForwardEvent

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

All Implemented Interfaces:

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

@Unofficial
public final class PayForwardEvent
extends AbstractChannelEvent
implements MirrorableEvent

Calls when a user pays forward a gift.

Constructor Summary

Constructors

Constructor	Description
PayForwardEvent(IRCMessageEvent event, EventChannel channel, EventUser user, EventUser priorGifter, EventUser recipient)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
IRCMessageEvent	getMessageEvent()	Raw Message Event
EventUser	getPriorGifter()	The previous user that gifted to this one, if not anonymous.
EventUser	getRecipient()	The user that is receiving this gift, if it is not for the community at-large.
EventUser	getUser()	The user that is paying forward their gift.
int	hashCode()
boolean	isCommunityPayForward()
String	toString()
boolean	wasPriorGifterAnonymous()

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

PayForwardEvent

@Internal
public PayForwardEvent(IRCMessageEvent event,
 EventChannel channel,
 EventUser user,
 EventUser priorGifter,
 EventUser recipient)

Event Constructor

Parameters:

event - The raw message event.

channel - The channel that this event originates from.

user - The user that is paying forward their gift.

priorGifter - The previous user that gifted to this one, if not anonymous.

recipient - The user that is receiving this gift, if it is not for the community at-large.

Method Details

wasPriorGifterAnonymous

public boolean wasPriorGifterAnonymous()

isCommunityPayForward

public boolean isCommunityPayForward()

getMessageEvent

public IRCMessageEvent getMessageEvent()

Raw Message Event

Specified by:

getMessageEvent in interface MirrorableEvent

Returns:

the raw message event

getUser

public EventUser getUser()

The user that is paying forward their gift.

getPriorGifter

public EventUser getPriorGifter()

The previous user that gifted to this one, if not anonymous.

getRecipient

public EventUser getRecipient()

The user that is receiving this gift, if it is not for the community at-large.

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