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

Class DirectCheerEvent

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

com.github.twitch4j.chat.events.channel.DirectCheerEvent

All Implemented Interfaces:

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

@Unofficial
public final class DirectCheerEvent
extends CheerEvent

This event gets called when a user does a direct cheer in an eligible channel for this experiment.

See Also:

• Twitch Information

Constructor Summary

Constructors

Constructor	Description
DirectCheerEvent(IRCMessageEvent event)	Event Constructor

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Integer	getAmount()
Integer	getBits()	Deprecated. direct cheer values are not easily translatable into bit amounts, especially for non-USD currencies.
DonationAmount	getCheer()	The parsed direct cheer payment information.
Currency	getCurrency()
BigDecimal	getMonetaryValue()
String	getSystemMessage()
int	hashCode()
String	toString()

Methods inherited from class com.github.twitch4j.chat.events.channel.CheerEvent

getFlags, getMessage, getMessageEvent, getSubscriberMonths, getSubscriptionTier, getUser

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

getChannel, reply

Constructor Details

DirectCheerEvent

public DirectCheerEvent(IRCMessageEvent event)

Event Constructor

Parameters:

event - The raw message event.

Method Details

getAmount

public Integer getAmount()

Returns:

the amount of this direct cheer, before the revenue split, and in arbitrary currency and decimal places.

getCurrency

public Currency getCurrency()

Returns:

the parsed currency used in this direct cheer, or throws if unknown.

getMonetaryValue

public BigDecimal getMonetaryValue()

Returns:

the parsed monetary value that was directly cheered. For example, $50 is parsed to 50

getSystemMessage

public String getSystemMessage()

Returns:

the twitch notification text for this event (which is distinct from the user's message attached to the cheer).

getBits

@Deprecated
public Integer getBits()

Deprecated.

direct cheer values are not easily translatable into bit amounts, especially for non-USD currencies.

Amount of Bits

Overrides:

getBits in class CheerEvent

getCheer

public DonationAmount getCheer()

The parsed direct cheer payment information.

toString

public String toString()

Overrides:

toString in class CheerEvent

equals

public boolean equals(Object o)

Overrides:

equals in class CheerEvent

canEqual

protected boolean canEqual(Object other)

Overrides:

canEqual in class CheerEvent

hashCode

public int hashCode()

Overrides:

hashCode in class CheerEvent